RichElementNewLine Class Reference

Rich element for new line. More...

#include <UIRichText.h>

Inherits RichElement.

Public Member Functions
	RichElementNewLine (int quantity=1)
	Default constructor.
	~RichElementNewLine () override=default
	Default destructor.
Public Member Functions inherited from RichElement
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.

Static Public Member Functions
static RichElementNewLine *	create (int tag, const Color3B &color, uint8_t opacity)
	Create a RichElementNewLine with various arguments.
static RichElementNewLine *	create (int tag, int quantity, const Color3B &color, uint8_t opacity)
	Create a RichElementNewLine with various arguments.

Additional Inherited Members
Public Types inherited from RichElement
enum class	Type { TEXT , IMAGE , CUSTOM , NEWLINE }
	Rich element type. More...
Public Attributes inherited from Object
unsigned int	_ID
	object id, ScriptSupport need public _ID
int	_luaID
	Lua reference id.

Detailed Description

Rich element for new line.

Constructor & Destructor Documentation

RichElementNewLine()

RichElementNewLine ( int quantity = 1 )

inline

Default constructor.

@js ctor @lua new

~RichElementNewLine()

~RichElementNewLine ( )

overridedefault

Default destructor.

@js NA @lua NA

Member Function Documentation

create() [1/2]

static RichElementNewLine * create ( int tag, const Color3B & color, uint8_t opacity )

static

Create a RichElementNewLine with various arguments.

Parameters

tag	A integer tag value.
color	A color in Color3B.
opacity	A opacity in GLubyte.

Returns

A RichElementNewLine instance.

create() [2/2]

static RichElementNewLine * create ( int tag, int quantity, const Color3B & color, uint8_t opacity )

static

Create a RichElementNewLine with various arguments.

Parameters

tag	A integer tag value.
quantity	Number of new lines to add
color	A color in Color3B.
opacity	A opacity in GLubyte.

Returns

A RichElementNewLine instance.

---

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

• UIRichText.h