RichElement Class Reference

Rich text element base class. More...

#include <UIRichText.h>

Inherits Object.

Inherited by RichElementCustomNode, RichElementImage, RichElementNewLine, and RichElementText.

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

Public Member Functions
bool	init (int tag, const Color3B &color, uint8_t opacity)
	Initialize a rich element with different arguments.
Public Member Functions inherited from Object
void	retain ()
	Retains the ownership.
void	release ()
	Releases the ownership immediately.
Object *	autorelease ()
	Releases the ownership sometime soon automatically.
unsigned int	getReferenceCount () const
	Returns the Object's current reference count.
virtual	~Object ()
	Destructor.

Additional Inherited Members
Public Attributes inherited from Object
unsigned int	_ID
	object id, ScriptSupport need public _ID
int	_luaID
	Lua reference id.

Detailed Description

Rich text element base class.

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

Member Enumeration Documentation

Type

enum class Type

strong

Rich element type.

Enumerator
TEXT	RichElementText.
IMAGE	RichElementImage.
CUSTOM	RichElementCustomNode.
NEWLINE	RichElementNewLine.

Member Function Documentation

init()

bool init	(	int	tag,
		const Color3B &	color,
		uint8_t	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.

---

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

• UIRichText.h