RichElementImage Class Reference

Rich element for displaying images. More...

#include <UIRichText.h>

Inheritance diagram for RichElementImage:

Public Member Functions
	RichElementImage ()
	Default constructor. More...
	RichElementImage ()
	Default constructor. More...
	RichElementImage ()
	Default constructor. More...
virtual	~RichElementImage ()
	Default destructor. More...
var	~RichElementImage ()
	Default destructor. More...
local	~RichElementImage ()
	Default destructor. More...
bool	init (int tag, const Color3B &color, GLubyte opacity, const std::string &filePath)
	Initialize a RichElementImage with various arguments. More...
var	init ( var tag, var color, var opacity, var filePath)
	Initialize a RichElementImage with various arguments. More...
local	init ( local tag, local color, local opacity, local filePath)
	Initialize a RichElementImage 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 RichElementImage *	create (int tag, const Color3B &color, GLubyte opacity, const std::string &filePath)
	Create a RichElementImage with various arguments. More...

Protected Attributes
std::string	_filePath
Rect	_textureRect
var	_textureRect
local	_textureRect
int	_textureType
var	_textureType
local	_textureType
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 images.

Constructor & Destructor Documentation

RichElementImage ( )

inline

Default constructor.

var RichElementImage ( )

inline

Default constructor.

local RichElementImage ( )

inline

Default constructor.

virtual ~RichElementImage ( )

inlinevirtual

Default destructor.

var ~RichElementImage ( )

inlinevirtual

Default destructor.

local ~RichElementImage ( )

inlinevirtual

Default destructor.

Member Function Documentation

static RichElementImage* create ( int  tag, const Color3B &  color, GLubyte  opacity, const std::string &  filePath  )

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.

Returns

A RichElementImage instance.

var create ( var  tag, var  color, var  opacity, var  filePath  )

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.

Returns

A RichElementImage instance.

local create ( local  tag, local  color, local  opacity, local  filePath  )

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.

Returns

A RichElementImage instance.

bool init	(	int	tag,
		const Color3B &	color,
		GLubyte	opacity,
		const std::string &	filePath
	)

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.

Returns

True if initialize success, false otherwise.

var init	(	var	tag,
		var	color,
		var	opacity,
		var	filePath
	)

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.

Returns

True if initialize success, false otherwise.

local init	(	local	tag,
		local	color,
		local	opacity,
		local	filePath
	)

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.

Returns

True if initialize success, false otherwise.

Friends And Related Function Documentation

friend class RichText

friend

var RichText

friend

local RichText

friend

Member Data Documentation

std::string _filePath

protected

Rect _textureRect

protected

var _textureRect

protected

local _textureRect

protected

int _textureType

protected

var _textureType

protected

local _textureType

protected

---

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

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