cocos2d-x  3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
UI Nodes

Namespaces

 cocos2d
 
 cocos2d::ui
 
 cocos2d::experimental
 
 cocos2d::experimental::ui
 
 cocos2d::extension
 

Classes

class  TextFieldDelegate
 A input protocol for TextField. More...
 
class  TextFieldTTF
 A simple text input field with TTF font. More...
 
class  Button
 Represents a push-button widget. More...
 
class  CheckBox
 Checkbox is a specific type of two-states button that can be either checked or unchecked. More...
 
class  EditBoxDelegate
 Editbox delgate class. More...
 
class  EditBox
 Class for edit box. More...
 
class  HBox
 HBox is just a convenient wrapper class for horizontal layout type. More...
 
class  Helper
 
class  ImageView
 A widget to display images. More...
 
class  LayoutProtocol
 Layout interface for creating LayoutManger and do actual layout. More...
 
class  Layout
 A container for holding a few child widgets. More...
 
class  LayoutComponent
 A component class used for layout. More...
 
class  LayoutManager
 Base class for managing layout. More...
 
class  LinearVerticalLayoutManager
 Linear vertical layouting class. More...
 
class  LinearHorizontalLayoutManager
 Linear horizontal layouting class. More...
 
class  RelativeLayoutManager
 Relative layouting class. More...
 
class  Margin
 Margin of widget's in point. More...
 
class  LayoutParameter
 Base class for various LayoutParameter. More...
 
class  LayoutParameterProtocol
 Protocol for getting a LayoutParameter. More...
 
class  LinearLayoutParameter
 Linear layout parameter. More...
 
class  RelativeLayoutParameter
 Relative layout parameter. More...
 
class  ListView
 ListView is a view group that displays a list of scrollable items. More...
 
class  LoadingBar
 Visual indicator of progress in some operation. More...
 
class  PageView
 Layout manager that allows the user to flip left and right through pages of data. More...
 
class  RelativeBox
 RelativeBox is just a convenient wrapper class for relative layout type. More...
 
class  RichElement
 Rich text element base class. More...
 
class  RichElementText
 Rich element for displaying text. More...
 
class  RichElementImage
 Rich element for displaying images. More...
 
class  RichElementCustomNode
 Rich element for displaying custom node type. More...
 
class  RichText
 A container for displaying various RichElements. More...
 
class  Scale9Sprite
 A 9-slice sprite for cocos2d-x. More...
 
class  ScrollView
 Layout container for a view hierarchy that can be scrolled by the user, allowing it to be larger than the physical display. More...
 
class  Slider
 UI Slider widget. More...
 
class  Text
 For creating a system font or a TTF font Text. More...
 
class  TextAtlas
 UI TextAtlas widget. More...
 
class  TextBMFont
 A widget for displaying BMFont label. More...
 
class  UICCTextField
 A helper class which inherit from. More...
 
class  TextField
 A widget which allows users to input text. More...
 
class  VBox
 VBox is just a convenient wrapper class for vertical layout type. More...
 
class  VideoPlayer
 Displays a video file. More...
 
class  WebView
 A View that displays web pages. More...
 
class  Widget
 Base class for all ui widgets. More...
 
class  ScrollViewDelegate
 
class  TableViewDelegate
 Sole purpose of this delegate is to single touch event in this version. More...
 
class  TableViewDataSource
 Data source that governs table backend data. More...
 
class  TableView
 UITableView support for cocos2d-x. More...
 
class  TableViewCell
 Abstract class for SWTableView cell node. More...
 

Enumerations

enum  CheckBoxEventType { CHECKBOX_STATE_EVENT_SELECTED, CHECKBOX_STATE_EVENT_UNSELECTED }
 Checkbox event type, there are two type here: More...
 
enum  EventType { SELECTED, UNSELECTED }
 CheckBox event type, currently only "selected" and "unselected" event are cared. More...
 
enum  KeyboardReturnType {
  DEFAULT, DONE, SEND, SEARCH,
  GO
}
 The popup keyboard return type. More...
 
enum  InputMode {
  ANY, EMAIL_ADDRESS, NUMERIC, PHONE_NUMBER,
  URL, DECIMAL, SINGLE_LINE
}
 The EditBox::InputMode defines the type of text that the user is allowed to enter. More...
 
enum  InputFlag {
  PASSWORD, SENSITIVE, INITIAL_CAPS_WORD, INITIAL_CAPS_SENTENCE,
  INTIAL_CAPS_ALL_CHARACTERS
}
 The EditBox::InputFlag defines how the input text is displayed/formatted. More...
 
enum  Type { ABSOLUTE, VERTICAL, HORIZONTAL, RELATIVE }
 Layout type, default is ABSOLUTE. More...
 
enum  ClippingType { STENCIL, SCISSOR }
 Clipping Type, default is STENCIL. More...
 
