RichElement Class Reference

Rich text element base class. More...

#include <UIRichText.h>

Inheritance diagram for RichElement:

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

Public Member Functions
	RichElement ()
	Default constructor. More...
	RichElement ()
	Default constructor. More...
	RichElement ()
	Default constructor. More...
virtual	~RichElement ()
	Default destructor. More...
local	~RichElement ()
	Default destructor. More...
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...
Ref *	autorelease ()
	Releases the ownership sometime soon automatically. More...
unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...
virtual	~Ref ()
	Destructor. More...

Protected Attributes
Type	_type
int	_tag
var	_tag
local	_tag
Color3B	_color
var	_color
local	_color
GLubyte	_opacity
var	_opacity
local	_opacity
Protected Attributes inherited from Ref
unsigned int	_referenceCount
	count of references More...
local	_referenceCount
	count of references More...

Friends
class	RichText

Additional Inherited Members
Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...
	Ref ()
	Constructor. More...

Detailed Description

Rich text element base class.

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

Constructor & Destructor Documentation

RichElement ( )

inline

Default constructor.

var RichElement ( )

inline

Default constructor.

local RichElement ( )

inline

Default constructor.

virtual ~RichElement ( )

inlinevirtual

Default destructor.

var ~RichElement ( )

inlinevirtual

Default destructor.

local ~RichElement ( )

inlinevirtual

Default destructor.

Member Function Documentation

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

Initialize a rich element with different arguments.

Parameters

tag	A integer tag value.
color	A color in

See also

Color3B.

Parameters

opacity

A 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

tag	A integer tag value.
color	A color in

See also

Color3B.

Parameters

opacity

A 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

tag	A integer tag value.
color	A color in

See also

Color3B.

Parameters

opacity

A opacity value in GLubyte.

Returns

True if initialize success, false otherwise.

Friends And Related Function Documentation

friend class RichText

friend

var RichText

friend

local RichText

friend

Member Data Documentation

Color3B _color

protected

var _color

protected

local _color

protected

GLubyte _opacity

protected

var _opacity

protected

local _opacity

protected

int _tag

protected

var _tag

protected

local _tag

protected

Type _type

protected

var _type

protected

local _type

protected

---

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

• /Users/minggo/SourceCode/cocos2d-x/cocos/ui/UIRichText.h