RichElementText Class Reference

Rich element for displaying text. More...

#include <UIRichText.h>

Inheritance diagram for RichElementText:

Public Member Functions
	RichElementText ()
	Default constructor. More...
virtual	~RichElementText ()
	Default destructor. More...
local	~RichElementText ()
	Default destructor. More...
bool	init (int tag, const Color3B &color, GLubyte opacity, const std::string &text, const std::string &fontName, float fontSize)
	Initialize a RichElementText with various arguments. More...
var	init ( var tag, var color, var opacity, var text, var fontName, var fontSize)
	Initialize a RichElementText with various arguments. More...
local	init ( local tag, local color, local opacity, local text, local fontName, local fontSize)
	Initialize a RichElementText with various arguments. More...
Public Member Functions inherited from RichElement
	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...

Static Public Member Functions
static RichElementText *	create (int tag, const Color3B &color, GLubyte opacity, const std::string &text, const std::string &fontName, float fontSize)
	Create a RichElementText with various arguments. More...
var	create ( var tag, var color, var opacity, var text, var fontName, var fontSize)
	Create a RichElementText with various arguments. More...
local	create ( local tag, local color, local opacity, local text, local fontName, local fontSize)
	Create a RichElementText with various arguments. More...

Protected Attributes
std::string	_text
std::string	_fontName
var	_fontName
local	_fontName
float	_fontSize
var	_fontSize
local	_fontSize
Protected Attributes inherited from RichElement
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
Public Types inherited from RichElement
enum	Type { TEXT, IMAGE, CUSTOM }
	Rich element type. More...
Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...
	Ref ()
	Constructor. More...

Detailed Description

Rich element for displaying text.

Constructor & Destructor Documentation

RichElementText ( )

inline

Default constructor.

var RichElementText ( )

inline

Default constructor.

local RichElementText ( )

inline

Default constructor.

virtual ~RichElementText ( )

inlinevirtual

Default destructor.

var ~RichElementText ( )

inlinevirtual

Default destructor.

local ~RichElementText ( )

inlinevirtual

Default destructor.

Member Function Documentation

static RichElementText* create ( int  tag, const Color3B &  color, GLubyte  opacity, const std::string &  text, const std::string &  fontName, float  fontSize  )

static

Create a RichElementText with various arguments.

Parameters

tag	A integer tag value.
color	A color in Color3B.
opacity	A opacity in GLubyte.
text	Content string.
fontName	Content font name.
fontSize	Content font size.

Returns

RichElementText instance.

var create ( var  tag, var  color, var  opacity, var  text, var  fontName, var  fontSize  )

static

Create a RichElementText with various arguments.

Parameters

tag	A integer tag value.
color	A color in Color3B.
opacity	A opacity in GLubyte.
text	Content string.
fontName	Content font name.
fontSize	Content font size.

Returns

RichElementText instance.

local create ( local  tag, local  color, local  opacity, local  text, local  fontName, local  fontSize  )

static

Create a RichElementText with various arguments.

Parameters

tag	A integer tag value.
color	A color in Color3B.
opacity	A opacity in GLubyte.
text	Content string.
fontName	Content font name.
fontSize	Content font size.

Returns

RichElementText instance.

bool init	(	int	tag,
		const Color3B &	color,
		GLubyte	opacity,
		const std::string &	text,
		const std::string &	fontName,
		float	fontSize
	)

Initialize a RichElementText with various arguments.

Parameters

tag	A integer tag value.
color	A color in Color3B.
opacity	A opacity in GLubyte.
text	Content string.
fontName	Content font name.
fontSize	Content font size.

Returns

True if initialize scucess, false otherwise.

var init	(	var	tag,
		var	color,
		var	opacity,
		var	text,
		var	fontName,
		var	fontSize
	)

Initialize a RichElementText with various arguments.

Parameters

tag	A integer tag value.
color	A color in Color3B.
opacity	A opacity in GLubyte.
text	Content string.
fontName	Content font name.
fontSize	Content font size.

Returns

True if initialize scucess, false otherwise.

local init	(	local	tag,
		local	color,
		local	opacity,
		local	text,
		local	fontName,
		local	fontSize
	)

Initialize a RichElementText with various arguments.

Parameters

tag	A integer tag value.
color	A color in Color3B.
opacity	A opacity in GLubyte.
text	Content string.
fontName	Content font name.
fontSize	Content font size.

Returns

True if initialize scucess, false otherwise.

Friends And Related Function Documentation

friend class RichText

friend

var RichText

friend

local RichText

friend

Member Data Documentation

std::string _fontName

protected

var _fontName

protected

local _fontName

protected

float _fontSize

protected

var _fontSize

protected

local _fontSize

protected

std::string _text

protected

var _text

protected

---

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

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