enum  BackGroundColorType { NONE, SOLID, GRADIENT }
 Background color type, default is NONE. More...
 
enum  HorizontalEdge { None, Left, Right, Center }
 Horizontal dock position type. More...
 
enum  VerticalEdge { None, Bottom, Top, Center }
 Vertical dock position type. More...
 
enum  Type { NONE = 0, LINEAR, RELATIVE }
 Layout parameter type. More...
 
enum  LinearGravity {
  NONE, LEFT, TOP, RIGHT,
  BOTTOM, CENTER_VERTICAL, CENTER_HORIZONTAL
}
 Linear gravity. More...
 
enum  RelativeAlign {
  NONE, PARENT_TOP_LEFT, PARENT_TOP_CENTER_HORIZONTAL, PARENT_TOP_RIGHT,
  PARENT_LEFT_CENTER_VERTICAL, CENTER_IN_PARENT, PARENT_RIGHT_CENTER_VERTICAL, PARENT_LEFT_BOTTOM,
  PARENT_BOTTOM_CENTER_HORIZONTAL, PARENT_RIGHT_BOTTOM, LOCATION_ABOVE_LEFTALIGN, LOCATION_ABOVE_CENTER,
  LOCATION_ABOVE_RIGHTALIGN, LOCATION_LEFT_OF_TOPALIGN, LOCATION_LEFT_OF_CENTER, LOCATION_LEFT_OF_BOTTOMALIGN,
  LOCATION_RIGHT_OF_TOPALIGN, LOCATION_RIGHT_OF_CENTER, LOCATION_RIGHT_OF_BOTTOMALIGN, LOCATION_BELOW_LEFTALIGN,
  LOCATION_BELOW_CENTER, LOCATION_BELOW_RIGHTALIGN
}
 Relative Alignment type. More...
 
enum  ListViewEventType { LISTVIEW_ONSELECTEDITEM_START, LISTVIEW_ONSELECTEDITEM_END }
 ListView click item event type. More...
 
enum  Gravity {
  LEFT, RIGHT, CENTER_HORIZONTAL, TOP,
  BOTTOM, CENTER_VERTICAL
}
 Gravity for docking elements in ListView. More...
 
enum  EventType { ON_SELECTED_ITEM_START, ON_SELECTED_ITEM_END }
 ListView element item click event. More...
 
enum  Direction { LEFT, RIGHT }
 Loading bar progress direction. More...
 
enum  PageViewEventType { PAGEVIEW_EVENT_TURNING }
 PageView page turn event type. More...
 
enum  EventType { TURNING }
 Page turn event tpye. More...
 
enum  TouchDirection { LEFT, RIGHT }
 Touch direction type. More...
 
enum  AutoScrollDirection { LEFT, RIGHT }
 
enum  Type { TEXT, IMAGE, CUSTOM }
 Rich element type. More...
 
enum  State { NORMAL, GRAY }
 Builtin shader state. More...
 
enum  ScrollviewEventType {
  SCROLLVIEW_EVENT_SCROLL_TO_TOP, SCROLLVIEW_EVENT_SCROLL_TO_BOTTOM, SCROLLVIEW_EVENT_SCROLL_TO_LEFT, SCROLLVIEW_EVENT_SCROLL_TO_RIGHT,
  SCROLLVIEW_EVENT_SCROLLING, SCROLLVIEW_EVENT_BOUNCE_TOP, SCROLLVIEW_EVENT_BOUNCE_BOTTOM, SCROLLVIEW_EVENT_BOUNCE_LEFT,
  SCROLLVIEW_EVENT_BOUNCE_RIGHT
}
 Scrollview scroll event type. More...
 
enum  Direction { NONE, VERTICAL, HORIZONTAL, BOTH }
 ScrollView scroll direction type. More...
 
enum  EventType {
  SCROLL_TO_TOP, SCROLL_TO_BOTTOM, SCROLL_TO_LEFT, SCROLL_TO_RIGHT,
  SCROLLING, BOUNCE_TOP, BOUNCE_BOTTOM, BOUNCE_LEFT,
  BOUNCE_RIGHT
}
 Scrollview scroll event type. More...
 
enum  SliderEventType { SLIDER_PERCENTCHANGED }
 
enum  EventType { ON_PERCENTAGE_CHANGED }
 EventType Slider event type. More...
 
enum  Type { SYSTEM, TTF }
 Type Text type. More...
 
enum  TextFiledEventType { TEXTFIELD_EVENT_ATTACH_WITH_IME, TEXTFIELD_EVENT_DETACH_WITH_IME, TEXTFIELD_EVENT_INSERT_TEXT, TEXTFIELD_EVENT_DELETE_BACKWARD }
 TextField event type. More...
 
