MGUI::POPUP_COLOR Class Reference

Popup window for choosing color. More...

#include <mgui/popupcolor.h>

Inheritance diagram for MGUI::POPUP_COLOR:

[legend]

List of all members.

Public Types
enum	STYLE { STYLE_Default = 0x00, STYLE_AllowTransparency = 0x01 }
Public Member Functions
	POPUP_COLOR (STYLE style=STYLE_Default)
	~POPUP_COLOR ()
void	AddToggle (MGUI::ID id, const MISTRING &label, bool dft=false)
const COLOR &	GetColor () const
bool	GetToggleValue (MGUI::ID id) const
void	Initialize (const MISTRING &label, const COLOR &color, STYLE style=STYLE_Default)
void	SetColor (const COLOR &color)
void	SetLabel (const MISTRING &label)
void	SetToggleValue (MGUI::ID id, bool value)

---

Detailed Description

Popup window for choosing color.

---

Member Enumeration Documentation

enum MGUI::POPUP_COLOR::STYLE

Enumerator:

STYLE_Default	Default style, no transparency option.
STYLE_AllowTransparency	Include control for transparency.

---

Constructor & Destructor Documentation

MGUI::POPUP_COLOR::POPUP_COLOR

(

STYLE

style = STYLE_Default

)

[explicit]

Construct with optional style.

MGUI::POPUP_COLOR::~POPUP_COLOR

(

)

Destructor.

---

Member Function Documentation

void MGUI::POPUP_COLOR::AddToggle	(	MGUI::ID	id,
		const MISTRING &	label,
		bool	dft = false
	)

Add toggle with label below palette selection.

If used, must be done before popup is created or first shown.

Parameters:

	id	Toggle id
	label	Label to show for toggle
	dft	Default value

const COLOR& MGUI::POPUP_COLOR::GetColor

(

)

const [inline]

Get current color.

bool MGUI::POPUP_COLOR::GetToggleValue

(

MGUI::ID

id

)

const

Get value of toggle.

Parameters:

id

Toggle id

void MGUI::POPUP_COLOR::Initialize	(	const MISTRING &	label,
		const COLOR &	color,
		STYLE	style = STYLE_Default
	)

Initialize label, color and style.

If used, must be called before popup is created or first opened.

Parameters:

	label	Label string
	color	Initial color
	style	Popup style

void MGUI::POPUP_COLOR::SetColor

(

const COLOR &

color

)

[inline]

Set color.

Parameters:

color

Color to set

void MGUI::POPUP_COLOR::SetLabel

(

const MISTRING &

label

)

[inline]

Set label to show at top of popup.

If used, must be called before popup is created or first opened.

void MGUI::POPUP_COLOR::SetToggleValue	(	MGUI::ID	id,
		bool	value
	)

Set value of toggle.

Parameters:

	id	Toggle id
	value	Value to set

---

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

• mgui/popupcolor.h