MGUI::DLG_EDIT_COLORS Class Reference

Dialog for editing colors. More...

#include <mgui/dlgeditcolors.h>

Inheritance diagram for MGUI::DLG_EDIT_COLORS:

Public Member Functions
	DLG_EDIT_COLORS (COLOR::CAPABILITY capability=COLOR::CAPABILITY_NoTransparency, LAYOUT_ORIENTATION orientation=LAYOUT_ORIENTATION_Vertical)
virtual	~DLG_EDIT_COLORS ()
int	AddItem (const MISTRING &name, UINT32 colorref, COLOR::CAPABILITY capability=COLOR::CAPABILITY_AsPrevious)
int	AddItem (const MISTRING &name, const COLOR &color, COLOR::CAPABILITY capability=COLOR::CAPABILITY_AsPrevious)
const COLOR &	GetItemColor (int itemidx)
UINT32	GetItemColorRef (int itemidx)

Detailed Description

Dialog for editing colors.

Constructor & Destructor Documentation

MGUI::DLG_EDIT_COLORS::DLG_EDIT_COLORS	(	COLOR::CAPABILITY	capability = `COLOR::CAPABILITY_NoTransparency`,
		LAYOUT_ORIENTATION	orientation = `LAYOUT_ORIENTATION_Vertical`
	)			`[explicit]`

Constructor.

Note that if transparency on/off or percentage controls are required for any item in the list the desired capability must be specified when constructing the dialog.

virtual MGUI::DLG_EDIT_COLORS::~DLG_EDIT_COLORS ( ) [virtual]

Destructor.

Member Function Documentation

int MGUI::DLG_EDIT_COLORS::AddItem	(	const MISTRING &	name,
		UINT32	colorref,
		COLOR::CAPABILITY	capability = `COLOR::CAPABILITY_AsPrevious`
	)			`[inline]`

Add item to list.

Returns:: Item index for use when retrieve color.

int MGUI::DLG_EDIT_COLORS::AddItem	(	const MISTRING &	name,
		const COLOR &	color,
		COLOR::CAPABILITY	capability = `COLOR::CAPABILITY_AsPrevious`
	)			`[inline]`

Add item to list.

Returns:: Item index for use when retrieve color.

const COLOR& MGUI::DLG_EDIT_COLORS::GetItemColor ( int itemidx ) [inline]

Get color for specified item.

Returns:: Reference to color

Parameters:

itemidx

Item index (from AddItem())

UINT32 MGUI::DLG_EDIT_COLORS::GetItemColorRef ( int itemidx ) [inline]

Get color reference for specified item.

Returns:: Color reference