enum  EventType { ATTACH_WITH_IME, DETACH_WITH_IME, INSERT_TEXT, DELETE_BACKWARD }
 TextField event type. More...
 
enum  EventType { PLAYING = 0, PAUSED, STOPPED, COMPLETED }
 
enum  Source { FILENAME = 0, URL }
 
enum  TouchEventType { TOUCH_EVENT_BEGAN, TOUCH_EVENT_MOVED, TOUCH_EVENT_ENDED, TOUCH_EVENT_CANCELED }
 Touch event type. More...
 
enum  FocusDirection { LEFT, RIGHT, UP, DOWN }
 Widget focus direction. More...
 
enum  PositionType { ABSOLUTE, PERCENT }
 Widget position type for layout. More...
 
enum  SizeType { ABSOLUTE, PERCENT }
 Widget size type for layout. More...
 
enum  TouchEventType { BEGAN, MOVED, ENDED, CANCELED }
 Touch event type. More...
 
enum  TextureResType { LOCAL = 0, PLIST = 1 }
 Texture resource type. More...
 
enum  BrightStyle { NONE = -1, NORMAL, HIGHLIGHT }
 Widget bright style. More...
 
enum  Direction { NONE = -1, HORIZONTAL = 0, VERTICAL, BOTH }
 
enum  VerticalFillOrder { TOP_DOWN, BOTTOM_UP }
 

Detailed Description

Enumeration Type Documentation

enum AutoScrollDirection
strongprotected
Enumerator
LEFT 
RIGHT 
var AutoScrollDirection
strongprotected
Enumerator
LEFT 
RIGHT 
local AutoScrollDirection
strongprotected
Enumerator
LEFT 
RIGHT 
enum BackGroundColorType
strong

Background color type, default is NONE.

Enumerator
NONE 
SOLID 
GRADIENT 
var BackGroundColorType
strong

Background color type, default is NONE.

Enumerator
NONE 
SOLID 
GRADIENT 
local BackGroundColorType
strong

Background color type, default is NONE.

Enumerator
NONE 
SOLID 
GRADIENT 
enum BrightStyle
strong

Widget bright style.

Enumerator
NONE 
NORMAL 
HIGHLIGHT 
var BrightStyle
strong

Widget bright style.

Enumerator
NONE 
NORMAL 
HIGHLIGHT 
local BrightStyle
strong

Widget bright style.

Enumerator
NONE 
NORMAL 
HIGHLIGHT 
enum CheckBoxEventType

Checkbox event type, there are two type here:

Enumerator
CHECKBOX_STATE_EVENT_SELECTED 
CHECKBOX_STATE_EVENT_UNSELECTED 
var CheckBoxEventType

Checkbox event type, there are two type here:

Enumerator
CHECKBOX_STATE_EVENT_SELECTED 
CHECKBOX_STATE_EVENT_UNSELECTED 
local CheckBoxEventType

Checkbox event type, there are two type here:

Enumerator
CHECKBOX_STATE_EVENT_SELECTED 
CHECKBOX_STATE_EVENT_UNSELECTED 
enum ClippingType
strong

Clipping Type, default is STENCIL.

Enumerator
STENCIL 
SCISSOR 
var ClippingType
strong

Clipping Type, default is STENCIL.

Enumerator
STENCIL 
SCISSOR 
local ClippingType
strong

Clipping Type, default is STENCIL.

Enumerator
STENCIL 
SCISSOR 
enum Direction
strong

Loading bar progress direction.

Enumerator
LEFT 
RIGHT 
var Direction
strong

Loading bar progress direction.

Enumerator
LEFT 
RIGHT 
local Direction
strong

Loading bar progress direction.

Enumerator
LEFT 
RIGHT 
enum Direction
strong
Enumerator
NONE 
HORIZONTAL 
VERTICAL 
BOTH 
var Direction
strong
Enumerator
NONE 
HORIZONTAL 
VERTICAL 
BOTH 
local Direction
strong
Enumerator
NONE 
HORIZONTAL 
VERTICAL 
BOTH 
enum Direction
strong

ScrollView scroll direction type.

Enumerator
NONE 
VERTICAL 
HORIZONTAL 
BOTH 
var Direction
strong

ScrollView scroll direction type.

Enumerator
NONE 
VERTICAL 
HORIZONTAL 
BOTH 
local Direction
strong

ScrollView scroll direction type.

Enumerator
NONE 
VERTICAL 
HORIZONTAL 
BOTH 
enum EventType
strong
Enumerator
PLAYING 
PAUSED 
STOPPED 
COMPLETED 
var EventType
strong
Enumerator
PLAYING 
PAUSED 
STOPPED 
COMPLETED 
local EventType
strong
Enumerator
PLAYING 
PAUSED 
STOPPED 
COMPLETED 
enum EventType
strong

EventType Slider event type.

