mGNCS API Reference  v1.2.0
A new control set and a new framework for MiniGUI apps
Data Structures | Macros | Typedefs | Enumerations | Functions | Variables
mNode

Data Structures

struct  mNode
 The structure of mNode. It is the basic class of all nodes occur within specific controls. For example, a list can contain it. More...
 
struct  mNodeClass
 The virtual function table of mNodeClass. More...
 

Macros

#define NCSS_NODE_LTEXTRS   0x0000
 Image on the left and text on the right. default style. More...
 
#define NCSS_NODE_SMALLICON   0x0001
 Small icon mode. Show small icon in normal status, or enlarge icon in selected status. More...
 
#define NCSS_NODE_LTEXTBS   0x0002
 Large Icon mode. Image on the top and text on the bottom. More...
 
#define NCSS_NODE_TICTACTOEMIDLET   0x0004
 tictactoemidlet mode. Image includes normal and selected status. More...
 
#define NCSS_NODE_HIDETEXT   0x0010
 Don't show text. More...
 
#define NCSS_NODE_HIDEIMAGE   0x0020
 Don't show image. More...
 
#define NCSS_NODE_DISABLED   0x0040
 Disabled Node. More...
 
#define NCSS_NODE_SHIFT   7
 The bits used by mNode in style. More...
 

Typedefs

typedef int(* NCS_CB_CMPNODE) (mNode *node1, mNode *node2)
 The callback of node comparison function. More...
 

Enumerations

Functions

MGNCS_EXPORT mNodencsCreateNode (mObject *parent, const char *text, PBITMAP image, int height, int style, DWORD addData)
 Create a new node according to parameter information. More...
 
MGNCS_EXPORT mNodencsAddNode (mObject *parent, const char *text, PBITMAP image, int height, int style, DWORD addData)
 Create and add a new node to control according to parameter information. More...
 

Variables

MGNCS_EXPORT mNodeClass g_stmNodeCls
 The instance of mNodeClass. More...
 
MGNCS_EXPORT mGroupNodeClass g_stmGroupNodeCls
 The instance of mGroupNodeClass. More...
 

Detailed Description

Macro Definition Documentation

#define NCSS_NODE_DISABLED   0x0040

Disabled Node.

Definition at line 101 of file mnode.h.

#define NCSS_NODE_HIDEIMAGE   0x0020

Don't show image.

Definition at line 95 of file mnode.h.

#define NCSS_NODE_HIDETEXT   0x0010

Don't show text.

Definition at line 89 of file mnode.h.

#define NCSS_NODE_LTEXTBS   0x0002

Large Icon mode. Image on the top and text on the bottom.

Definition at line 75 of file mnode.h.

#define NCSS_NODE_LTEXTRS   0x0000

Image on the left and text on the right. default style.

Definition at line 62 of file mnode.h.

#define NCSS_NODE_SHIFT   7

The bits used by mNode in style.

Definition at line 107 of file mnode.h.

#define NCSS_NODE_SMALLICON   0x0001

Small icon mode. Show small icon in normal status, or enlarge icon in selected status.

Definition at line 69 of file mnode.h.

#define NCSS_NODE_TICTACTOEMIDLET   0x0004

tictactoemidlet mode. Image includes normal and selected status.

Definition at line 81 of file mnode.h.

Typedef Documentation

typedef int(* NCS_CB_CMPNODE)(mNode *node1, mNode *node2)

The callback of node comparison function.

Definition at line 114 of file mnode.h.

Enumeration Type Documentation

enum mNodeEvent

The event id of mNode.

Enumerator
NCSE_NODE_CONTENTCHANGED 

The content has been changed.

  • param : mNode*, the pointer to changed node.
NCSE_NODE_HEIGHTCHANGED 

The height of node has been changed.

  • param : mNodeEventData*, the data is the different value of height.
NCSE_NODE_REFRESH 

Refresh node.

  • param : mNode*, the pointer to refresh node.
NCSE_NODE_NODEADDED 

The node has been added.

  • param : mNode*, the pointer to added node.
NCSE_NODE_NODEDELETED 

The content has been deleted, Only have removed from sibling list.

  • param : mNode*, the pointer to deleted node.

Definition at line 417 of file mnode.h.

enum mNodeProp

The properties id of mNode.

Enumerator
NCSP_NODE_HEIGHT 

The height.(Uint16)

NCSP_NODE_TEXT 

The text string.(char*)

NCSP_NODE_IMAGE 

The image. (PBITMAP)

NCSP_NODE_ADDDATA 

The additional data. (DWORD)

NCSP_NODE_ENABLED 

The enabled status of node. RW.

NCSP_NODE_SELECTED 

The selected status of node. RO.

NCSP_NODE_PARENTNODE 

The parent node.(mObject*). RO.

NCSP_NODE_FIRSTCHILD 

The first child node.(mNode*). RO.

NCSP_NODE_LASTCHILD 

The last child node. (mNode*). RO.

NCSP_NODE_CHILDRENCOUNT 

The number of children. (int). RO.

NCSP_NODE_LAYOUT 

The layout information.

NCSP_NODE_HIDETEXT 

Whether hides text or not.

NCSP_NODE_HIDEIMAGE 

Whether hides image or not.

NCSP_NODE_MAX 

The maximum value of mNode properties id.

Definition at line 454 of file mnode.h.

The found information type used by findNode.

Enumerator
NCS_NODE_FTSTRING 

According to text string.

NCS_NODE_FTDATA 

According to additional data.

NCS_NODE_FTIMAGE 

According to image.

Definition at line 254 of file mnode.h.

Function Documentation

mNode * ncsAddNode ( mObject parent,
const char *  text,
PBITMAP  image,
int  height,
int  style,
DWORD  addData 
)

Create and add a new node to control according to parameter information.

Parameters
parentThe pointer to parent object.
textThe text string.
imagePBITMAP structure, the pointer to image.
heightThe height. If height < 0, it will use the default height of node in associated control.
styleThe style of node.
addDataThe additional data.
Returns
The new pointer to node.
See also
ncsCreateNode
mNode * ncsCreateNode ( mObject parent,
const char *  text,
PBITMAP  image,
int  height,
int  style,
DWORD  addData 
)

Create a new node according to parameter information.

Parameters
parentThe pointer to parent object.
textThe text string.
imagePBITMAP structure, the pointer to image.
heightThe height. If height < 0, it will use the default height of node in associated control.
styleThe style of node.
addDataThe additional data.
Returns
The new pointer to node.

Variable Documentation

g_stmGroupNodeCls

The instance of mGroupNodeClass.

See also
mGroupNodeClass
g_stmNodeCls

The instance of mNodeClass.

See also
mNodeClass