MGUI::FORM_EDIT_RASTER_VALUE Class Reference

Form consisting of label and string edit field. More...

#include <mgui/formrastervalue.h>

Inheritance diagram for MGUI::FORM_EDIT_RASTER_VALUE:


Public Member Functions
void	ClearValue (bool notify=true)
void	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, const MISTRING &label, RVC::IMAGE::CELLTYPE CellType, MGUI::LAYOUT_SIZEALIGN sizealign=MGUI::LAYOUT_SIZEALIGN_FixedSize, MGUI::CTRL_LABEL::STYLE labelstyle=MGUI::CTRL_LABEL::STYLE_LeftNoWrap)
	FORM_EDIT_RASTER_VALUE ()
MGUI::CTRL_LABEL &	GetLabel ()
void	GetValue (ANYRASTVALUE &value)
bool	HasValue ()
void	SetCellType (RVC::IMAGE::CELLTYPE CellType)
void	SetLabel (const MISTRING &label)
void	SetValue (const ANYRASTVALUE &value, bool notify=true)
virtual	~FORM_EDIT_RASTER_VALUE ()
Protected Member Functions
virtual void	v_OnChangeValue ()
Private Member Functions
void	OnValueChanged ()
Private Attributes
RVC::IMAGE::CELLTYPE	m_CellType
CTRL_LABEL	m_label
CTRL_EDIT_NUMBER_T< FORM_EDIT_RASTER_VALUE >	m_Value1
CTRL_EDIT_NUMBER_T< FORM_EDIT_RASTER_VALUE >	m_Value2
CTRL_EDIT_NUMBER_T< FORM_EDIT_RASTER_VALUE >	m_Value3
CTRL_EDIT_NUMBER_T< FORM_EDIT_RASTER_VALUE >	m_Value4

Detailed Description

Form consisting of label and string edit field.

Definition at line 48 of file formrastervalue.h.

Constructor & Destructor Documentation

MGUI::FORM_EDIT_RASTER_VALUE::FORM_EDIT_RASTER_VALUE ( )

Constructor.

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

Destructor.

Member Function Documentation

void MGUI::FORM_EDIT_RASTER_VALUE::ClearValue ( bool notify = true )

Clear current value.

Parameters:

notify Call v_OnChangeValue() if control has already been created

void MGUI::FORM_EDIT_RASTER_VALUE::Create ( MGUI::LAYOUT_PANE_BASE & ParentPane,

const MISTRING & label,

RVC::IMAGE::CELLTYPE CellType,

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

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

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

void MGUI::FORM_EDIT_RASTER_VALUE::GetValue ( ANYRASTVALUE & value )

Get current raster value.

bool MGUI::FORM_EDIT_RASTER_VALUE::HasValue ( )

Determine if value has been set.

void MGUI::FORM_EDIT_RASTER_VALUE::OnValueChanged ( ) [private]

void MGUI::FORM_EDIT_RASTER_VALUE::SetCellType ( RVC::IMAGE::CELLTYPE CellType )

void MGUI::FORM_EDIT_RASTER_VALUE::SetLabel ( const MISTRING & label ) [inline]

Set label text using string from resource lookup.

Parameters:

label New label text

Definition at line 91 of file formrastervalue.h.

void MGUI::FORM_EDIT_RASTER_VALUE::SetValue ( const ANYRASTVALUE & value,

bool notify = true

)

Set current string value with validation.
OnValidate() will be called and if valid, the string will be updated. No comparison is made with the current string value.
Parameters:

value New value to set

notify Call OnChangeValue() if string actually updated

virtual void MGUI::FORM_EDIT_RASTER_VALUE::v_OnChangeValue ( ) [protected, virtual]

Called when value is changed after validation.
Derived class must call corresponding base class method BEFORE performing its own processing. If the user modifies the text in the edit control this will not be called until the control loses "focus".
Reimplemented in MGUI::FORM_EDIT_RASTER_VALUE_T< _CT >.