Enumerator
ON_PERCENTAGE_CHANGED 
var EventType
strong

EventType Slider event type.

Enumerator
ON_PERCENTAGE_CHANGED 
local EventType
strong

EventType Slider event type.

Enumerator
ON_PERCENTAGE_CHANGED 
enum EventType
strong

Page turn event tpye.

Enumerator
TURNING 
var EventType
strong

Page turn event tpye.

Enumerator
TURNING 
local EventType
strong

Page turn event tpye.

Enumerator
TURNING 
enum EventType
strong

CheckBox event type, currently only "selected" and "unselected" event are cared.

Enumerator
SELECTED 
UNSELECTED 
var EventType
strong

CheckBox event type, currently only "selected" and "unselected" event are cared.

Enumerator
SELECTED 
UNSELECTED 
local EventType
strong

CheckBox event type, currently only "selected" and "unselected" event are cared.

Enumerator
SELECTED 
UNSELECTED 
enum EventType
strong

ListView element item click event.

Enumerator
ON_SELECTED_ITEM_START 
ON_SELECTED_ITEM_END 
var EventType
strong

ListView element item click event.

Enumerator
ON_SELECTED_ITEM_START 
ON_SELECTED_ITEM_END 
local EventType
strong

ListView element item click event.

Enumerator
ON_SELECTED_ITEM_START 
ON_SELECTED_ITEM_END 
enum EventType
strong

Scrollview scroll event type.

Enumerator
SCROLL_TO_TOP 
SCROLL_TO_BOTTOM 
SCROLL_TO_LEFT 
SCROLL_TO_RIGHT 
SCROLLING 
BOUNCE_TOP 
BOUNCE_BOTTOM 
BOUNCE_LEFT 
BOUNCE_RIGHT 
var EventType
strong

Scrollview scroll event type.

Enumerator
SCROLL_TO_TOP 
SCROLL_TO_BOTTOM 
SCROLL_TO_LEFT 
SCROLL_TO_RIGHT 
SCROLLING 
BOUNCE_TOP 
BOUNCE_BOTTOM 
BOUNCE_LEFT 
BOUNCE_RIGHT 
local EventType
strong

Scrollview scroll event type.

Enumerator
SCROLL_TO_TOP 
SCROLL_TO_BOTTOM 
SCROLL_TO_LEFT 
SCROLL_TO_RIGHT 
SCROLLING 
BOUNCE_TOP 
BOUNCE_BOTTOM 
BOUNCE_LEFT 
BOUNCE_RIGHT 
enum EventType
strong

TextField event type.

Enumerator
ATTACH_WITH_IME 
DETACH_WITH_IME 
INSERT_TEXT 
DELETE_BACKWARD 
var EventType
strong

TextField event type.

Enumerator
ATTACH_WITH_IME 
DETACH_WITH_IME 
INSERT_TEXT 
DELETE_BACKWARD 
local EventType
strong

TextField event type.

Enumerator
ATTACH_WITH_IME 
DETACH_WITH_IME 
INSERT_TEXT 
DELETE_BACKWARD 
enum FocusDirection
strong

Widget focus direction.

Enumerator
LEFT 
RIGHT 
UP 
DOWN 
var FocusDirection
strong

Widget focus direction.

Enumerator
LEFT 
RIGHT 
UP 
DOWN 
local FocusDirection
strong

Widget focus direction.

Enumerator
LEFT 
RIGHT 
UP 
DOWN 
enum Gravity
strong

Gravity for docking elements in ListView.

Enumerator
LEFT 
RIGHT 
CENTER_HORIZONTAL 
TOP 
BOTTOM 
CENTER_VERTICAL 
var Gravity
strong

Gravity for docking elements in ListView.

Enumerator
LEFT 
RIGHT 
CENTER_HORIZONTAL 
TOP 
BOTTOM 
CENTER_VERTICAL 
local Gravity
strong

Gravity for docking elements in ListView.

Enumerator
LEFT 
RIGHT 
CENTER_HORIZONTAL 
TOP 
BOTTOM 
CENTER_VERTICAL 
enum HorizontalEdge
strong

Horizontal dock position type.

Enumerator
None 
Left 
Right 
Center 
var HorizontalEdge
strong

Horizontal dock position type.

Enumerator
None 
Left 
Right 
Center 
local HorizontalEdge
strong

Horizontal dock position type.

Enumerator
None 
Left 
Right 
Center 
enum InputFlag
strong

The EditBox::InputFlag defines how the input text is displayed/formatted.

Enumerator
PASSWORD 

Indicates that the text entered is confidential data that should be obscured whenever possible.

This implies EDIT_BOX_INPUT_FLAG_SENSITIVE.

SENSITIVE 

Indicates that the text entered is sensitive data that the implementation must never store into a dictionary or table for use in predictive, auto-completing, or other accelerated input schemes.

