TEXTRESITEM Class Reference

Text resource item container. More...

#include <mi32/textresitem.h>

List of all members.

Public Member Functions
	TEXTRESITEM (const MISTRING &rhs)
	TEXTRESITEM (TEXTID textid)
	TEXTRESITEM (const char *name, TEXTRES_NAMESET nameset=TEXTRES_NAMESET_General)
	TEXTRESITEM (const TEXTRESITEM &rhs)
	TEXTRESITEM ()
	~TEXTRESITEM ()
bool	Assign (const UINT8 *name, TEXTRES_NAMESET nameset=TEXTRES_NAMESET_General)
bool	Assign (const char *name, TEXTRES_NAMESET nameset=TEXTRES_NAMESET_General)
void	Clear ()
bool	CreateFromXML (const XMLNODE *itemnode)
const MISTRING &	GetString () const
bool	IsValid () const
TEXTRESITEM &	operator= (const MISTRING &rhs)
TEXTRESITEM &	operator= (TEXTID rhs)
TEXTRESITEM &	operator= (const char *name)
TEXTRESITEM &	operator= (const TEXTRESITEM &rhs)

---

Detailed Description

Text resource item container.

Used to encapsulate various ways to reference a text resource. May contain an actual string instance or a reference to a string location in the resource file.

---

Constructor & Destructor Documentation

TEXTRESITEM::TEXTRESITEM

(

)

Default constructor.

TEXTRESITEM::TEXTRESITEM

(

const TEXTRESITEM &

rhs

)

Copy constructor.

TEXTRESITEM::TEXTRESITEM	(	const char *	name,
		TEXTRES_NAMESET	nameset = TEXTRES_NAMESET_General
	)

Construct from item name.

TEXTRESITEM::TEXTRESITEM

(

TEXTID

textid

)

Construct from TEXTID.

TEXTRESITEM::TEXTRESITEM

(

const MISTRING &

rhs

)

Construct from MISTRING.

TEXTRESITEM::~TEXTRESITEM

(

)

Destructor.

---

Member Function Documentation

bool TEXTRESITEM::Assign	(	const UINT8 *	name,
		TEXTRES_NAMESET	nameset = TEXTRES_NAMESET_General
	)

Assign from item name in specified nameset.

Returns:

true if item exists, false if not.

Parameters:

nameset

Name, assumed in UTF8 encoding for NAMESET_NoLookup

bool TEXTRESITEM::Assign	(	const char *	name,
		TEXTRES_NAMESET	nameset = TEXTRES_NAMESET_General
	)

Assign from item name in specified nameset.

Returns:

true if item exists, false if not.

void TEXTRESITEM::Clear

(

)

Clear item.

bool TEXTRESITEM::CreateFromXML

(

const XMLNODE *

itemnode

)

Create identifier from XML node.

Node must be in one of the following forms:

<nodename>text_reference</nodename> <nodename lookup="yes">text_reference</nodename> <nodename lookup="no">text string</nodename>

Returns:

true if successful, false if not

const MISTRING& TEXTRESITEM::GetString

(

)

const

Get resource string.

bool TEXTRESITEM::IsValid

(

)

const

Determine if item references valid text resource or string.

TEXTRESITEM& TEXTRESITEM::operator=

(

const MISTRING &

rhs

)

Assign from MISTRING.

TEXTRESITEM& TEXTRESITEM::operator=

(

TEXTID

rhs

)

Assign from TEXTID.

TEXTRESITEM& TEXTRESITEM::operator=

(

const char *

name

)

Assign from item name in 'general' nameset.

TEXTRESITEM& TEXTRESITEM::operator=

(

const TEXTRESITEM &

rhs

)

Assignment.

---

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

• mi32/textresitem.h