declare a new global variable: mgDefaultLayer; tune description of MoveToLayer and ServerMoveToLayer

This commit is contained in:
Vincent Wei
2021-03-24 11:29:37 +08:00
parent 9fa7401542
commit e1ea9b7209

View File

@@ -351,9 +351,17 @@ extern MG_EXPORT MG_Client* mgClients;
*/
extern MG_EXPORT MG_Layer* mgTopmostLayer;
/**
* \var MG_Layer* mgDefaultLayer
* \brief The pointer to the default layer.
*
* \sa MG_Layer
*/
extern MG_EXPORT MG_Layer* mgDefaultLayer;
/**
* \var MG_Layer* mgLayers
* \brief The pointer to the array of layers.
* \brief The pointer to the layer list.
*
* \sa MG_Layer
*/
@@ -562,6 +570,8 @@ MG_EXPORT BOOL GUIAPI DeleteLayer (BOOL handle_name,
*
* \return TRUE on success, otherwise FALSE.
*
* \note Only one client which has no any window can be moved.
*
* \note The client which created a fixed main window
* (a main window acts as the screen lock, the docker, or the launcher) will
* be moved to the topmost layer automatically.
@@ -1491,7 +1501,9 @@ MG_EXPORT BOOL GUIAPI ServerDoZNodeOperation (MG_Layer* layer, int idx_znode,
*
* \return TRUE on success, otherwise FALSE.
*
* \note Server-only function. The client which created a fixed main window
* \note Server-only function. Only one client which has no any window can be moved.
*
* \note The client which created a fixed main window
* (a main window acts as the screen lock, the docker, or the launcher) will
* be moved to the topmost layer automatically.
*