A credit card number is an example of sensitive data.

INITIAL_CAPS_WORD 

This flag is a hint to the implementation that during text editing, the initial letter of each word should be capitalized.

INITIAL_CAPS_SENTENCE 

This flag is a hint to the implementation that during text editing, the initial letter of each sentence should be capitalized.

INTIAL_CAPS_ALL_CHARACTERS 

Capitalize all characters automatically.

var InputFlag
strong

The EditBox::InputFlag defines how the input text is displayed/formatted.

Enumerator
PASSWORD 

Indicates that the text entered is confidential data that should be obscured whenever possible.

This implies EDIT_BOX_INPUT_FLAG_SENSITIVE.

SENSITIVE 

Indicates that the text entered is sensitive data that the implementation must never store into a dictionary or table for use in predictive, auto-completing, or other accelerated input schemes.

A credit card number is an example of sensitive data.

INITIAL_CAPS_WORD 

This flag is a hint to the implementation that during text editing, the initial letter of each word should be capitalized.

INITIAL_CAPS_SENTENCE 

This flag is a hint to the implementation that during text editing, the initial letter of each sentence should be capitalized.

INTIAL_CAPS_ALL_CHARACTERS 

Capitalize all characters automatically.

local InputFlag
strong

The EditBox::InputFlag defines how the input text is displayed/formatted.

Enumerator
PASSWORD 

Indicates that the text entered is confidential data that should be obscured whenever possible.

This implies EDIT_BOX_INPUT_FLAG_SENSITIVE.

SENSITIVE 

Indicates that the text entered is sensitive data that the implementation must never store into a dictionary or table for use in predictive, auto-completing, or other accelerated input schemes.

A credit card number is an example of sensitive data.

INITIAL_CAPS_WORD 

This flag is a hint to the implementation that during text editing, the initial letter of each word should be capitalized.

INITIAL_CAPS_SENTENCE 

This flag is a hint to the implementation that during text editing, the initial letter of each sentence should be capitalized.

INTIAL_CAPS_ALL_CHARACTERS 

Capitalize all characters automatically.

enum InputMode
strong

The EditBox::InputMode defines the type of text that the user is allowed to enter.

Enumerator
ANY 

The user is allowed to enter any text, including line breaks.

EMAIL_ADDRESS 

The user is allowed to enter an e-mail address.

NUMERIC 

The user is allowed to enter an integer value.

PHONE_NUMBER 

The user is allowed to enter a phone number.

URL 

The user is allowed to enter a URL.

DECIMAL 

The user is allowed to enter a real number value.

This extends kEditBoxInputModeNumeric by allowing a decimal point.

SINGLE_LINE 

The user is allowed to enter any text, except for line breaks.

var InputMode
strong

The EditBox::InputMode defines the type of text that the user is allowed to enter.

Enumerator
ANY 

The user is allowed to enter any text, including line breaks.

EMAIL_ADDRESS 

The user is allowed to enter an e-mail address.

NUMERIC 

The user is allowed to enter an integer value.

PHONE_NUMBER 

The user is allowed to enter a phone number.

URL 

The user is allowed to enter a URL.

DECIMAL 

The user is allowed to enter a real number value.

This extends kEditBoxInputModeNumeric by allowing a decimal point.

SINGLE_LINE 

The user is allowed to enter any text, except for line breaks.

local InputMode
strong

The EditBox::InputMode defines the type of text that the user is allowed to enter.

Enumerator
ANY 

The user is allowed to enter any text, including line breaks.

EMAIL_ADDRESS 

The user is allowed to enter an e-mail address.

NUMERIC 

The user is allowed to enter an integer value.

PHONE_NUMBER 

The user is allowed to enter a phone number.

URL 

The user is allowed to enter a URL.

DECIMAL 

The user is allowed to enter a real number value.

This extends kEditBoxInputModeNumeric by allowing a decimal point.

SINGLE_LINE 

The user is allowed to enter any text, except for line breaks.

enum KeyboardReturnType
strong

The popup keyboard return type.

Enumerator
DEFAULT 
DONE 
SEND 
SEARCH 
GO 
var KeyboardReturnType
strong

The popup keyboard return type.

Enumerator
DEFAULT 
DONE 
SEND 
SEARCH 
GO 
local KeyboardReturnType
strong

The popup keyboard return type.

Enumerator
DEFAULT 
DONE 
SEND 
SEARCH 
GO 
enum LinearGravity
strong

Linear gravity.

Enumerator
NONE 
LEFT 
TOP 
RIGHT 
BOTTOM 
CENTER_VERTICAL 
CENTER_HORIZONTAL 
var LinearGravity
strong

Linear gravity.

Enumerator
NONE 
LEFT 
TOP 
RIGHT 
BOTTOM 
CENTER_VERTICAL 
CENTER_HORIZONTAL 
local LinearGravity
strong

