MGUI::CTRL_EDIT_OBJECTNAME Class Reference

String 'edit' control. More...

#include <mgui/formeditobjname.h>

Inheritance diagram for MGUI::CTRL_EDIT_OBJECTNAME:

[legend]List of all members.

Public Member Functions
void	ClearValue (bool notify=true)
void	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, MGUI::LAYOUT_SIZEALIGN sizealign=MGUI::LAYOUT_SIZEALIGN_FixedSize)
	CTRL_EDIT_OBJECTNAME ()
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	SetSelection (int StartChar=0, int EndChar=-1, bool NoScroll=true)
void	SetValue (const RVC::OBJECTNAME &name, bool notify=true)
virtual	~CTRL_EDIT_OBJECTNAME ()
Protected Member Functions
virtual bool	OnValidate (MISTRING &string)
Private Member Functions
	CTRL_EDIT_OBJECTNAME (const CTRL_EDIT_OBJECTNAME &)
virtual void	OnUserEdit ()
CTRL_EDIT_OBJECTNAME &	operator= (const CTRL_EDIT_OBJECTNAME &)
virtual void	UpdateValue (bool notify=true)
Private Attributes
RVC::OBJECTNAME	m_value

---

Detailed Description

String 'edit' control.

Definition at line 38 of file formeditobjname.h.

---

Constructor & Destructor Documentation

MGUI::CTRL_EDIT_OBJECTNAME::CTRL_EDIT_OBJECTNAME (   )

Constructor.

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

Destructor.

MGUI::CTRL_EDIT_OBJECTNAME::CTRL_EDIT_OBJECTNAME (  const CTRL_EDIT_OBJECTNAME &   )  [private]

---

Member Function Documentation

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

Clear to empty string. Parameters: notify  Call OnChangeValue() if control has already been created

void MGUI::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& MGUI::CTRL_EDIT_OBJECTNAME::GetValue (   )  const [inline]

Get current string value. Definition at line 61 of file formeditobjname.h.

void MGUI::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 MGUI::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 Definition at line 74 of file formeditobjname.h.

virtual void MGUI::CTRL_EDIT_OBJECTNAME::OnUserEdit (   )  [private, virtual]

Called internally to update control-specific data from edit control. Reimplemented from MGUI::CTRL_EDIT_BASE.

virtual bool MGUI::CTRL_EDIT_OBJECTNAME::OnValidate (  MISTRING &  string  )  [protected, virtual]

Validate the string and alter if possible/necessary. Derived class must call corresponding base class method BEFORE performing its own processing. Returns: 'true' if string could be validated, 'false' if not Parameters: string  String to be validated Reimplemented in MGUI::CTRL_EDIT_OBJECTNAME_T< _CT >, and MGUI::CTRL_EDIT_OBJECTNAME_T< FORM_EDIT_OBJECTNAME >.

CTRL_EDIT_OBJECTNAME& MGUI::CTRL_EDIT_OBJECTNAME::operator= (  const CTRL_EDIT_OBJECTNAME &   )  [private]

void MGUI::CTRL_EDIT_OBJECTNAME::SetSelection (  int  StartChar = 0, int  EndChar = -1, bool  NoScroll = true )  [inline]

Select range of characters in string. Parameters: StartChar  Starting character position in string, 0 for beginning EndChar  Ending character position, -1 for end of string NoScroll  Indicates whether to scroll caret into view Reimplemented from MGUI::CTRL_EDIT_BASE. Definition at line 81 of file formeditobjname.h.

void MGUI::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

virtual void MGUI::CTRL_EDIT_OBJECTNAME::UpdateValue (  bool  notify = true  )  [private, virtual]

Called internally to update control-specific data from edit control. Derived class must call corresponding base class method AFTER performing its own processing. Reimplemented from MGUI::CTRL_EDIT_BASE.

---

Member Data Documentation

RVC::OBJECTNAME MGUI::CTRL_EDIT_OBJECTNAME::m_value [private]

Definition at line 110 of file formeditobjname.h.

---

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

• mgui/formeditobjname.h

---