RichElementImage Class Reference

Rich element for displaying images. More...

#include <UIRichText.h>

Inherits RichElement.

Public Member Functions
	RichElementImage ()
	Default constructor.
bool	init (int tag, const Color3B &color, uint8_t opacity, std::string_view filePath, std::string_view url="", Widget::TextureResType texType=Widget::TextureResType::LOCAL, std::string_view id=""sv)
	Initialize a RichElementImage with various arguments.
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 RichElementImage *	create (int tag, const Color3B &color, uint8_t opacity, std::string_view filePath, std::string_view url="", Widget::TextureResType texType=Widget::TextureResType::LOCAL, std::string_view id=""sv)
	Create a RichElementImage 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 displaying images.

Constructor & Destructor Documentation

RichElementImage()

RichElementImage ( )

inline

Default constructor.

@js ctor @lua new

Member Function Documentation

init()

bool init	(	int	tag,
		const Color3B &	color,
		uint8_t	opacity,
		std::string_view	filePath,
		std::string_view	url = "",
		Widget::TextureResType	texType = Widget::TextureResType::LOCAL,
		std::string_view	id = ""sv )

Initialize a RichElementImage with various arguments.

Parameters

tag	A integer tag value.
color	A color in Color3B.
opacity	A opacity in GLubyte.
filePath	A image file name.
url	uniform resource locator
texType	texture type, may be a valid file path, or a sprite frame name
id	ID of element

Returns

True if initialize success, false otherwise.

create()

static RichElementImage * create ( int tag, const Color3B & color, uint8_t opacity, std::string_view filePath, std::string_view url = "", Widget::TextureResType texType = Widget::TextureResType::LOCAL, std::string_view id = ""sv )

static

Create a RichElementImage with various arguments.

Parameters

tag	A integer tag value.
color	A color in Color3B.
opacity	A opacity in GLubyte.
filePath	A image file name.
url	uniform resource locator
texType	texture type, may be a valid file path, or a sprite frame name
id	ID of element

Returns

A RichElementImage instance.

---

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

• UIRichText.h