Linear gravity.

Enumerator
NONE 
LEFT 
TOP 
RIGHT 
BOTTOM 
CENTER_VERTICAL 
CENTER_HORIZONTAL 
enum ListViewEventType

ListView click item event type.

Enumerator
LISTVIEW_ONSELECTEDITEM_START 
LISTVIEW_ONSELECTEDITEM_END 
var ListViewEventType

ListView click item event type.

Enumerator
LISTVIEW_ONSELECTEDITEM_START 
LISTVIEW_ONSELECTEDITEM_END 
local ListViewEventType

ListView click item event type.

Enumerator
LISTVIEW_ONSELECTEDITEM_START 
LISTVIEW_ONSELECTEDITEM_END 
enum PageViewEventType

PageView page turn event type.

Deprecated:
Use PageView::EventType instead.
Enumerator
PAGEVIEW_EVENT_TURNING 
var PageViewEventType

PageView page turn event type.

Deprecated:
Use PageView::EventType instead.
Enumerator
PAGEVIEW_EVENT_TURNING 
local PageViewEventType

PageView page turn event type.

Deprecated:
Use PageView::EventType instead.
Enumerator
PAGEVIEW_EVENT_TURNING 
enum PositionType
strong

Widget position type for layout.

Enumerator
ABSOLUTE 
PERCENT 
var PositionType
strong

Widget position type for layout.

Enumerator
ABSOLUTE 
PERCENT 
local PositionType
strong

Widget position type for layout.

Enumerator
ABSOLUTE 
PERCENT 
enum RelativeAlign
strong

Relative Alignment type.

Enumerator
NONE 
PARENT_TOP_LEFT 
PARENT_TOP_CENTER_HORIZONTAL 
PARENT_TOP_RIGHT 
PARENT_LEFT_CENTER_VERTICAL 
CENTER_IN_PARENT 
PARENT_RIGHT_CENTER_VERTICAL 
PARENT_LEFT_BOTTOM 
PARENT_BOTTOM_CENTER_HORIZONTAL 
PARENT_RIGHT_BOTTOM 
LOCATION_ABOVE_LEFTALIGN 
LOCATION_ABOVE_CENTER 
LOCATION_ABOVE_RIGHTALIGN 
LOCATION_LEFT_OF_TOPALIGN 
LOCATION_LEFT_OF_CENTER 
LOCATION_LEFT_OF_BOTTOMALIGN 
LOCATION_RIGHT_OF_TOPALIGN 
LOCATION_RIGHT_OF_CENTER 
LOCATION_RIGHT_OF_BOTTOMALIGN 
LOCATION_BELOW_LEFTALIGN 
LOCATION_BELOW_CENTER 
LOCATION_BELOW_RIGHTALIGN 
var RelativeAlign
strong

Relative Alignment type.

Enumerator
NONE 
PARENT_TOP_LEFT 
PARENT_TOP_CENTER_HORIZONTAL 
PARENT_TOP_RIGHT 
PARENT_LEFT_CENTER_VERTICAL 
CENTER_IN_PARENT 
PARENT_RIGHT_CENTER_VERTICAL 
PARENT_LEFT_BOTTOM 
PARENT_BOTTOM_CENTER_HORIZONTAL 
PARENT_RIGHT_BOTTOM 
LOCATION_ABOVE_LEFTALIGN 
LOCATION_ABOVE_CENTER 
LOCATION_ABOVE_RIGHTALIGN 
LOCATION_LEFT_OF_TOPALIGN 
LOCATION_LEFT_OF_CENTER 
LOCATION_LEFT_OF_BOTTOMALIGN 
LOCATION_RIGHT_OF_TOPALIGN 
LOCATION_RIGHT_OF_CENTER 
LOCATION_RIGHT_OF_BOTTOMALIGN 
LOCATION_BELOW_LEFTALIGN 
LOCATION_BELOW_CENTER 
LOCATION_BELOW_RIGHTALIGN 
local RelativeAlign
strong

Relative Alignment type.

Enumerator
NONE 
PARENT_TOP_LEFT 
PARENT_TOP_CENTER_HORIZONTAL 
PARENT_TOP_RIGHT 
PARENT_LEFT_CENTER_VERTICAL 
CENTER_IN_PARENT 
PARENT_RIGHT_CENTER_VERTICAL 
PARENT_LEFT_BOTTOM 
PARENT_BOTTOM_CENTER_HORIZONTAL 
PARENT_RIGHT_BOTTOM 
LOCATION_ABOVE_LEFTALIGN 
LOCATION_ABOVE_CENTER 
LOCATION_ABOVE_RIGHTALIGN 
LOCATION_LEFT_OF_TOPALIGN 
LOCATION_LEFT_OF_CENTER 
LOCATION_LEFT_OF_BOTTOMALIGN 
LOCATION_RIGHT_OF_TOPALIGN 
LOCATION_RIGHT_OF_CENTER 
LOCATION_RIGHT_OF_BOTTOMALIGN 
LOCATION_BELOW_LEFTALIGN 
LOCATION_BELOW_CENTER 
LOCATION_BELOW_RIGHTALIGN 
enum ScrollviewEventType

