RVC::UI::FORM_EDIT_RASTER_VALUE Class Reference

Form consisting of label and edit field(s) for specified image cell type. More...

#include <rvc/uieditrastervalue.h>

Inheritance diagram for RVC::UI::FORM_EDIT_RASTER_VALUE:

[legend]

List of all members.

Public Types
enum	STYLE { STYLE_Default = 0x00, STYLE_ComponentLabels = 0x01 }
Public Member Functions
	FORM_EDIT_RASTER_VALUE ()
virtual	~FORM_EDIT_RASTER_VALUE ()
void	ClearValue (bool notify=true)
void	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, const MISTRING &label, RVC::IMAGE::CELLTYPE CellType, STYLE Style=STYLE_Default, MGUI::LAYOUT_ORIENTATION orientation=MGUI::LAYOUT_ORIENTATION_Horizontal, MGUI::LAYOUT_SIZEALIGN sizealign=MGUI::LAYOUT_SIZEALIGN_FixedSize)
MGUI::CTRL_LABEL &	GetLabel ()
void	GetValue (ANYRASTVALUE &value)
bool	HasValue ()
void	SetCellType (RVC::IMAGE::CELLTYPE CellType)
void	SetDelegateOnChangeValue (DELEGATE_VOID_NOPARMS delegate)
void	SetLabel (const MISTRING &label)
void	SetValue (const ANYRASTVALUE &value, bool notify=true)
Protected Member Functions
virtual void	v_OnChangeValue ()

---

Detailed Description

Form consisting of label and edit field(s) for specified image cell type.

---

Member Enumeration Documentation

enum RVC::UI::FORM_EDIT_RASTER_VALUE::STYLE

Enumerator:

STYLE_Default
STYLE_ComponentLabels	Preceed the value prompts.

---

Constructor & Destructor Documentation

RVC::UI::FORM_EDIT_RASTER_VALUE::FORM_EDIT_RASTER_VALUE

(

)

Constructor.

virtual RVC::UI::FORM_EDIT_RASTER_VALUE::~FORM_EDIT_RASTER_VALUE

(

)

[virtual]

Destructor.

---

Member Function Documentation

void RVC::UI::FORM_EDIT_RASTER_VALUE::ClearValue

(

bool

notify = true

)

Clear current value.

Parameters:

notify

Send notification that value changed

void RVC::UI::FORM_EDIT_RASTER_VALUE::Create	(	MGUI::LAYOUT_PANE_BASE &	ParentPane,
		const MISTRING &	label,
		RVC::IMAGE::CELLTYPE	CellType,
		STYLE	Style = STYLE_Default,
		MGUI::LAYOUT_ORIENTATION	orientation = MGUI::LAYOUT_ORIENTATION_Horizontal,
		MGUI::LAYOUT_SIZEALIGN	sizealign = MGUI::LAYOUT_SIZEALIGN_FixedSize
	)

Create form with label from resource lookup.

Parameters:

	ParentPane	Parent pane
	label	Label

MGUI::CTRL_LABEL& RVC::UI::FORM_EDIT_RASTER_VALUE::GetLabel

(

)

[inline]

Retrieve label control for form.

Usually the label control is only retrieved for alignment purposes.

void RVC::UI::FORM_EDIT_RASTER_VALUE::GetValue

(

ANYRASTVALUE &

value

)

Get current raster value.

bool RVC::UI::FORM_EDIT_RASTER_VALUE::HasValue

(

)

Determine if value has been set.

void RVC::UI::FORM_EDIT_RASTER_VALUE::SetCellType

(

RVC::IMAGE::CELLTYPE

CellType

)

Set cell type.

void RVC::UI::FORM_EDIT_RASTER_VALUE::SetDelegateOnChangeValue

(

DELEGATE_VOID_NOPARMS

delegate

)

[inline]

Set delegate to call when value changed.

void RVC::UI::FORM_EDIT_RASTER_VALUE::SetLabel

(

const MISTRING &

label

)

[inline]

Set label text.

Parameters:

label

New label text

void RVC::UI::FORM_EDIT_RASTER_VALUE::SetValue	(	const ANYRASTVALUE &	value,
		bool	notify = true
	)

Set current value with validation.

If value specified is not valid for current raster type the value will not be updated. No comparison is made with the current value.

Parameters:

	value	New value to set
	notify	Call OnChangeValue() if value actually updated

virtual void RVC::UI::FORM_EDIT_RASTER_VALUE::v_OnChangeValue

(

)

[protected, virtual]

Called when value is changed.

Default implementation invokes corresponding delegate. If override call when/if needed to invoke delegate.

---

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

• rvc/uieditrastervalue.h