MiniGUI API Reference (MiniGUI-Threads)  v5.0.6
A mature and proven cross-platform GUI system for embedded and smart IoT devices
Modules | Macros | Functions
Global/general functions

Modules

 General read/write operations
 MiniGUI's general read/write operation provides a general interface to read from and write to various data source, such as files, memory, and so on.
 
 Endian specific read/write interfaces
 The endian specific read/write functions read and write data of the specified endianness, dynamically translating to the host machine endianness.
 
 Fixed point math functions
 You know that the float point mathematics routines are very expensive. If you do not want precision mathematics result, you can use fixed point. MiniGUI uses a double word (32-bit) integer to represent a fixed point ranged from -32767.0 to 32767.0, and defines some fixed point mathematics routines for your application. Some GDI functions need fixed point math routines, like Arc.
 
 Block data heap operations
 MiniGUI maintains some private block data heaps to allocate data blocks which have fixed size, such as the clipping rectangles in a region. By using the private heap, we can avoiding calling malloc and free function frequently, so will have a slight performance enhancement.
 
 Initialization and termination functions
 Normally, the only entry of any MiniGUI application is MiniGUIMain. The application will terminate when you call exit(3) or just return from MiniGUIMain.
 
 Mouse calibration.
 
 About MiniGUI dialog
 
 Configuration file operations
 The configuration file used by MiniGUI have a similiar format as M$ Windows INI file, i.e. the file consists of sections, and the section consists of key-value pairs, like this:
 
 Length-Fixed string operations
 MiniGUI maintains a private heap for length-fixed strings, and allocates length-fixed strings from this heap for window caption, menu item text, and so on. You can also use this private heap to allocate length-fixed strings.
 
 Cursor operations
 
 Asynchronous key status functions
 
 Internationlization of system text
 
 String operation helpers
 
 Slice Memory Allocator
 An efficient way to allocate groups of equal-sized chunks of memory.
 
 Miscellaneous functions
 
 ClipBoard Operations
 

Macros

#define NAME_SELF_LAYER   ""
 The name of the self layer. More...
 
#define NAME_TOPMOST_LAYER   ""
 The name of the topmost layer. More...
 
#define NAME_DEF_LAYER   "mginit"
 The default name of the layer. More...
 

Functions

MG_EXPORT int GUIAPI InitGUI (int argc, const char *argv[])
 Initialize MiniGUI. More...
 
MG_EXPORT void GUIAPI TerminateGUI (int not_used)
 Terminate MiniGUI. More...
 
MG_EXPORT void GUIAPI MiniGUIPanic (int exitcode)
 The panic of MiniGUI application. More...
 

Detailed Description

Macro Definition Documentation

◆ NAME_DEF_LAYER

#define NAME_DEF_LAYER   "mginit"

The default name of the layer.

Definition at line 437 of file minigui.h.

◆ NAME_SELF_LAYER

#define NAME_SELF_LAYER   ""

The name of the self layer.

Definition at line 425 of file minigui.h.

◆ NAME_TOPMOST_LAYER

#define NAME_TOPMOST_LAYER   ""

The name of the topmost layer.

Definition at line 431 of file minigui.h.

Function Documentation

◆ InitGUI()

int GUIAPI InitGUI ( int  argc,
const char *  argv[] 
)

Initialize MiniGUI.

The meaning of two parameters is same with parameters of main function.

◆ MiniGUIPanic()

void GUIAPI MiniGUIPanic ( int  exitcode)

The panic of MiniGUI application.

The function forces to close GAL and IAL engine.

Parameters
exitcodeThe value of exitcode, now it can be any values.

◆ TerminateGUI()

void GUIAPI TerminateGUI ( int  not_used)

Terminate MiniGUI.

Parameters
not_usednot used