MGUI::FORM_COLORSELECTOR Class Reference

Form for color selection. More...

#include <mgui/colorsel.h>

Inheritance diagram for MGUI::FORM_COLORSELECTOR:

[legend]List of all members.

Public Types
enum	FORMSTYLE { FORMSTYLE_Default = 0x00, FORMSTYLE_EditTransparency = 0x01 }
Public Member Functions
void	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, FORMSTYLE formstyle=FORMSTYLE_Default)
	FORM_COLORSELECTOR ()
const COLOR &	GetColor () const
virtual bool	IsCreated () const
virtual bool	IsEnabled () const
void	SetColor (const COLOR &color, bool notify=true)
virtual void	SetEnabled (bool enabled=true)
void	SetTransparency (UINT8 transparency, bool notify=true)
virtual void	SetVisible (bool visible=true)
virtual	~FORM_COLORSELECTOR ()
Protected Member Functions
virtual void	OnChangeColor ()

---

Detailed Description

Form for color selection.

This form includes a "mini-palette", a pushbutton for choosing color, and an optional "edit" control for tranparency.

Definition at line 59 of file colorsel.h.

---

Member Enumeration Documentation

enum MGUI::FORM_COLORSELECTOR::FORMSTYLE

Enumeration values: FORMSTYLE_Default  FORMSTYLE_EditTransparency  Definition at line 62 of file colorsel.h.

---

Constructor & Destructor Documentation

MGUI::FORM_COLORSELECTOR::FORM_COLORSELECTOR (   )

Constructor.

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

Destructor.

---

Member Function Documentation

void MGUI::FORM_COLORSELECTOR::Create (  MGUI::LAYOUT_PANE_BASE &  ParentPane, FORMSTYLE  formstyle = FORMSTYLE_Default )

Create the form.

const COLOR& MGUI::FORM_COLORSELECTOR::GetColor (   )  const [inline]

Get current color. Definition at line 82 of file colorsel.h.

virtual bool MGUI::FORM_COLORSELECTOR::IsCreated (   )  const [virtual]

Determine if form has been created. Returns: true if created, false if not. Reimplemented from MGUI::FORM_COMPOSITE.

virtual bool MGUI::FORM_COLORSELECTOR::IsEnabled (   )  const [virtual]

Determine if form is enabled for keyboard or mouse input. Returns: true if enabled, false if not, or if not yet created.

virtual void MGUI::FORM_COLORSELECTOR::OnChangeColor (   )  [protected, virtual]

Called when user changes color. Reimplemented in MGUI::FORM_COLORSELECTOR_T< _CT >.

void MGUI::FORM_COLORSELECTOR::SetColor (  const COLOR &  color, bool  notify = true )

Set color.

virtual void MGUI::FORM_COLORSELECTOR::SetEnabled (  bool  enabled = true  )  [virtual]

Set whether mouse or keyboard input to form is allowed. Reimplemented from MGUI::FORM_COMPOSITE.

void MGUI::FORM_COLORSELECTOR::SetTransparency (  UINT8  transparency, bool  notify = true )

Set transparency factor. Parameters: transparency  0 = opaque, 255 = invisible.

virtual void MGUI::FORM_COLORSELECTOR::SetVisible (  bool  visible = true  )  [virtual]

Set whether form is visible or not. Reimplemented from MGUI::FORM_COMPOSITE.

---

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

• mgui/colorsel.h

---