Scrollview scroll event type.

Deprecated:
use
See also
ScrollView::EventType instead.
Enumerator
SCROLLVIEW_EVENT_SCROLL_TO_TOP 
SCROLLVIEW_EVENT_SCROLL_TO_BOTTOM 
SCROLLVIEW_EVENT_SCROLL_TO_LEFT 
SCROLLVIEW_EVENT_SCROLL_TO_RIGHT 
SCROLLVIEW_EVENT_SCROLLING 
SCROLLVIEW_EVENT_BOUNCE_TOP 
SCROLLVIEW_EVENT_BOUNCE_BOTTOM 
SCROLLVIEW_EVENT_BOUNCE_LEFT 
SCROLLVIEW_EVENT_BOUNCE_RIGHT 
var ScrollviewEventType

Scrollview scroll event type.

Deprecated:
use
See also
ScrollView::EventType instead.
Enumerator
SCROLLVIEW_EVENT_SCROLL_TO_TOP 
SCROLLVIEW_EVENT_SCROLL_TO_BOTTOM 
SCROLLVIEW_EVENT_SCROLL_TO_LEFT 
SCROLLVIEW_EVENT_SCROLL_TO_RIGHT 
SCROLLVIEW_EVENT_SCROLLING 
SCROLLVIEW_EVENT_BOUNCE_TOP 
SCROLLVIEW_EVENT_BOUNCE_BOTTOM 
SCROLLVIEW_EVENT_BOUNCE_LEFT 
SCROLLVIEW_EVENT_BOUNCE_RIGHT 
local ScrollviewEventType

Scrollview scroll event type.

Deprecated:
use
See also
ScrollView::EventType instead.
Enumerator
SCROLLVIEW_EVENT_SCROLL_TO_TOP 
SCROLLVIEW_EVENT_SCROLL_TO_BOTTOM 
SCROLLVIEW_EVENT_SCROLL_TO_LEFT 
SCROLLVIEW_EVENT_SCROLL_TO_RIGHT 
SCROLLVIEW_EVENT_SCROLLING 
SCROLLVIEW_EVENT_BOUNCE_TOP 
SCROLLVIEW_EVENT_BOUNCE_BOTTOM 
SCROLLVIEW_EVENT_BOUNCE_LEFT 
SCROLLVIEW_EVENT_BOUNCE_RIGHT 
enum SizeType
strong

Widget size type for layout.

Enumerator
ABSOLUTE 
PERCENT 
var SizeType
strong

Widget size type for layout.

Enumerator
ABSOLUTE 
PERCENT 
local SizeType
strong

Widget size type for layout.

Enumerator
ABSOLUTE 
PERCENT 
enum SliderEventType
Enumerator
SLIDER_PERCENTCHANGED 
var SliderEventType
Enumerator
SLIDER_PERCENTCHANGED 
local SliderEventType
Enumerator
SLIDER_PERCENTCHANGED 
enum Source
strongprotected
Enumerator
FILENAME 
URL 
var Source
strongprotected
Enumerator
FILENAME 
URL 
local Source
strongprotected
Enumerator
FILENAME 
URL 
enum State
strong

Builtin shader state.

Currenly support Normal and Gray state.

Enumerator
NORMAL 
GRAY 
var State
strong

Builtin shader state.

Currenly support Normal and Gray state.

Enumerator
NORMAL 
GRAY 
local State
strong

Builtin shader state.

Currenly support Normal and Gray state.

Enumerator
NORMAL 
GRAY 
enum TextFiledEventType

TextField event type.

Deprecated:
Use
See also
TextField::EventType instead.
Enumerator
TEXTFIELD_EVENT_ATTACH_WITH_IME 
TEXTFIELD_EVENT_DETACH_WITH_IME 
TEXTFIELD_EVENT_INSERT_TEXT 
TEXTFIELD_EVENT_DELETE_BACKWARD 
var TextFiledEventType

TextField event type.

Deprecated:
Use
See also
TextField::EventType instead.
Enumerator
TEXTFIELD_EVENT_ATTACH_WITH_IME 
TEXTFIELD_EVENT_DETACH_WITH_IME 
TEXTFIELD_EVENT_INSERT_TEXT 
TEXTFIELD_EVENT_DELETE_BACKWARD 
local TextFiledEventType

TextField event type.

