minigui.h File Reference

Go to the source code of this file.

Defines

#define LEN_LAYER_NAME 14
The maximum length of name of layer in MiniGUI-Processes.
#define LEN_CLIENT_NAME 14
The maximum length of name of client in MiniGUI-Processes.
#define INV_LAYER_HANDLE 0
Invalid handle value of the layer.
#define MAX_NR_LISTEN_FD 5
The max number of listen fd which user can use.
#define NAME_SELF_LAYER ""
The name of the self layer.
#define NAME_TOPMOST_LAYER ""
The name of the topmost layer.
#define NAME_DEF_LAYER "mginit"
The default name of the layer.
#define NAME_SELF_LAYER ""
The name of the self layer.
#define LCO_NEW_CLIENT 1
Connecting a new client to the server.
#define LCO_DEL_CLIENT 2
Disconnecting a new client from the server.
#define LCO_NEW_LAYER 1
Creating a new layer.
#define LCO_DEL_LAYER 2
Deleting a new layer.
#define LCO_JOIN_CLIENT 3
Joining a client to the layer.
#define LCO_REMOVE_CLIENT 4
Removing a client from the layer.
#define LCO_TOPMOST_CHANGED 5
The topmost layer has changed, the layer will be the topmost one.
#define LCO_ACTIVE_CHANGED 6
The active client has changed, the client will be the active one.
#define ClientCanDrawNow() ClientCanDrawNowEx (TRUE, NULL)
Tells clients that they can output to screen now, and notify clients to repaint the whole desktop.
#define MAX_SYS_REQID 0x0011
Maximal system reserved request identifier.
#define MAX_REQID 0x0018
Maximal request identifier.
#define sock_write(fd, buff, count) sock_write_t(fd, buff, count, 0)
The blocking version of sock_write_t function.
#define sock_read(fd, buff, count) sock_read_t(fd, buff, count, 0)
The blocking version of sock_read_t function.
#define ReinitDesktop() ReinitDesktopEx (TRUE)
Re-initializes the desktop including the local system text.
#define MiniGUIMain
The main entry of a MiniGUI application.
#define IDM_DTI_FIRST (300)
The minimum interger value of command ID when user customize desktop menu.
#define ETC_MAXLINE 1024
The max line number of etc file.
#define ETC_FILENOTFOUND -1
No found etc file.
#define ETC_SECTIONNOTFOUND -2
No found section in etc file.
#define ETC_KEYNOTFOUND -3
No found key in etc file.
#define ETC_TMPFILEFAILED -4
Create tmpfile failed.
#define ETC_FILEIOFAILED -5
IO operation failed to etc file.
#define ETC_INTCONV -6
Convert the value string to an integer failed.
#define ETC_INVALIDOBJ -7
Invalid object to etc file.
#define ETC_READONLYOBJ -8
Read only to etc file.
#define ETC_OK 0
Operate success to etc file.
#define SetValueToEtc(hEtc, pSection, pKey, pValue) GetValueFromEtc(hEtc, pSection, pKey, pValue, -1)
Sets the value in the etc object.
#define LEN_CLIPBOARD_NAME 15
The maximum length of the name of clipboard.
#define NR_CLIPBOARDS 4
The maximum number of clipboard.
#define CBNAME_TEXT ("text")
The default clipboard name of text control.
#define CBERR_OK 0
Operate clipboard success.
#define CBERR_BADNAME 1
Bad name to clipboard.
#define CBERR_NOMEM 2
No enough memory to clipboard.
#define CBOP_NORMAL 0
Overwrite operation to clipboard.
#define CBOP_APPEND 1
Append the new data to clipboarda after the old data.
#define Beep Ping
Alias of Ping.
#define IDC_ARROW 0
#define IDC_IBEAM 1
#define IDC_PENCIL 2
#define IDC_CROSS 3
#define IDC_MOVE 4
#define IDC_SIZENWSE 5
#define IDC_SIZENESW 6
#define IDC_SIZEWE 7
#define IDC_SIZENS 8
#define IDC_UPARROW 9
#define IDC_NONE 10
#define IDC_HELP 11
#define IDC_BUSY 12
#define IDC_WAIT 13
#define IDC_RARROW 14
#define IDC_COLOMN 15
#define IDC_ROW 16
#define IDC_DRAG 17
#define IDC_NODROP 18
#define IDC_HAND_POINT 19
#define IDC_HAND_SELECT 20
#define IDC_SPLIT_HORZ 21
#define IDC_SPLIT_VERT 22
#define SetCursor(hcsr) SetCursorEx (hcsr, FALSE)
Changes the current cursor.
#define SetDefaultCursor(hcsr) SetCursorEx (hcsr, TRUE)
Changes the current cursor, and set it as the default cursor.

