MGUI::CTRL_TREE::ITEMINFO Class Reference

Container for individual item information. More...

#include <mgui/tree.h>

List of all members.

Public Member Functions
	ITEMINFO (const MISTRING &text, ID id=0)
	ITEMINFO (ITEMHND itemhnd, ID id)
	ITEMINFO ()
	~ITEMINFO ()
CHILDPRESENCE	GetChildPresence () const
ITEMHND	GetHandle () const
int	GetHeightMult () const
ID	GetID () const
int	GetImageNormal () const
int	GetImagePrimary () const
int	GetImageSelected () const
int	GetImageState () const
ITEMSTATUS	GetStatus () const
ITEMSTYLE	GetStyle () const
const MISTRING &	GetText () const
ITEMVALUES	GetValidValues () const
void	Set (const ITEMINFO &iteminfo)
void	SetBold (bool bold=true)
void	SetChildPresence (CHILDPRESENCE ChildPresence)
void	SetHeightMult (int HeightMult)
void	SetID (ID id)
void	SetImageNormal (int IdxNormal)
void	SetImageSelected (int IdxSelected)
void	SetImageState (unsigned int IdxState)
void	SetRetainImages ()
void	SetRetainText ()
void	SetStatus (ITEMSTATUS status)
void	SetStyle (ITEMSTYLE style)
void	SetText (const MISTRING &text)

---

Detailed Description

Container for individual item information.

Used for efficient setting an retrieval of various item information.

---

Constructor & Destructor Documentation

MGUI::CTRL_TREE::ITEMINFO::ITEMINFO

(

)

Default constructor.

MGUI::CTRL_TREE::ITEMINFO::ITEMINFO	(	ITEMHND	itemhnd,
		ID	id
	)

MGUI::CTRL_TREE::ITEMINFO::ITEMINFO	(	const MISTRING &	text,
		ID	id = 0
	)			[explicit]

Construct with specified text and ID.

MGUI::CTRL_TREE::ITEMINFO::~ITEMINFO

(

)

Destructor.

---

Member Function Documentation

CHILDPRESENCE MGUI::CTRL_TREE::ITEMINFO::GetChildPresence

(

)

const [inline]

Get child presence.

ITEMHND MGUI::CTRL_TREE::ITEMINFO::GetHandle

(

)

const [inline]

Get item handle.

int MGUI::CTRL_TREE::ITEMINFO::GetHeightMult

(

)

const [inline]

Get height multiplier.

ID MGUI::CTRL_TREE::ITEMINFO::GetID

(

)

const [inline]

Get ID for attaching external information to item.

int MGUI::CTRL_TREE::ITEMINFO::GetImageNormal

(

)

const [inline]

Get index for 'normal' image.

int MGUI::CTRL_TREE::ITEMINFO::GetImagePrimary

(

)

const [inline]

Get primary image index based on current status.

Returns:

Index in primary image list or -1 if none

int MGUI::CTRL_TREE::ITEMINFO::GetImageSelected

(

)

const [inline]

Get index for 'selected' image.

int MGUI::CTRL_TREE::ITEMINFO::GetImageState

(

)

const [inline]

Get 'state' image index.

Returns:

Index in 'state' image list (1-15) or 0 for none

ITEMSTATUS MGUI::CTRL_TREE::ITEMINFO::GetStatus

(

)

const [inline]

Get item status.

ITEMSTYLE MGUI::CTRL_TREE::ITEMINFO::GetStyle

(

)

const [inline]

Get item style.

const MISTRING& MGUI::CTRL_TREE::ITEMINFO::GetText

(

)

const [inline]

Get item text.

If item text retained by owner the returned string will be empty.

ITEMVALUES MGUI::CTRL_TREE::ITEMINFO::GetValidValues

(

)

const [inline]

Get enumeration of valid values.

void MGUI::CTRL_TREE::ITEMINFO::Set

(

const ITEMINFO &

iteminfo

)

Set 'externally settable' members from ITEMINFO.

void MGUI::CTRL_TREE::ITEMINFO::SetBold

(

bool

bold = true

)

Set item 'bold' status.

Status must already be valid for this to have any effect.

Parameters:

bold

true to make bold, false to not

void MGUI::CTRL_TREE::ITEMINFO::SetChildPresence

(

CHILDPRESENCE

ChildPresence

)

[inline]

Set whether item should indicate whether it has children.

This setting has no effect if item already has children.

Parameters:

ChildPresence

Child presence indication

void MGUI::CTRL_TREE::ITEMINFO::SetHeightMult

(

int

HeightMult

)

[inline]

Set height multiplier.

Actual item height will be base height * multiplier.

Parameters:

HeightMult

Height multiplier

void MGUI::CTRL_TREE::ITEMINFO::SetID

(

ID

id

)

[inline]

Set ID for attaching external information to item.

void MGUI::CTRL_TREE::ITEMINFO::SetImageNormal

(

int

IdxNormal

)

Set primary image index for 'normal' status.

Parameters:

IdxNormal

Index in primary image list for 'normal' status, -1 for none

void MGUI::CTRL_TREE::ITEMINFO::SetImageSelected

(

int

IdxSelected

)

Set primary image index for 'selected' status.

Parameters:

IdxSelected

Index in primary image list for 'selected' status, -2 to use same as 'normal'

void MGUI::CTRL_TREE::ITEMINFO::SetImageState

(

unsigned int

IdxState

)

[inline]

Set 'state' image index.

Parameters:

IdxState

Index in 'state' image list (1-15) or 0 for none

void MGUI::CTRL_TREE::ITEMINFO::SetRetainImages

(

)

Set to retain returned images so not requested again.

Used in v_OnGetItemInfo().

void MGUI::CTRL_TREE::ITEMINFO::SetRetainText

(

)

Set to retain returned text so not requested again.

Used in v_OnGetItemInfo().

void MGUI::CTRL_TREE::ITEMINFO::SetStatus

(

ITEMSTATUS

status

)

[inline]

Set item status.

void MGUI::CTRL_TREE::ITEMINFO::SetStyle

(

ITEMSTYLE

style

)

[inline]

Set item style for insertion.

Has no effect for existing items.

void MGUI::CTRL_TREE::ITEMINFO::SetText

(

const MISTRING &

text

)

[inline]

Set item text.

---

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

• mgui/tree.h