RVC::UI::CTRL_EDIT_OBJECTNAME Class Reference

Object name 'edit' control. More...

#include <rvc/uieditobjectname.h>

Inheritance diagram for RVC::UI::CTRL_EDIT_OBJECTNAME:

[legend]

List of all members.

Public Member Functions
	CTRL_EDIT_OBJECTNAME ()
virtual	~CTRL_EDIT_OBJECTNAME ()
void	ClearValue (bool notify=true)
void	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, MGUI::LAYOUT_SIZEALIGN sizealign=MGUI::LAYOUT_SIZEALIGN_FixedSize)
const RVC::OBJECTNAME &	GetValue () const
void	IniRead (INIHANDLE IniHandle, const char *IniGroup, const char *IniField, bool notify=true)
void	IniWrite (INIHANDLE IniHandle, const char *IniGroup, const char *IniField) const
void	SetDelegateOnValidate (FastDelegate< bool(MISTRING &)> delegate)
void	SetValue (const RVC::OBJECTNAME &name, bool notify=true)

---

Detailed Description

Object name 'edit' control.

---

Constructor & Destructor Documentation

RVC::UI::CTRL_EDIT_OBJECTNAME::CTRL_EDIT_OBJECTNAME

(

)

Constructor.

virtual RVC::UI::CTRL_EDIT_OBJECTNAME::~CTRL_EDIT_OBJECTNAME

(

)

[virtual]

Destructor.

---

Member Function Documentation

void RVC::UI::CTRL_EDIT_OBJECTNAME::ClearValue

(

bool

notify = true

)

Clear to empty string.

Parameters:

notify

Call OnChangeValue() if control has already been created

void RVC::UI::CTRL_EDIT_OBJECTNAME::Create	(	MGUI::LAYOUT_PANE_BASE &	ParentPane,
		MGUI::LAYOUT_SIZEALIGN	sizealign = MGUI::LAYOUT_SIZEALIGN_FixedSize
	)

Create control.

Parameters:

ParentPane

Parent pane

const RVC::OBJECTNAME& RVC::UI::CTRL_EDIT_OBJECTNAME::GetValue

(

)

const [inline]

Get current string value.

void RVC::UI::CTRL_EDIT_OBJECTNAME::IniRead	(	INIHANDLE	IniHandle,
		const char *	IniGroup,
		const char *	IniField,
		bool	notify = true
	)

Read value from INI file.

If Create() has already been performed the control's state will be updated.

Parameters:

	IniHandle	Handle to INI file to read from, 0 for default
	IniGroup	INI group to read from
	IniField	INI field to read from
	notify	Call OnChangeValue() if control has already been created

void RVC::UI::CTRL_EDIT_OBJECTNAME::IniWrite	(	INIHANDLE	IniHandle,
		const char *	IniGroup,
		const char *	IniField
	)			const [inline]

Write current value to INI file.

Parameters:

	IniHandle	Handle to INI file to read from, 0 for default
	IniGroup	INI group to read from
	IniField	INI field to read from

void RVC::UI::CTRL_EDIT_OBJECTNAME::SetDelegateOnValidate

(

FastDelegate< bool(MISTRING &)>

delegate

)

[inline]

Set delegate to call to perform validation.

void RVC::UI::CTRL_EDIT_OBJECTNAME::SetValue	(	const RVC::OBJECTNAME &	name,
		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:

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

---

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

• rvc/uieditobjectname.h