RVC::UI::FORM_EDIT_DESCRIPTOR Class Reference

Object name edit form with label and edit field. More...

#include <rvc/uieditdescriptor.h>

Inheritance diagram for RVC::UI::FORM_EDIT_DESCRIPTOR:

[legend]

List of all members.

Public Types
enum	FLAGS { FLAG_Default = 0x0000, FLAG_NoModifyName = 0x0008, FLAG_IsFileDescriptor = 0x0010 }
Public Member Functions
	FORM_EDIT_DESCRIPTOR ()
virtual	~FORM_EDIT_DESCRIPTOR ()
void	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, FLAGS flags=FLAG_Default, MGUI::LAYOUT_SIZEALIGN sizealign=MGUI::LAYOUT_SIZEALIGN_Expand, MGUI::CTRL_EDIT_TEXT::FLAGS textflags=MGUI::CTRL_EDIT_TEXT::FLAG_Default, int DescriptionHeight=5)
const RVC::DESCRIPTOR &	GetValue ()
void	SetDelegateOnAnyChange (DELEGATE_VOID_NOPARMS delegate)
void	SetDelegateOnNameChange (FastDelegate< void(const MISTRING &)> delegate)
void	SetDelegateOnTestUniqueShortName (FastDelegate< int(const RVC::OBJECTNAME &)> delegate)
void	SetDelegateOnValidateShortName (FastDelegate< bool(RVC::OBJECTNAME &)> delegate)
void	SetFocusToName ()
void	SetParentDirectory (const FILEPATH *pParentDirectory)
void	SetValue (const RVC::DESCRIPTOR &Descriptor, bool notify=true)

---

Detailed Description

Object name edit form with label and edit field.

---

Member Enumeration Documentation

enum RVC::UI::FORM_EDIT_DESCRIPTOR::FLAGS

Enumerator:

FLAG_Default
FLAG_NoModifyName
FLAG_IsFileDescriptor

---

Constructor & Destructor Documentation

RVC::UI::FORM_EDIT_DESCRIPTOR::FORM_EDIT_DESCRIPTOR

(

)

Constructor.

virtual RVC::UI::FORM_EDIT_DESCRIPTOR::~FORM_EDIT_DESCRIPTOR

(

)

[virtual]

Destructor.

---

Member Function Documentation

void RVC::UI::FORM_EDIT_DESCRIPTOR::Create	(	MGUI::LAYOUT_PANE_BASE &	ParentPane,
		FLAGS	flags = FLAG_Default,
		MGUI::LAYOUT_SIZEALIGN	sizealign = MGUI::LAYOUT_SIZEALIGN_Expand,
		MGUI::CTRL_EDIT_TEXT::FLAGS	textflags = MGUI::CTRL_EDIT_TEXT::FLAG_Default,
		int	DescriptionHeight = 5
	)

Create form with label from resource lookup.

Parameters:

ParentPane

Parent pane

const RVC::DESCRIPTOR& RVC::UI::FORM_EDIT_DESCRIPTOR::GetValue

(

)

Get current descriptor value.

Equivalent to GetEditCtrl().GetValue().

void RVC::UI::FORM_EDIT_DESCRIPTOR::SetDelegateOnAnyChange

(

DELEGATE_VOID_NOPARMS

delegate

)

[inline]

Set delegate to call to get notified on any descriptor changes.

void RVC::UI::FORM_EDIT_DESCRIPTOR::SetDelegateOnNameChange

(

FastDelegate< void(const MISTRING &)>

delegate

)

[inline]

Set delegate to call to get notified on name changes.

void RVC::UI::FORM_EDIT_DESCRIPTOR::SetDelegateOnTestUniqueShortName

(

FastDelegate< int(const RVC::OBJECTNAME &)>

delegate

)

[inline]

Set delegate to call to test if short name unique.

Delegate must return TRUE if name unique, FALSE if not, < 0 if error.

void RVC::UI::FORM_EDIT_DESCRIPTOR::SetDelegateOnValidateShortName

(

FastDelegate< bool(RVC::OBJECTNAME &)>

delegate

)

[inline]

Set delegate to call to validate short name.

void RVC::UI::FORM_EDIT_DESCRIPTOR::SetFocusToName

(

)

[inline]

void RVC::UI::FORM_EDIT_DESCRIPTOR::SetParentDirectory

(

const FILEPATH *

pParentDirectory

)

[inline]

void RVC::UI::FORM_EDIT_DESCRIPTOR::SetValue	(	const RVC::DESCRIPTOR &	Descriptor,
		bool	notify = true
	)

No comparison is made with the current string value.

Equivalent to GetEditCtrl().SetValue(...).

Parameters:

	Descriptor	New string to set
	notify	Call OnChangeValue() if string actually updated

---

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

• rvc/uieditdescriptor.h