mGNCS4Touch API Reference  v1.5.0
A set of mGNCS-compliant controls for devices with a touch screen.
Data Structures | Macros | Enumerations | Variables
mBtnNavBar

Data Structures

struct  mBtnNavBar
 BtnNavBar class, derived from mWidget. More...
 
struct  mBtnNavBarClass
 toolcaption struct of toolcaption control, derived from mWidgetClass More...
 
struct  mBtnNavBarRenderer
 BtnNavBar class renderer interface, derived from mWidgetRenderer. More...
 

Macros

#define NCSCTRL_BTNNAVBAR   NCSCLASSNAME("btnnavbar")
 the name of btnnavbar control More...
 

Enumerations

enum  mBtnNavBarProp {
  NCSP_BNB_LSTRING = NCSP_WIDGET_MAX + 1, NCSP_BNB_RSTRING, NCSP_BNB_FONT, NCSP_BNB_MARGIN,
  NCSP_BNB_LEFT_W, NCSP_BNB_RIGHT_W, NCSP_BNB_BTN_H
}
 the properties id of mBtnNavBar More...
 
enum  mBtnNavBarData { NCSD_BNB_LEFT = 0, NCSD_BNB_RIGHT }
 define the clicked add of param More...
 
enum  mBtnNavBarNotify { NCSN_BNB_BTNCLICK = NCSN_WIDGET_MAX + 1 }
 the notification code of mBtnNavBar More...
 
enum  mBtnNavBarBoxLayoutPieceIndexID { BNB_LEFT_PIECE_ID = 0, BNB_RIGHT_PIECE_ID = 2 }
 the piece index id of mBtnNavBar More...
 

Variables

MTOUCH_EXPORT mBtnNavBarClass g_stmBtnNavBarCls
 global mBtnNavBarClass More...
 

mBtnNavBarStyle the style id of \ref mBtnNavBar

#define NCSS_BNB_LRECT   (0x01 << NCSS_WIDGET_SHIFT)
 Identifies the left button is on behalf of the triangular shape of the left. More...
 
#define NCSS_BNB_LOPT   (0x02 << NCSS_WIDGET_SHIFT)
 Identifies the left button is a rounded rectangular shape. More...
 
#define NCSS_BNB_LNONE   (0x04 << NCSS_WIDGET_SHIFT)
 Identifies the left button is not displayed the shape. More...
 
#define NCSS_BNB_RRECT   (0x08 << NCSS_WIDGET_SHIFT)
 Identifies the right button is on behalf of the triangular shape of the right. More...
 
#define NCSS_BNB_ROPT   (0x10 << NCSS_WIDGET_SHIFT)
 Identifies the right button is a rounded rectangular shape. More...
 
#define NCSS_BNB_RNONE   (0x20 << NCSS_WIDGET_SHIFT)
 Identifies the right button is not displayed the shape. More...
 
#define NCSS_BNB_SHIFT   (NCSS_WIDGET_SHIFT + 6)
 

Detailed Description

Macro Definition Documentation

◆ NCSCTRL_BTNNAVBAR

#define NCSCTRL_BTNNAVBAR   NCSCLASSNAME("btnnavbar")

the name of btnnavbar control

Definition at line 67 of file mbtnnavbar.h.

◆ NCSS_BNB_LNONE

#define NCSS_BNB_LNONE   (0x04 << NCSS_WIDGET_SHIFT)

Identifies the left button is not displayed the shape.

Definition at line 96 of file mbtnnavbar.h.

◆ NCSS_BNB_LOPT

#define NCSS_BNB_LOPT   (0x02 << NCSS_WIDGET_SHIFT)

Identifies the left button is a rounded rectangular shape.

Definition at line 95 of file mbtnnavbar.h.

◆ NCSS_BNB_LRECT

#define NCSS_BNB_LRECT   (0x01 << NCSS_WIDGET_SHIFT)

Identifies the left button is on behalf of the triangular shape of the left.

Definition at line 94 of file mbtnnavbar.h.

◆ NCSS_BNB_RNONE

#define NCSS_BNB_RNONE   (0x20 << NCSS_WIDGET_SHIFT)

Identifies the right button is not displayed the shape.

Definition at line 99 of file mbtnnavbar.h.

◆ NCSS_BNB_ROPT

#define NCSS_BNB_ROPT   (0x10 << NCSS_WIDGET_SHIFT)

Identifies the right button is a rounded rectangular shape.

Definition at line 98 of file mbtnnavbar.h.

◆ NCSS_BNB_RRECT

#define NCSS_BNB_RRECT   (0x08 << NCSS_WIDGET_SHIFT)

Identifies the right button is on behalf of the triangular shape of the right.

Definition at line 97 of file mbtnnavbar.h.

Enumeration Type Documentation

◆ mBtnNavBarBoxLayoutPieceIndexID

the piece index id of mBtnNavBar

Enumerator
BNB_LEFT_PIECE_ID 

The left piece of the index id.

BNB_RIGHT_PIECE_ID 

The right piece of the index id.

Definition at line 231 of file mbtnnavbar.h.

◆ mBtnNavBarData

define the clicked add of param

Enumerator
NCSD_BNB_LEFT 

Left button click event listener param.

NCSD_BNB_RIGHT 

Right button click event listener param.

Definition at line 204 of file mbtnnavbar.h.

◆ mBtnNavBarNotify

the notification code of mBtnNavBar

Enumerator
NCSN_BNB_BTNCLICK 

Around both ends of the button click event listener.

Definition at line 216 of file mbtnnavbar.h.

◆ mBtnNavBarProp

the properties id of mBtnNavBar

end of mBtnNavBarStyle

Enumerator
NCSP_BNB_LSTRING 

Store the string on the left button.

NCSP_BNB_RSTRING 

Store the string on the right button.

NCSP_BNB_FONT 

Set the font size on the navigation bar.

NCSP_BNB_MARGIN 

Left and right ends of the blank reserved for control.

NCSP_BNB_LEFT_W 

The width of the left button.

NCSP_BNB_RIGHT_W 

The width of the right button.

NCSP_BNB_BTN_H 

Left and right buttons of the high.

Definition at line 131 of file mbtnnavbar.h.

Variable Documentation

◆ g_stmBtnNavBarCls

g_stmBtnNavBarCls