Mirrors_UI_SDK/MiniGUI
1
0
Fork 0
mirror of https://github.com/VincentWei/MiniGUI.git synced 2026-02-06 02:01:50 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

tune description words

Browse Source
This commit is contained in:
Vincent Wei
2020-02-20 16:05:57 +08:00
parent afed837806
commit 96005abb1a
2 changed files with 33 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
include/minigui.h
View File

@@ -439,7 +439,7 @@ MG_EXPORT void GUIAPI MiniGUIPanic (int exitcode);
/**
* \fn GHANDLE GUIAPI JoinLayer (const char* layer_name,
const char* client_name,
int max_nr_topmosts, int max_nr_normals)
int max_nr_highers, int max_nr_normals)
* \brief Joins to a layer.
*
* This function should be called by clients before calling any other MiniGUI
@@ -449,19 +449,19 @@ MG_EXPORT void GUIAPI MiniGUIPanic (int exitcode);
* \a layer_name, the client will join to the default layer.
*
* If the client want to create a new layer, you should specify the maximal
* number of topmost frame objects (max_nr_topmosts) and the maximal number of
* normal frame objects (max_nr_normals) in the new layer. Passing zero to
* \a max_nr_topmosts and max_nr_normals will use the default values, and
* the default values are specified by ServerStartup.
* number of z-nodes in the higher level (max_nr_highers) and the maximal
* number of z-nodes in the normal level (max_nr_normals) of the new layer.
* Passing zero to \a max_nr_highers and max_nr_normals will use the default
* values, and the default values are specified by ServerStartup.
*
* Note that the server will create a default layer named "mginit".
*
* \param layer_name The name of the layer. You can use NAME_TOPMOST_LAYER to
* specify the current topmost layer.
* \param client_name The name of the client.
* \param max_nr_topmosts The maximal number of topmost z-order nodes in
* \param max_nr_highers The maximal number of z-nodes in the higher level of
* the new layer.
* \param max_nr_normals The maximal number of normal z-order nodes in
* \param max_nr_normals The maximal number of z-nodes in the normal level of
* the new layer.
*
* \return The handle to the layer on success, INV_LAYER_HANDLE on error.
@@ -472,7 +472,7 @@ MG_EXPORT void GUIAPI MiniGUIPanic (int exitcode);
*/
MG_EXPORT GHANDLE GUIAPI JoinLayer (const char* layer_name,
const char* client_name,
int max_nr_topmosts, int max_nr_normals);
int max_nr_highers, int max_nr_normals);
/**
* \fn GHANDLE GUIAPI GetLayerInfo (const char* layer_name,
@@ -793,7 +793,7 @@ extern MG_EXPORT ON_ZNODE_OPERATION OnZNodeOperation;
/**
* \fn BOOL GUIAPI ServerStartup (int nr_globals,
int def_nr_topmosts, int def_nr_normals)
int def_nr_highers, int def_nr_normals)
* \brief Initializes the server of MiniGUI-Processes.
*
* This function initializes the server, i.e. \a mginit. It creates the
@@ -804,32 +804,32 @@ extern MG_EXPORT ON_ZNODE_OPERATION OnZNodeOperation;
* Note that the default layer created by the server called
* "mginit" (NAME_DEF_LAYER).
*
* \param nr_globals The number of the global z-order nodes. All z-order nodes
* created by mginit are global ones.
* \param def_nr_topmosts The maximal number of the topmost z-order nodes in
* the default layer. It is also the default number of topmost
* z-order nodes of a new layer.
* \param def_nr_normals The maximal number of normal global z-order nodes in
* the new layer. It is also the default number of normal
* z-order nodes of a new layer.
* \param nr_globals The number of the z-nodes in the global level.
* All z-nodes created by `mginit` are global ones.
* \param def_nr_highers The maximal number of the z-nodes in the higher
* level of the default layer. It is also the default number of
* the z-nodes in the higher level of a new layer.
* \param def_nr_normals The maximal number of the z-nodes in the normal
* level of the default layer. It is also the default number of
* the z-nodes in the normal level of a new layer.
*
* \return TRUE on success, otherwise FALSE.
*
* \note Server-only function, i.e. \em only can be called by \a mginit.
*/
MG_EXPORT BOOL GUIAPI ServerStartup (int nr_globals,
int def_nr_topmosts, int def_nr_normals);
int def_nr_highers, int def_nr_normals);
/**
* \fn MG_Layer* GUIAPI ServerCreateLayer (const char* layer_name,
int max_nr_topmosts, int max_nr_normals)
int max_nr_highers, int max_nr_normals)
* \brief Create a new layer from the server.
*
* This function creates a new layer named by \a layer_name.
* You should specify the maximal number of topmost frame
* objects (max_nr_topmosts) and the maximal number of normal frame
* objects (max_nr_normals) in the new layer. Passing zero to
* max_nr_topmosts and max_nr_normals will use the default values,
* You should specify the maximal number of z-nodes in the higher level
* (max_nr_highers) and the maximal number of z-nodes in the normal level
* (max_nr_normals) of the new layer. Passing zero to
* max_nr_highers and max_nr_normals will use the default values,
* and the default values are specified by ServerStartup.
*
* Note that the server will create a default layer named "mginit".
@@ -837,9 +837,9 @@ MG_EXPORT BOOL GUIAPI ServerStartup (int nr_globals,
* \param layer_name The name of the layer. If there is already a layer
* named \a layer_name, the function will return the pointer to
* that layer.
* \param max_nr_topmosts The maximal number of topmost z-order nodes in
* \param max_nr_highers The maximal number of z-nodes in the higher level of
* the new layer.
* \param max_nr_normals The maximal number of normal z-order nodes in
* \param max_nr_normals The maximal number of z-nodes in the normal level of
* the new layer.
*
* \return The handle to the layer on success, NULL on error.
@@ -849,7 +849,7 @@ MG_EXPORT BOOL GUIAPI ServerStartup (int nr_globals,
* \sa ServerDeleteLayer, ServerStartup
*/
MG_EXPORT MG_Layer* GUIAPI ServerCreateLayer (const char* layer_name,
int max_nr_topmosts, int max_nr_normals);
int max_nr_highers, int max_nr_normals);
/**
* \fn BOOL GUIAPI ServerSetTopmostLayer (MG_Layer* layer)

14
include/window.h
View File

@@ -2043,7 +2043,7 @@ extern DWORD __mg_interval_time;
* Hides the window.
* - SW_SHOWNORMAL\n
* Shows the window, and if the window is a main window
* sets it to be the topmost main window.
* sets it to be the topmost main window in its z-node level.
*
* \sa ShowWindow
*/
@@ -4258,8 +4258,8 @@ MG_EXPORT SRVEVTHOOK GUIAPI SetServerEventHook (SRVEVTHOOK SrvEvtHook);
* above all normal windows, and if you use MiniGUI-Processes runtime mode,
* the server (`mginit`) will always create global main windows.
*
* Since 5.0.0, we introduce a concept of levels for main windows. There are
* eight levels in MiniGUI from top to bottom:
* Since 5.0.0, we introduce a concept of zorder levels for main windows.
* There are eight levels in MiniGUI from top to bottom:
*
* - The tooltip level.
* - The system/global level.
@@ -4270,13 +4270,13 @@ MG_EXPORT SRVEVTHOOK GUIAPI SetServerEventHook (SRVEVTHOOK SrvEvtHook);
* - The launcher level.
* - The desktop or wallpaper.
*
* We use new styles like \a WS_EX_WINTYPE_SYSTEM to create main windows in
* We use new styles like \a WS_EX_WINTYPE_GLOBAL to create main windows in
* different levels. For historical reasons, you can still use the style
* \a WS_EX_TOPMOST, but MiniGUI will create a main window in the higher
* level for this styele.
* level for this style.
*
* By default, without the style \a WS_EX_TOPMOST or a style like
* \a WS_EX_WINTYPE_SYSTEM, MiniGUI will create a main window in
* \a WS_EX_WINTYPE_GLOBAL, MiniGUI will create a main window in
* the normal level.
*
* The main windows in the desktop level are managed
@@ -4511,7 +4511,7 @@ MG_EXPORT SRVEVTHOOK GUIAPI SetServerEventHook (SRVEVTHOOK SrvEvtHook);
* the server (`mginit`) will always create global main windows.
*
* Since 5.0.0, we introduce a concept of levels for main windows. We can
* use new styles like \a WS_EX_WINTYPE_SYSTEM to create main windows in
* use new styles like \a WS_EX_WINTYPE_GLOBAL to create main windows in
* different levels. For historical reasons, you can still use this style,
* but MiniGUI will create a main window in the higher level for this styele.
*