Version: 3.3.0
wxPGTextCtrlEditor Class Reference

#include <wx/propgrid/editors.h>

+ Inheritance diagram for wxPGTextCtrlEditor:

Public Member Functions

 wxPGTextCtrlEditor ()
 
virtual ~wxPGTextCtrlEditor ()
 
virtual wxPGWindowList CreateControls (wxPropertyGrid *propgrid, wxPGProperty *property, const wxPoint &pos, const wxSize &size) const
 Instantiates editor controls. More...
 
virtual void UpdateControl (wxPGProperty *property, wxWindow *ctrl) const
 Loads value from property to the control. More...
 
virtual bool OnEvent (wxPropertyGrid *propgrid, wxPGProperty *property, wxWindow *primaryCtrl, wxEvent &event) const
 Handles events. More...
 
virtual bool GetValueFromControl (wxVariant &variant, wxPGProperty *property, wxWindow *ctrl) const
 Returns value from control, via parameter variant. More...
 
virtual wxString GetName () const
 Returns pointer to the name of the editor. More...
 
virtual void SetControlStringValue (wxPGProperty *property, wxWindow *ctrl, const wxString &txt) const
 Sets control's value specifically from string. More...
 
virtual void OnFocus (wxPGProperty *property, wxWindow *wnd) const
 Extra processing when control gains focus. More...
 
- Public Member Functions inherited from wxPGEditor
 wxPGEditor ()
 Constructor. More...
 
virtual ~wxPGEditor ()
 Destructor. More...
 
virtual void DrawValue (wxDC &dc, const wxRect &rect, wxPGProperty *property, const wxString &text) const
 Draws value for given property. More...
 
virtual void SetValueToUnspecified (wxPGProperty *property, wxWindow *ctrl) const
 Sets value in control to unspecified. More...
 
virtual void SetControlAppearance (wxPropertyGrid *pg, wxPGProperty *property, wxWindow *ctrl, const wxPGCell &appearance, const wxPGCell &oldAppearance, bool unspecified) const
 Called by property grid to set new appearance for the control. More...
 
virtual void SetControlIntValue (wxPGProperty *property, wxWindow *ctrl, int value) const
 Sets control's value specifically from int (applies to choice etc.). More...
 
virtual int InsertItem (wxWindow *ctrl, const wxString &label, int index) const
 Inserts item to existing control. More...
 
virtual void DeleteItem (wxWindow *ctrl, int index) const
 Deletes item from existing control. More...
 
virtual bool CanContainCustomImage () const
 Returns true if control itself can contain the custom image. More...
 
- Public Member Functions inherited from wxObject
 wxObject ()
 Default ctor; initializes to nullptr the internal reference data. More...
 
 wxObject (const wxObject &other)
 Copy ctor. More...
 
virtual ~wxObject ()
 Destructor. More...
 
virtual wxClassInfoGetClassInfo () const
 This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
 
wxObjectRefDataGetRefData () const
 Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
 
bool IsKindOf (const wxClassInfo *info) const
 Determines whether this class is a subclass of (or the same class as) the given class. More...
 
bool IsSameAs (const wxObject &obj) const
 Returns true if this object has the same data pointer as obj. More...
 
void Ref (const wxObject &clone)
 Makes this object refer to the data in clone. More...
 
void SetRefData (wxObjectRefData *data)
 Sets the wxObject::m_refData pointer. More...
 
void UnRef ()
 Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
 
void UnShare ()
 This is the same of AllocExclusive() but this method is public. More...
 
void operator delete (void *buf)
 The delete operator is defined for debugging versions of the library only, when the identifier __WXDEBUG__ is defined. More...
 
void * operator new (size_t size, const wxString &filename=nullptr, int lineNum=0)
 The new operator is defined for debugging versions of the library only, when the identifier __WXDEBUG__ is defined. More...
 

Static Public Member Functions

static bool OnTextCtrlEvent (wxPropertyGrid *propgrid, wxPGProperty *property, wxWindow *ctrl, wxEvent &event)
 
static bool GetTextCtrlValueFromControl (wxVariant &variant, wxPGProperty *property, wxWindow *ctrl)
 

