mButton

Data Structures

• struct mButton

  Button class, derived from mWidget. More...
  

• struct mButtonClass

  button struct of button control, derived from mWidgetClass More...
  

• struct mButtonRenderer

  Button class renderer interface, derived from mWidgetRenderer. More...
  

Defines

• #define NCSCTRL_BUTTON   NCSCLASSNAME("button")

  the name of button control
  

• #define NCSS_BUTTON_IMAGE   (1<<NCSS_WIDGET_SHIFT)

  indicate a image button
  

• #define NCSS_BUTTON_CHECKABLE   (2<<NCSS_WIDGET_SHIFT)

  indicate a chackable button
  

• #define NCSS_BUTTON_AUTOCHECK   (4<<NCSS_WIDGET_SHIFT)

  indicate a auto check button
  

• #define NCSS_BUTTON_3DCHECK   (8<<NCSS_WIDGET_SHIFT)

  indicate a three type (unchecked-halfchekced-checked) check button
  

• #define NCSS_BUTTON_IMAGELABEL   (0x10<<NCSS_WIDGET_SHIFT)

  indicate a button with image and label
  

• #define NCSS_BUTTON_VERTIMAGELABEL   (0x20<<NCSS_WIDGET_SHIFT)

  indicate a button with vertical image and label
  

Enumerations

• enum mButtonCheckState { NCS_BUTTON_UNCHECKED = 0, NCS_BUTTON_HALFCHECKED, NCS_BUTTON_CHECKED }

  define the check state of button

  More...
  

• enum mButtonProp {
    NCSP_BUTTON_ALIGN = NCSP_WIDGET_MAX + 1, NCSP_BUTTON_VALIGN, NCSP_BUTTON_WORDWRAP, NCSP_BUTTON_IMAGE,
    NCSP_BUTTON_CHECKSTATE, NCSP_BUTTON_IMAGE_SIZE_PERCENT, NCSP_BUTTON_GROUPID, NCSP_BUTTON_GROUP
  }

  the properties id of mButton

  More...
  

• enum eButtonNotify { NCSN_BUTTON_PUSHED = NCSN_WIDGET_MAX + 1, NCSN_BUTTON_STATE_CHANGED }

  the notification code of mButton

  More...
  

Variables

• MGNCS_EXPORT mButtonClass g_stmButtonCls

  global mButtonClass
  

---

Define Documentation

#define NCSCTRL_BUTTON   NCSCLASSNAME("button")

the name of button control

Definition at line 18 of file mbutton.h.

#define NCSS_BUTTON_3DCHECK   (8<<NCSS_WIDGET_SHIFT)

indicate a three type (unchecked-halfchekced-checked) check button

Note:

This style must combine with NCSS_BUTTON_3DCHECK

Definition at line 245 of file mbutton.h.

#define NCSS_BUTTON_AUTOCHECK   (4<<NCSS_WIDGET_SHIFT)

indicate a auto check button

Note:

This style must combine with NCSS_BUTTON_CHECKABLE

Definition at line 239 of file mbutton.h.

#define NCSS_BUTTON_CHECKABLE   (2<<NCSS_WIDGET_SHIFT)

indicate a chackable button

Definition at line 233 of file mbutton.h.

#define NCSS_BUTTON_IMAGE   (1<<NCSS_WIDGET_SHIFT)

indicate a image button

Definition at line 228 of file mbutton.h.

#define NCSS_BUTTON_IMAGELABEL   (0x10<<NCSS_WIDGET_SHIFT)

indicate a button with image and label

Note:

by default, image and label are lined up horizontal

Definition at line 251 of file mbutton.h.

#define NCSS_BUTTON_VERTIMAGELABEL   (0x20<<NCSS_WIDGET_SHIFT)

indicate a button with vertical image and label

Note:

This sytle must combine with NCSS_BUTTON_IMAGELABEL

Definition at line 257 of file mbutton.h.

---

Enumeration Type Documentation

enum eButtonNotify

the notification code of mButton

Enumerator:

NCSN_BUTTON_PUSHED	button pushed
NCSN_BUTTON_STATE_CHANGED	button check state changed Parameters: the  new check state See also: NCSP_BUTTON_CHECKSTATE

Definition at line 208 of file mbutton.h.

enum mButtonCheckState

define the check state of button

Enumerator:

NCS_BUTTON_UNCHECKED	button unchecked state, the button is not pushed down
NCS_BUTTON_HALFCHECKED	button halfchecked state, it is a state between checked and unchecked, halfchecked state is valid if the button is a 3-state button
NCS_BUTTON_CHECKED	button checked state, the button is pushed down

Definition at line 29 of file mbutton.h.

enum mButtonProp

the properties id of mButton

Enumerator:

NCSP_BUTTON_ALIGN	Set the button text horizontal align Type enumNCSAlign Read Write set the horizontal align value of the text on button.
NCSP_BUTTON_VALIGN	Set the button text vertical align Type enumNCSVAlign Read Write set the vertical align value of the text on button.
NCSP_BUTTON_WORDWRAP	Set the button text to autowrap mode Type int Read Write turn on/off the autowrap mode of button text.
NCSP_BUTTON_IMAGE	Set the button image pointer Type PBITMAP Read Write Set the image pointer for the image displayed on button.
NCSP_BUTTON_CHECKSTATE	Set the check state of button Type mButtonCheckState Read Write set the check state of button to checked/half-checked/unchecked.
NCSP_BUTTON_IMAGE_SIZE_PERCENT	Set the image size Type int Read Write Set the image size percent on button, it should be >=15 and <=85, this property works when the button has NCSS_BUTTON_IMAGELABEL style.
NCSP_BUTTON_GROUPID	Set the button group id Type int Read Write Set the the button group id.
NCSP_BUTTON_GROUP	Set the button group Type mButtonGroup* Read Write Set the button group pointer.

Definition at line 135 of file mbutton.h.

---

Variable Documentation

g_stmButtonCls

global mButtonClass

global mStaticClass