wxPropertyGrid
Public Member Functions | Static Public Member Functions | List of all members
wxPGTextCtrlEditor Class Reference
Inheritance diagram for wxPGTextCtrlEditor:
wxPGEditor wxPGTextCtrlAndButtonEditor

Public Member Functions

virtual wxPGWindowList CreateControls (wxPropertyGrid *propgrid, wxPGProperty *property, const wxPoint &pos, const wxSize &sz) const
 Instantiates editor controls. More...
 
virtual bool GetValueFromControl (wxVariant &variant, wxPGProperty *property, wxWindow *ctrl) const
 Returns value from control, via parameter 'variant'. More...
 
virtual bool OnEvent (wxPropertyGrid *propgrid, wxPGProperty *property, wxWindow *primary, wxEvent &event) const
 Handles events. More...
 
virtual void OnFocus (wxPGProperty *property, wxWindow *wnd) const
 Extra processing when control gains focus. More...
 
virtual void SetControlStringValue (wxPGProperty *property, wxWindow *ctrl, const wxString &txt) const
 Sets control's value specifically from string. More...
 
virtual void SetValueToUnspecified (wxPGProperty *property, wxWindow *ctrl) const
 Sets value in control to unspecified. More...
 
virtual void UpdateControl (wxPGProperty *property, wxWindow *ctrl) const
 Loads value from property to the control. More...
 
- Public Member Functions inherited from wxPGEditor
bool ActualGetValueFromControl (wxVariant &variant, wxPGProperty *property, wxWindow *ctrl) const
 
virtual bool CanContainCustomImage () const
 Returns true if control itself can contain the custom image. More...
 
virtual void DeleteItem (wxWindow *ctrl, int index) const
 Deletes item from existing control. More...
 
virtual void DrawValue (wxDC &dc, const wxRect &rect, wxPGProperty *property, const wxString &text) const
 Used to get the renderer to draw the value with when the control is hidden. More...
 
virtual wxPG_CONST_WXCHAR_PTR GetName () const =0
 Returns pointer to the name of the editor. More...
 
virtual int InsertItem (wxWindow *ctrl, const wxString &label, int index) const
 Inserts item to existing control. More...
 
virtual void SetControlIntValue (wxPGProperty *property, wxWindow *ctrl, int value) const
 Sets control's value specifically from int (applies to choice etc.). More...
 
 wxPGEditor ()
 Constructor. More...
 
virtual ~wxPGEditor ()
 Destructor. More...
 

Static Public Member Functions

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

Member Function Documentation

◆ CreateControls()

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

Instantiates editor controls.

Remarks
  • Primary control shall use id wxPG_SUBID1, and secondary (button) control shall use wxPG_SUBID2.
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).

Implements wxPGEditor.

Reimplemented in wxPGTextCtrlAndButtonEditor.

◆ 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).

Implements wxPGEditor.

◆ 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.

◆ SetControlStringValue()

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

Sets control's value specifically from string.

Reimplemented from wxPGEditor.

◆ SetValueToUnspecified()

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

Sets value in control to unspecified.

Implements wxPGEditor.

◆ UpdateControl()

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

Loads value from property to the control.

Implements wxPGEditor.


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