Deprecated:
Use
See also
TextField::EventType instead.
Enumerator
TEXTFIELD_EVENT_ATTACH_WITH_IME 
TEXTFIELD_EVENT_DETACH_WITH_IME 
TEXTFIELD_EVENT_INSERT_TEXT 
TEXTFIELD_EVENT_DELETE_BACKWARD 
enum TextureResType
strong

Texture resource type.

  • LOCAL: It means the texture is loaded from image.
  • PLIST: It means the texture is loaded from texture atlas.
Enumerator
LOCAL 
PLIST 
var TextureResType
strong

Texture resource type.

  • LOCAL: It means the texture is loaded from image.
  • PLIST: It means the texture is loaded from texture atlas.
Enumerator
LOCAL 
PLIST 
local TextureResType
strong

Texture resource type.

  • LOCAL: It means the texture is loaded from image.
  • PLIST: It means the texture is loaded from texture atlas.
Enumerator
LOCAL 
PLIST 
enum TouchDirection
strong

Touch direction type.

Enumerator
LEFT 
RIGHT 
var TouchDirection
strong

Touch direction type.

Enumerator
LEFT 
RIGHT 
local TouchDirection
strong

Touch direction type.

Enumerator
LEFT 
RIGHT 
enum TouchEventType

Touch event type.

Deprecated:
use Widget::TouchEventType instead
Enumerator
TOUCH_EVENT_BEGAN 
TOUCH_EVENT_MOVED 
TOUCH_EVENT_ENDED 
TOUCH_EVENT_CANCELED 
var TouchEventType

Touch event type.

Deprecated:
use Widget::TouchEventType instead
Enumerator
TOUCH_EVENT_BEGAN 
TOUCH_EVENT_MOVED 
TOUCH_EVENT_ENDED 
TOUCH_EVENT_CANCELED 
local TouchEventType

Touch event type.

Deprecated:
use Widget::TouchEventType instead
Enumerator
TOUCH_EVENT_BEGAN 
TOUCH_EVENT_MOVED 
TOUCH_EVENT_ENDED 
TOUCH_EVENT_CANCELED 
enum TouchEventType
strong

Touch event type.

Enumerator
BEGAN 
MOVED 
ENDED 
CANCELED 
var TouchEventType
strong

Touch event type.

Enumerator
BEGAN 
MOVED 
ENDED 
CANCELED 
local TouchEventType
strong

Touch event type.

Enumerator
BEGAN 
MOVED 
ENDED 
CANCELED 
enum Type
strong

Rich element type.

Enumerator
TEXT 
IMAGE 
CUSTOM 
var Type
strong

Rich element type.

Enumerator
TEXT 
IMAGE 
CUSTOM 
local Type
strong

Rich element type.

Enumerator
TEXT 
IMAGE 
CUSTOM 
enum Type
strong

Type Text type.

Enumerator
SYSTEM 
TTF 
var Type
strong

Type Text type.

Enumerator
SYSTEM 
TTF 
local Type
strong

Type Text type.

Enumerator
SYSTEM 
TTF 
enum Type
strong

Layout type, default is ABSOLUTE.

Enumerator
ABSOLUTE 
VERTICAL 
HORIZONTAL 
RELATIVE 
var Type
strong

Layout type, default is ABSOLUTE.

Enumerator
ABSOLUTE 
VERTICAL 
HORIZONTAL 
RELATIVE 
local Type
strong

Layout type, default is ABSOLUTE.

Enumerator
ABSOLUTE 
VERTICAL 
HORIZONTAL 
RELATIVE 
enum Type
strong

Layout parameter type.

There are mainly two types:

  • Linear: Elements will be arranged by margin.
  • Relative: Elements will be arranged by margin and relative widget name.
Enumerator
NONE 
LINEAR 
RELATIVE 
var Type
strong

Layout parameter type.

There are mainly two types:

  • Linear: Elements will be arranged by margin.
  • Relative: Elements will be arranged by margin and relative widget name.
Enumerator
NONE 
LINEAR 
RELATIVE 
local Type
strong

Layout parameter type.

There are mainly two types:

  • Linear: Elements will be arranged by margin.
  • Relative: Elements will be arranged by margin and relative widget name.
Enumerator
NONE 
LINEAR 
RELATIVE 
enum VerticalEdge
strong

Vertical dock position type.

Enumerator
None 
Bottom 
Top 
Center 
var VerticalEdge
strong

Vertical dock position type.

Enumerator
None 
Bottom 
Top 
Center 
local VerticalEdge
strong

Vertical dock position type.

Enumerator
None 
Bottom 
Top 
Center 
enum VerticalFillOrder
strong
Enumerator
TOP_DOWN 
BOTTOM_UP 
var VerticalFillOrder
strong
Enumerator
TOP_DOWN 
BOTTOM_UP 
local VerticalFillOrder
strong
Enumerator
TOP_DOWN 
BOTTOM_UP