MGUI::FORM_COLORBUTTON Class Reference

Form containing label and color pushbutton for showing and selecting a "color". More...

#include <mgui/colorbtn.h>

Inheritance diagram for MGUI::FORM_COLORBUTTON:

[legend]List of all members.

Public Member Functions
void	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, const UNICODE *label, const COLOR &dftcolor, MGUI::CTRL_COLORBUTTON::STYLE buttonstyle=MGUI::CTRL_COLORBUTTON::STYLE_Default, MGUI::LAYOUT_SIZEALIGN sizealign=MGUI::LAYOUT_SIZEALIGN_FixedSize, MGUI::CTRL_LABEL::STYLE labelstyle=MGUI::CTRL_LABEL::STYLE_LeftNoWrap)
void	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, const char *label, const COLOR &dftcolor, MGUI::CTRL_COLORBUTTON::STYLE buttonstyle=MGUI::CTRL_COLORBUTTON::STYLE_Default, MGUI::LAYOUT_SIZEALIGN sizealign=MGUI::LAYOUT_SIZEALIGN_FixedSize, MGUI::CTRL_LABEL::STYLE labelstyle=MGUI::CTRL_LABEL::STYLE_LeftNoWrap)
	FORM_COLORBUTTON ()
const COLOR &	GetColor () const
COLORREF	GetColorRef () const
MGUI::CTRL_LABEL &	GetLabel ()
void	SetColor (const COLORREF color, bool notify=true)
void	SetColor (const COLOR &color, bool notify=true)
void	SetLabel (const UNICODE *label)
void	SetLabel (const char *label)
virtual	~FORM_COLORBUTTON ()
Protected Member Functions
virtual void	OnChangeColor ()

---

Detailed Description

Form containing label and color pushbutton for showing and selecting a "color".

The button will be shown in the selected color and contains no visible text.

Definition at line 170 of file colorbtn.h.

---

Constructor & Destructor Documentation

MGUI::FORM_COLORBUTTON::FORM_COLORBUTTON (   )

Constructor.

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

Destructor.

---

Member Function Documentation

void MGUI::FORM_COLORBUTTON::Create (  MGUI::LAYOUT_PANE_BASE &  ParentPane, const UNICODE *  label, const COLOR &  dftcolor, MGUI::CTRL_COLORBUTTON::STYLE  buttonstyle = MGUI::CTRL_COLORBUTTON::STYLE_Default, MGUI::LAYOUT_SIZEALIGN  sizealign = MGUI::LAYOUT_SIZEALIGN_FixedSize, MGUI::CTRL_LABEL::STYLE  labelstyle = MGUI::CTRL_LABEL::STYLE_LeftNoWrap )

Create form with Unicode label. Parameters: ParentPane  Parent pane label  Label string dftcolor  Default color

void MGUI::FORM_COLORBUTTON::Create (  MGUI::LAYOUT_PANE_BASE &  ParentPane, const char *  label, const COLOR &  dftcolor, MGUI::CTRL_COLORBUTTON::STYLE  buttonstyle = MGUI::CTRL_COLORBUTTON::STYLE_Default, MGUI::LAYOUT_SIZEALIGN  sizealign = MGUI::LAYOUT_SIZEALIGN_FixedSize, MGUI::CTRL_LABEL::STYLE  labelstyle = MGUI::CTRL_LABEL::STYLE_LeftNoWrap )

Create form with label from resource lookup. Parameters: ParentPane  Parent pane label  Label string for resource lookup dftcolor  Default color

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

Get current color. Definition at line 202 of file colorbtn.h.

COLORREF MGUI::FORM_COLORBUTTON::GetColorRef (   )  const [inline]

Get current color. Definition at line 206 of file colorbtn.h.

MGUI::CTRL_LABEL& MGUI::FORM_COLORBUTTON::GetLabel (   )  [inline]

Retrieve label control for form. Usually the label control is only retrieved for alignment purposes. Definition at line 211 of file colorbtn.h.

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

Called when value is changed. Derived class must call corresponding superclass method BEFORE performing its own processing.

void MGUI::FORM_COLORBUTTON::SetColor (  const COLORREF  color, bool  notify = true )  [inline]

Set color. Parameters: color  New color value to set notify  Call OnChangeColor() if 'true' Definition at line 221 of file colorbtn.h.

void MGUI::FORM_COLORBUTTON::SetColor (  const COLOR &  color, bool  notify = true )  [inline]

Set color. Parameters: color  New color value to set notify  Call OnChangeColor() if 'true' Definition at line 215 of file colorbtn.h.

void MGUI::FORM_COLORBUTTON::SetLabel (  const UNICODE *  label  )  [inline]

Set label text from Unicode string. Parameters: label  New label text Definition at line 232 of file colorbtn.h.

void MGUI::FORM_COLORBUTTON::SetLabel (  const char *  label  )  [inline]

Set label text using string from resource lookup. Parameters: label  New label text Definition at line 227 of file colorbtn.h.

---

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

• mgui/colorbtn.h

---