Typedefs

typedef _MG_Client MG_Client
typedef _MG_Layer MG_Layer
typedef void(* ON_NEW_DEL_CLIENT )(int op, int cli)
Client event callback.
typedef void(* ON_CHANGE_LAYER )(int op, MG_Layer *layer, MG_Client *client)
Layer event callback.
typedef _REQUEST REQUEST
typedef REQUEST * PREQUEST
typedef int(* REQ_HANDLER )(int cli, int clifd, void *buff, size_t len)
Request handler.
typedef _ETCSECTION ETCSECTION
typedef ETCSECTION * PETCSECTION
typedef _ETC_S ETC_S

Functions

MG_EXPORT int GUIAPI InitGUI (int, const char **)
Initialize MiniGUI.
MG_EXPORT void GUIAPI TerminateGUI (int rcByGUI)
Terminate MiniGUI.
MG_EXPORT void GUIAPI MiniGUIPanic (int exitcode)
The panic of MiniGUI application.
MG_EXPORT BOOL GUIAPI RegisterListenFD (int fd, int type, HWND hwnd, void *context)
Registers a listening file descriptor to MiniGUI-Lite.
MG_EXPORT BOOL GUIAPI UnregisterListenFD (int fd)
Unregisters a being listened file descriptor.
MG_EXPORT GHANDLE GUIAPI JoinLayer (const char *layer_name, const char *client_name, int lx, int ty, int rx, int by)
Joins to a layer.
MG_EXPORT void GUIAPI GetDesktopRect (int *lx, int *ty, int *rx, int *by)
Gets the desktop rectangle.
MG_EXPORT GHANDLE GUIAPI GetLayerInfo (const char *layer_name, RECT *max_rect, int *nr_clients, BOOL *is_topmost, int *cli_active)
Gets information of a layer.
MG_EXPORT BOOL GUIAPI BringLayer2Topmost (GHANDLE handle)
Brings a layer to be the topmost one.
MG_EXPORT BOOL GUIAPI SetActiveClient (int active)
Sets a client as the ative one.
static BOOL SetClientScreen (int lx, int ty, int rx, int by)
Sets the screen rectangle can be used by clients.
MG_EXPORT BOOL GUIAPI OnlyMeCanDraw (void)
Tells clients do not draw anything on screen.
MG_EXPORT BOOL GUIAPI ClientCanDrawNowEx (BOOL bRepaint, const RECT *invrc)
Tells clients that they can output to screen now.
MG_EXPORT void GUIAPI UpdateTopmostLayer (const RECT *dirty_rc)
Tells the clients in the topmost layer to update their windows.
MG_EXPORT BOOL GUIAPI SetTopMostClient (int cli)
Sets topmost layer by a client identifier.
MG_EXPORT BOOL GUIAPI SetTopMostLayer (MG_Layer *layer)
Sets topmost layer.
MG_EXPORT int GUIAPI GetClientByPID (int pid)
Returns the client identifier from the process identifier (PID) of a client.
int ClientRequest (PREQUEST request, void *result, int len_rslt)
Sends a request to the server and wait reply.
int get_sock_fd2srv (void)
Gets the file descriptor of the socket connected to the server.
int GUIAPI ServerSendReply (int clifd, const void *reply, int len)
Sends the reply to the client.
MG_EXPORT BOOL GUIAPI RegisterRequestHandler (int req_id, REQ_HANDLER your_handler)
Registers a customize request handler.
MG_EXPORT REQ_HANDLER GUIAPI GetRequestHandler (int req_id)
Gets the request handler by request identifier.
int serv_listen (const char *name)
Creates a listen socket.
int serv_accept (int listenfd, pid_t *pidptr, uid_t *uidptr)
Waits for a client connection to arrive, and accept it.
int cli_conn (const char *name, char project)
Used by clients to connect to a server.
int sock_write_t (int fd, const void *buff, int count, unsigned int timeout)
Writes data to socket.
int sock_read_t (int fd, void *buff, int count, unsigned int timeout)
Reads data from socket.
MG_EXPORT BOOL GUIAPI ReinitDesktopEx (BOOL init_sys_text)
Re-initializes the desktop.
MG_EXPORT void GUIAPI ExitGUISafely (int exitcode)
Exits your MiniGUI application safely.
MG_EXPORT BOOL GUIAPI SetMouseCalibrationParameters (const POINT *src_pts, const POINT *dst_pts)
Sets the parameters for doing mouse calibration.
MG_EXPORT HWND GUIAPI OpenAboutDialog (HWND hHosting)
Opens or actives the 'About MiniGUI' dialog.
MG_EXPORT int GUIAPI GetValueFromEtcFile (const char *pEtcFile, const char *pSection, const char *pKey, char *pValue, int iLen)
Gets value from a configuration file.
MG_EXPORT int GUIAPI GetIntValueFromEtcFile (const char *pEtcFile, const char *pSection, const char *pKey, int *value)
Gets integer value from a configuration file.
MG_EXPORT int GUIAPI SetValueToEtcFile (const char *pEtcFile, const char *pSection, const char *pKey, char *pValue)
Sets a value in a configuration file.
MG_EXPORT int GUIAPI SaveSectionToEtcFile (const char *pEtcFile, PETCSECTION psect)
Sets a section value in a configuration file.
MG_EXPORT int GUIAPI RemoveSectionInEtcFile (const char *pEtcFile, const char *pSection)
Removes a section in an etc file.
MG_EXPORT GHANDLE GUIAPI LoadEtcFile (const char *pEtcFile)
Loads an etc file into memory.
MG_EXPORT int GUIAPI SaveEtcToFile (GHANDLE hEtc, const char *file_name)
Saves an ETC object into a file.
MG_EXPORT int GUIAPI UnloadEtcFile (GHANDLE hEtc)
Unloads an etc file.
MG_EXPORT int GUIAPI GetValueFromEtc (GHANDLE hEtc, const char *pSection, const char *pKey, char *pValue, int iLen)
Gets value from a configuration etc object.
MG_EXPORT int GUIAPI GetIntValueFromEtc (GHANDLE hEtc, const char *pSection, const char *pKey, int *pValue)
Gets the integer value from a configuration etc object.
MG_EXPORT GHANDLE GUIAPI FindSectionInEtc (GHANDLE hEtc, const char *pSection, BOOL bCreateNew)
Finds/Creates a section from an etc object.
MG_EXPORT int GUIAPI GetValueFromEtcSec (GHANDLE hSect, const char *pKey, char *pValue, int iLen)
Gets value from an etc section object.
MG_EXPORT int GUIAPI GetIntValueFromEtcSec (GHANDLE hSect, const char *pKey, int *pValue)
Gets an integer value from an etc section object.
MG_EXPORT int GUIAPI SetValueToEtcSec (GHANDLE hSect, const char *pKey, char *pValue)
Sets the value in the etc section object.
MG_EXPORT int GUIAPI RemoveSectionInEtc (GHANDLE hEtc, const char *pSection)
Removes a section in etc object.
static int GetMgEtcValue (const char *pSection, const char *pKey, char *pValue, int iLen)
Gets value from MiniGUI configuration etc object.
static int GetMgEtcIntValue (const char *pSection, const char *pKey, int *value)
Gets integer value from MiniGUI configuration etc object.
MG_EXPORT int GUIAPI CreateClipBoard (const char *cb_name, size_t size)
Creates a new clipboard.
MG_EXPORT int GUIAPI DestroyClipBoard (const char *cb_name)
Destroys a new clipboard.
MG_EXPORT int GUIAPI SetClipBoardData (const char *cb_name, void *data, size_t n, int cbop)
Sets the data of a clipboard.
MG_EXPORT size_t GUIAPI GetClipBoardDataLen (const char *cb_name)
Gets the length of the data of a clipboard.
MG_EXPORT size_t GUIAPI GetClipBoardData (const char *cb_name, void *data, size_t n)
Gets the data of a clipboard.
MG_EXPORT int GUIAPI GetClipBoardByte (const char *cb_name, int index, unsigned char *byte)
Gets a byte from a clipboard.
MG_EXPORT void GUIAPI Ping (void)
Makes a beep sound.
MG_EXPORT void GUIAPI Tone (int frequency_hz, int duration_ms)
Makes a tone.
MG_EXPORT void *GUIAPI GetOriginalTermIO (void)
Gets termios structure of the original terminal before initializing MiniGUI.
MG_EXPORT char *GUIAPI FixStrAlloc (int len)
Allocates a buffer for a length-fixed string.
MG_EXPORT char *GUIAPI FixStrDup (const char *str)
Duplicates a length-fixed string.
MG_EXPORT void GUIAPI FreeFixStr (char *str)
Frees a length-fixed string.
HCURSOR GUIAPI LoadCursorFromFile (const char *filename)
Loads a cursor from a M$ Windows cursor file.
HCURSOR GUIAPI LoadCursorFromMem (const void *area)
Loads a cursor from a memory area.
HCURSOR GUIAPI CreateCursor (int xhotspot, int yhotspot, int w, int h, const BYTE *pANDBits, const BYTE *pXORBits, int colornum)
Creates a cursor from memory data.
BOOL GUIAPI DestroyCursor (HCURSOR hcsr)
Destroys a cursor object.
MG_EXPORT HCURSOR GUIAPI GetSystemCursor (int csrid)
Gets the handle to a system cursor by its identifier.
MG_EXPORT HCURSOR GUIAPI GetCurrentCursor (void)
Gets the handle to the current cursor.
MG_EXPORT void GUIAPI ClipCursor (const RECT *prc)
Clips the cursor range.
MG_EXPORT void GUIAPI GetClipCursor (RECT *prc)
Gets the current cursor clipping rectangle.
MG_EXPORT void GUIAPI GetCursorPos (POINT *ppt)
Gets position of the current cursor.
MG_EXPORT void GUIAPI SetCursorPos (int x, int y)
Sets position of the current cursor.
MG_EXPORT HCURSOR GUIAPI SetCursorEx (HCURSOR hcsr, BOOL set_def)
Changes the current cursor.
MG_EXPORT HCURSOR GUIAPI GetDefaultCursor (void)
Gets the default cursor.
MG_EXPORT int GUIAPI ShowCursor (BOOL fShow)
Shows or hides cursor.
MG_EXPORT BOOL GUIAPI GetKeyStatus (UINT uKey)
Gets a key or a mouse button status.
MG_EXPORT DWORD GUIAPI GetShiftKeyStatus (void)
Gets status of the shift keys.
MG_EXPORT const char * GetSysText (const char *text)
Translates system text to localized text.
MG_EXPORT char * strnchr (const char *s, size_t n, int c)
Locates character in the first n characters of string s.
MG_EXPORT int substrlen (const char *text, int len, char delimiter, int *nr_delim)
Locates a substring delimited by one or more delimiters in the first len characters of string text.
MG_EXPORT char * strtrimall (char *src)
Deletes all space characters.