Additional Inherited Members

- Public Attributes inherited from wxPGEditor
void * m_clientData
 
- Protected Member Functions inherited from wxObject
void AllocExclusive ()
 Ensure that this object's data is not shared with any other object. More...
 
virtual wxObjectRefDataCreateRefData () const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More...
 
virtual wxObjectRefDataCloneRefData (const wxObjectRefData *data) const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More...
 
- Protected Attributes inherited from wxObject
wxObjectRefDatam_refData
 Pointer to an object which is the object's reference-counted data. More...
 

Constructor & Destructor Documentation

◆ wxPGTextCtrlEditor()

wxPGTextCtrlEditor::wxPGTextCtrlEditor ( )

◆ ~wxPGTextCtrlEditor()

virtual wxPGTextCtrlEditor::~wxPGTextCtrlEditor ( )
virtual

Member Function Documentation

◆ CreateControls()

virtual wxPGWindowList wxPGTextCtrlEditor::CreateControls ( wxPropertyGrid propgrid,
wxPGProperty property,
const wxPoint pos,
const wxSize size 
) const
virtual

Instantiates editor controls.

Parameters
propgridwxPropertyGrid to which the property belongs (use as parent for control).
propertyProperty for which this method is called.
posPosition, inside wxPropertyGrid, to create control(s) to.
sizeInitial size for control(s).
Remarks

Implements wxPGEditor.

Reimplemented in wxPGTextCtrlAndButtonEditor, and wxPGSpinCtrlEditor.

◆ GetName()

virtual wxString wxPGTextCtrlEditor::GetName ( ) const
virtual

Returns pointer to the name of the editor.

For example, wxPGEditor_TextCtrl has name "TextCtrl". If you don't need to access your custom editor by string name, then you do not need to implement this function.

Reimplemented from wxPGEditor.

Reimplemented in wxPGTextCtrlAndButtonEditor, and wxPGSpinCtrlEditor.

◆ GetTextCtrlValueFromControl()

static bool wxPGTextCtrlEditor::GetTextCtrlValueFromControl ( wxVariant variant,
wxPGProperty property,
wxWindow ctrl 
)
static

◆ GetValueFromControl()

virtual bool wxPGTextCtrlEditor::GetValueFromControl ( wxVariant variant,
wxPGProperty property,
wxWindow ctrl 
) const
virtual

Returns value from control, via parameter variant.

Usually ends up calling property's StringToValue() or IntToValue(). Returns true if value was different.

Reimplemented from wxPGEditor.

◆ OnEvent()

virtual bool wxPGTextCtrlEditor::OnEvent ( wxPropertyGrid propgrid,
wxPGProperty property,
wxWindow wnd_primary,
wxEvent event 
) const
virtual

Handles events.

Returns true if value in control was modified (see wxPGProperty::OnEvent() for more information).

Remarks
wxPropertyGrid will automatically unfocus the editor when wxEVT_TEXT_ENTER is received and when it results in property value being modified. This happens regardless of editor type (i.e. behaviour is same for any wxTextCtrl and wxComboBox based editor).

Implements wxPGEditor.

Reimplemented in wxPGSpinCtrlEditor.

◆ OnFocus()

virtual void wxPGTextCtrlEditor::OnFocus ( wxPGProperty property,
wxWindow wnd 
) const
virtual

Extra processing when control gains focus.

For example, wxTextCtrl based controls should select all text.

Reimplemented from wxPGEditor.

◆ OnTextCtrlEvent()

static bool wxPGTextCtrlEditor::OnTextCtrlEvent ( wxPropertyGrid propgrid,
wxPGProperty property,
wxWindow ctrl,
wxEvent event 
)
static

◆ SetControlStringValue()

virtual void wxPGTextCtrlEditor::SetControlStringValue ( wxPGProperty property,
wxWindow ctrl,
const wxString txt 
) const
virtual

Sets control's value specifically from string.

Reimplemented from wxPGEditor.

◆ UpdateControl()

virtual void wxPGTextCtrlEditor::UpdateControl ( wxPGProperty property,
wxWindow ctrl 
) const
virtual

Loads value from property to the control.

Implements wxPGEditor.