MiniGUI API Reference (MiniGUI-Processes)  v5.0.6
A mature and proven cross-platform GUI system for embedded and smart IoT devices
Data Structures | Macros | Typedefs | Functions | Variables
MiniGUI-Processes specific variables

Data Structures

struct  _MG_Client
 
struct  _MG_Layer
 

Macros

#define mgIsServer   (IsServer())
 Indicates whether the current process is the server or a client on MiniGUI-Processes. More...
 
#define LEN_LAYER_NAME   15
 The maximum length of name of layer in MiniGUI-Processes. More...
 
#define LEN_CLIENT_NAME   15
 The maximum length of name of client in MiniGUI-Processes. More...
 
#define INV_LAYER_HANDLE   0
 Invalid handle value of the layer. More...
 

Typedefs

typedef struct _MG_Client MG_Client
 
typedef struct _MG_Layer MG_Layer
 

Functions

MG_EXPORT BOOL GUIAPI IsServer (void)
 Check whether the current process is the server of MiniGUI-Processes. More...
 

Variables

MG_EXPORT void * mgSharedRes
 Contains the pointer to the shared resource of MiniGUI-Processes. More...
 
MG_EXPORT size_t mgSizeRes
 Contains the length of shared resource of MiniGUI-Processes. More...
 
MG_EXPORT int mgClientSize
 The current size of the array mgClients. More...
 
MG_EXPORT MG_ClientmgClients
 The pointer to the array contains all clients' information. More...
 
MG_EXPORT MG_LayermgTopmostLayer
 The pointer to the topmost layer. More...
 
MG_EXPORT MG_LayermgDefaultLayer
 The pointer to the default layer. More...
 
MG_EXPORT MG_LayermgLayers
 The pointer to the layer list. More...
 

Detailed Description

Macro Definition Documentation

◆ INV_LAYER_HANDLE

#define INV_LAYER_HANDLE   0

Invalid handle value of the layer.

Definition at line 271 of file minigui.h.

◆ LEN_CLIENT_NAME

#define LEN_CLIENT_NAME   15

The maximum length of name of client in MiniGUI-Processes.

Definition at line 265 of file minigui.h.

◆ LEN_LAYER_NAME

#define LEN_LAYER_NAME   15

The maximum length of name of layer in MiniGUI-Processes.

Definition at line 259 of file minigui.h.

◆ mgIsServer

#define mgIsServer   (IsServer())

Indicates whether the current process is the server or a client on MiniGUI-Processes.

Note
Only defined for MiniGUI-Processes.
Since 5.0.0, mgIsServer is defined as a macro to call IsServer.

Definition at line 232 of file minigui.h.

Typedef Documentation

◆ MG_Client

typedef struct _MG_Client MG_Client

Client information.

◆ MG_Layer

typedef struct _MG_Layer MG_Layer

Layer information.

Function Documentation

◆ IsServer()

BOOL GUIAPI IsServer ( void  )

Check whether the current process is the server of MiniGUI-Processes.

Returns
TRUE if the current process is the server, and FALSE for any client.
Note
Only available on MiniGUI-Processes.
See also
mgIsServer

Since 5.0.0

Variable Documentation

◆ mgClients

MG_Client * mgClients

The pointer to the array contains all clients' information.

You can access the elements in mgClients as a normal array. If the field fd of one element is not less than zero, then the element will be a vaild client.

See also
MG_Client

◆ mgClientSize

int mgClientSize

The current size of the array mgClients.

See also
mgClients

◆ mgDefaultLayer

MG_Layer * mgDefaultLayer

The pointer to the default layer.

See also
MG_Layer

◆ mgLayers

MG_Layer * mgLayers

The pointer to the layer list.

See also
MG_Layer

◆ mgSharedRes

void * mgSharedRes

Contains the pointer to the shared resource of MiniGUI-Processes.

Note
Not defined for MiniGUI-Threads, and the shared resource is read-only for all clients.
See also
mgSizeRes

◆ mgSizeRes

void * mgSizeRes

Contains the length of shared resource of MiniGUI-Processes.

Note
Only defined for MiniGUI-Processes.
See also
mgSharedRes

◆ mgTopmostLayer

MG_Layer * mgTopmostLayer

The pointer to the topmost layer.

See also
MG_Layer