Cocos2d-x  v3.17
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
RichElement Class Reference

Rich text element base class. More...

Inherits Ref.

Inherited by RichElementCustomNode, RichElementImage, RichElementNewLine, and RichElementText.

Public Types

enum  Type { TEXT, IMAGE, CUSTOM, NEWLINE }
 Rich element type. More...
 

Public Member Functions

 RichElement ()
 Default constructor.
 
 ctor ()
 Default constructor.
 
 new ()
 Default constructor.
 
virtual ~RichElement ()
 Default destructor.
 
bool init (int tag, const Color3B &color, GLubyte opacity)
 Initialize a rich element with different arguments. More...
 
var init ( var tag, var color, var opacity)
 Initialize a rich element with different arguments. More...
 
local init ( local tag, local color, local opacity)
 Initialize a rich element with different arguments. More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
local release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
local getReferenceCount ()
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 Destructor. More...
 

Additional Inherited Members

- Public Attributes inherited from Ref
unsigned int _ID
 object id, ScriptSupport need public _ID
 
local _ID
 object id, ScriptSupport need public _ID
 
int _luaID
 Lua reference id.
 
local _luaID
 Lua reference id.
 
void * _scriptObject
 scriptObject, support for swift
 
local _scriptObject
 scriptObject, support for swift
 
bool _rooted
 When true, it means that the object was already rooted.
 
local _rooted
 When true, it means that the object was already rooted.
 

Detailed Description

Rich text element base class.

It defines the basic common properties for all rich text element.

Member Function Documentation

bool init ( int  tag,
const Color3B color,
GLubyte  opacity 
)

Initialize a rich element with different arguments.

Parameters
tagA integer tag value.
colorA color in
See also
Color3B.
Parameters
opacityA opacity value in GLubyte.
Returns
True if initialize success, false otherwise.
var init ( var  tag,
var  color,
var  opacity 
)

Initialize a rich element with different arguments.

Parameters
tagA integer tag value.
colorA color in
See also
Color3B.
Parameters
opacityA opacity value in GLubyte.
Returns
True if initialize success, false otherwise.
local init ( local  tag,
local  color,
local  opacity 
)

Initialize a rich element with different arguments.

Parameters
tagA integer tag value.
colorA color in
See also
Color3B.
Parameters
opacityA opacity value in GLubyte.
Returns
True if initialize success, false otherwise.

The documentation for this class was generated from the following file: