RichElementImage Class Reference

Rich element for displaying images. More...

Inherits RichElement.

Public Member Functions
	RichElementImage ()
	Default constructor. More...
virtual	~RichElementImage ()
	Default destructor. More...
bool	init (int tag, const Color3B &color, uint8_t opacity, const std::string &filePath, const std::string &url="", Widget::TextureResType texType=Widget::TextureResType::LOCAL)
	Initialize a RichElementImage with various arguments. More...
Public Member Functions inherited from RichElement
	RichElement ()
	Default constructor. More...
virtual	~RichElement ()
	Default destructor. More...
bool	init (int tag, const Color3B &color, uint8_t 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 RichElementImage *	create (int tag, const Color3B &color, uint8_t opacity, const std::string &filePath, const std::string &url="", Widget::TextureResType texType=Widget::TextureResType::LOCAL)
	Create a RichElementImage with various arguments. More...

Additional Inherited Members
Public Types inherited from RichElement
enum	Type { TEXT, IMAGE, CUSTOM, NEWLINE }
	Rich element type. More...
Public Attributes inherited from Ref
unsigned int	_ID
	object id, ScriptSupport need public _ID
int	_luaID
	Lua reference id.
void *	_scriptObject
	scriptObject, support for swift
bool	_rooted
	When true, it means that the object was already rooted.

Detailed Description

Rich element for displaying images.

Constructor & Destructor Documentation

RichElementImage()

RichElementImage ( )

inline

Default constructor.

@js ctor @lua new

~RichElementImage()

virtual ~RichElementImage ( )

inlinevirtual

Default destructor.

@js NA @lua NA

Member Function Documentation

init()

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

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

Returns

True if initialize success, false otherwise.

create()

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

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

Returns

A RichElementImage instance.

---

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

• UIRichText.h