Cocos2d-x  v3.10
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups
UI Nodes

Namespaces

 cocos2d
 Copyright 2013 BlackBerry Inc.
 

Classes

class  TextFieldDelegate
 A input protocol for TextField. More...
 
class  TextFieldTTF
 A simple text input field with TTF font. More...
 
class  AbstractCheckButton
 AbstractCheckButton is a specific type of two-states button that can be either checked or unchecked. 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
 Helper class for traversing children in widget tree. More...
 
class  ImageView
 A widget to display images. 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  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 & right and up & down through pages of data. More...
 
class  RadioButton
 RadioButton is a specific type of two-states button that is similar to CheckBox. More...
 
class  RadioButtonGroup
 RadioButtonGroup groups designated radio buttons to make them interact to each other. 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  RichElementNewLine
 Rich element for new line. 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  ScrollViewBar
 Scroll bar being attached to ScrollView layout container. 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  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 event type, there are two type here: More...
 
enum  EventType
 CheckBox event type, currently only "selected" and "unselected" event are cared.
 
enum  KeyboardReturnType
 The popup keyboard return type.
 
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,
  INITIAL_CAPS_ALL_CHARACTERS
}
 The EditBox::InputFlag defines how the input text is displayed/formatted. More...
 
enum  Type
 Layout type, default is ABSOLUTE.
 
enum  ClippingType
 Clipping Type, default is STENCIL.
 
enum  BackGroundColorType
 Background color type, default is NONE.
 
enum  HorizontalEdge
 Horizontal dock position type.
 
enum  VerticalEdge
 Vertical dock position type.
 
enum  Type
 Layout parameter type. More...
 
enum  LinearGravity
 Linear gravity.
 
enum  RelativeAlign
 Relative Alignment type.
 
enum  ListViewEventType
 ListView click item event type.
 
enum  Gravity
 Gravity for docking elements in ListView.
 
enum  EventType
 ListView element item click event.
 
enum  MagneticType
 ListView supports magnetic scroll. More...
 
enum  Direction
 Loading bar progress direction.
 
enum  PageViewEventType
 PageView page turn event type. More...
 
enum  EventType
 Page turn event tpye.
 
enum  TouchDirection
 Touch direction type.
 
enum  EventType
 Radio button event types.
 
enum  EventType
 Radio button group event types.
 
enum  Type
 Rich element type.
 
enum  State
 Builtin shader state. More...
 
enum  ScrollviewEventType
 Scrollview scroll event type.
 
enum  Direction { NONE, VERTICAL, HORIZONTAL, BOTH }
 ScrollView scroll direction type. More...
 
enum  EventType
 Scrollview scroll event type.
 
enum  EventType
 Slider event type.
 
enum  Type
 Type Text type.
 
enum  TextFiledEventType
 TextField event type. More...
 
enum  EventType
 TextField event type.
 
enum  EventType
 Videoplayer play event type.
 
enum  TouchEventType
 Touch event type.
 
enum  FocusDirection
 Widget focus direction.
 
enum  PositionType
 Widget position type for layout.
 
enum  SizeType
 Widget size type for layout.
 
enum  TouchEventType
 Touch event type.
 
enum  TextureResType
 Texture resource type. More...
 
enum  BrightStyle
 Widget bright style.
 

Detailed Description

Enumeration Type Documentation

enum CheckBoxEventType

Checkbox event type, there are two type here:

  • selected state
  • unselected state
var CheckBoxEventType

Checkbox event type, there are two type here:

  • selected state
  • unselected state
local CheckBoxEventType

Checkbox event type, there are two type here:

  • selected state
  • unselected state
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 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.

INITIAL_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.

INITIAL_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.

INITIAL_CAPS_ALL_CHARACTERS 

Capitalize all characters automatically.

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.
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.
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.
enum MagneticType
strong

ListView supports magnetic scroll.

With CENTER type, ListView tries to align its items in center of current view. With BOTH_END type, ListView tries to align its items in left or right end if it is horizontal, top or bottom in vertical. The aligning side (left or right, top or bottom) is determined by user's scroll direction.

var MagneticType
strong

ListView supports magnetic scroll.

With CENTER type, ListView tries to align its items in center of current view. With BOTH_END type, ListView tries to align its items in left or right end if it is horizontal, top or bottom in vertical. The aligning side (left or right, top or bottom) is determined by user's scroll direction.

local MagneticType
strong

ListView supports magnetic scroll.

With CENTER type, ListView tries to align its items in center of current view. With BOTH_END type, ListView tries to align its items in left or right end if it is horizontal, top or bottom in vertical. The aligning side (left or right, top or bottom) is determined by user's scroll direction.

enum PageViewEventType

PageView page turn event type.

var PageViewEventType

PageView page turn event type.

local PageViewEventType

PageView page turn event type.

enum State
strong

Builtin shader state.

Currenly support Normal and Gray state.

var State
strong

Builtin shader state.

Currenly support Normal and Gray state.

local State
strong

Builtin shader state.

Currenly support Normal and Gray state.

enum Direction
strong

ScrollView scroll direction type.

Enumerator
NONE 

User can not scroll the view.

VERTICAL 

User can scroll the view vertically.

HORIZONTAL 

User can scroll the view horizontally.

BOTH 

User can scroll the view both horizontally and vertically.

var Direction
strong

ScrollView scroll direction type.

Enumerator
NONE 

User can not scroll the view.

VERTICAL 

User can scroll the view vertically.

HORIZONTAL 

User can scroll the view horizontally.

BOTH 

User can scroll the view both horizontally and vertically.

local Direction
strong

ScrollView scroll direction type.

Enumerator
NONE 

User can not scroll the view.

VERTICAL 

User can scroll the view vertically.

HORIZONTAL 

User can scroll the view horizontally.

BOTH 

User can scroll the view both horizontally and vertically.

enum TextFiledEventType

TextField event type.

var TextFiledEventType

TextField event type.

local TextFiledEventType

TextField event type.

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.
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.
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.