Variables

MG_EXPORT RECT g_rcScr
Contains the rectangle of the whole screen.
MG_EXPORT RECT g_rcDesktop
Contains the rectangle of desktop of the application.
MG_EXPORT BOOL mgIsServer
Indicates whether the process is the server or a client on MiniGUI-Lite.
MG_EXPORT void * mgSharedRes
Contains the pointer to the shared resource of MiniGUI-Lite.
MG_EXPORT size_t mgSizeRes
Contains the length of shared resource of MiniGUI-Lite.
MG_EXPORT int mgClientSize
The current size of the array mgClients.
MG_EXPORT MG_Client * mgClients
The pointer to the array contains all clients' information.
MG_EXPORT MG_Layer * mgTopmostLayer
The pointer to the topmost layer.
MG_EXPORT MG_Layer * mgLayers
The pointer to the list of layers.
MG_EXPORT ON_NEW_DEL_CLIENT OnNewDelClient
Sets to a function to handle a comming in/going away connection of client.
MG_EXPORT ON_CHANGE_LAYER OnChangeLayer
Sets to a function to handle events of layers.
MG_EXPORT char ETCFILEPATH []
The path name of MiniGUI configuration file.
MG_EXPORT const char * SysText []
Contains all text used by MiniGUI in English.
MG_EXPORT const char ** local_SysText
The pointer to the current localized system text array.

Detailed Description

Author:: Wei Yongming <ymwei@minigui.org>

Date:: 2002/01/06

This file includes global and miscellaneous interfaces of MiniGUI.

    Copyright (C) 2002-2006 Feynman Software.
    Copyright (C) 1998-2002 Wei Yongming.

    All rights reserved by Feynman Software.

    This file is part of MiniGUI, a compact cross-platform Graphics 
    User Interface (GUI) support system for real-time embedded systems.

Definition in file minigui.h.

Function Documentation

int GUIAPI InitGUI ( int ,

const char **

)

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

void GUIAPI MiniGUIPanic ( int exitcode )

The panic of MiniGUI application.
The function forces to close GAL and IAL engine.

Parameters:

exitcode The value of exitcode, now it can be any values.

void GUIAPI TerminateGUI ( int rcByGUI )

Terminate MiniGUI.

Parameters:

rcByGUI The flags whether close desktop thread or not.

Generated on Mon Jun 26 13:54:27 2006 for MiniGUI V1.6.9 API Reference by

1.4.2