Logo Search packages:      
Sourcecode: codeblocks version File versions  Download package

Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends

wxPropertyGrid Class Reference

wxPropertyGrid is a specialized two-column grid for editing properties such as strings, numbers, flagsets, fonts, and colours. wxPropertySheet used to do the very same thing, but it hasn't been updated for a while and it is currently deprecated. More...

#include <propgrid.h>

Inheritance diagram for wxPropertyGrid:
Inheritance graph
Collaboration diagram for wxPropertyGrid:
Collaboration graph

List of all members.

Public Member Functions

void AddPropertyChoice (wxPGId id, const wxString &label, int value=wxPG_INVALID_VALUE)
void AddPropertyChoice (wxPGPropNameStr name, const wxString &label, int value=wxPG_INVALID_VALUE)
wxPGId Append (const wxString &label, const wxString &name=wxPG_LABEL, double value=0.0)
wxPGId Append (const wxString &label, const wxString &name=wxPG_LABEL, bool value=false)
wxPGId Append (wxPGProperty *property)
wxPGId Append (const wxString &label, const wxString &name=wxPG_LABEL, const wxString &value=wxEmptyString)
wxPGId Append (const wxString &label, const wxString &name=wxPG_LABEL, int value=0)
wxPGId AppendCategory (const wxString &label, const wxString &name=wxPG_LABEL)
wxPGId AppendIn (wxPGId id, wxPGProperty *property)
wxPGId AppendIn (wxPGPropNameStr name, wxPGProperty *property)
wxPGId AppendIn (wxPGId id, const wxString &label, const wxString &propname, wxVariant &value)
wxPGId AppendIn (wxPGPropNameStr name, const wxString &label, const wxString &propname, wxVariant &value)
void BeginAddChildren (wxPGId id)
void BeginAddChildren (wxPGPropNameStr name)
bool CanClose ()
void CenterSplitter (bool enable_auto_centering=false)
void Clear ()
void ClearInternalFlag (long flag)
void ClearModifiedStatus (wxPGId id)
void ClearModifiedStatus ()
bool ClearPropertyValue (wxPGId id)
bool ClearPropertyValue (wxPGPropNameStr name)
bool ClearSelection ()
void ClearTargetPage ()
bool Collapse (wxPGId id)
bool Collapse (wxPGPropNameStr name)
bool CollapseAll ()
bool Compact (bool compact)
bool Create (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxPG_DEFAULT_STYLE, const wxChar *name=wxPropertyGridNameStr)
void DecFrozen ()
void Delete (wxPGId id)
void Delete (wxPGPropNameStr name)
void DeletePropertyChoice (wxPGPropNameStr name, int index)
void DeletePropertyChoice (wxPGId id, int index)
bool Disable (wxPGId id)
bool Disable (wxPGPropNameStr name)
bool DisableProperty (wxPGPropNameStr name)
bool DisableProperty (wxPGId id)
void EditorsValueWasModified ()
void EditorsValueWasNotModified ()
bool EditorValidate ()
bool EnableCategories (bool enable)
bool EnableProperty (wxPGId id, bool enable=true)
bool EnableProperty (wxPGPropNameStr name, bool enable=true)
void EndAddChildren (wxPGId id)
void EndAddChildren (wxPGPropNameStr name)
bool EnsureVisible (wxPGId id)
bool EnsureVisible (wxPGPropNameStr name)
bool Expand (wxPGId id)
bool Expand (wxPGPropNameStr name)
void ExpandAll ()
void FixPosForTextCtrl (wxWindow *ctrl)
wxWindow * GenerateEditorButton (const wxPoint &pos, const wxSize &sz)
wxWindow * GenerateEditorTextCtrl (const wxPoint &pos, const wxSize &sz, const wxString &value, wxWindow *secondary, int extraStyle=0, int maxLen=0)
wxWindow * GenerateEditorTextCtrlAndButton (const wxPoint &pos, const wxSize &sz, wxWindow **psecondary, int limited_editing, wxPGProperty *property)
unsigned int GetBottomY () const
wxColour GetCaptionBackgroundColour () const
wxFont & GetCaptionFont ()
wxColour GetCaptionForegroundColour () const
wxColour GetCellBackgroundColour () const
wxColour GetCellDisabledTextColour () const
wxColour GetCellTextColour () const
size_t GetChildrenCount ()
size_t GetChildrenCount (wxPGId id) const
size_t GetChildrenCount (wxPGPropNameStr name)
wxWindow * GetEditorControl () const
wxWindow * GetEditorControlSecondary () const
wxPGId GetFirst () const
wxPGId GetFirstCategory () const
wxPGId GetFirstChild (wxPGId id)
wxPGId GetFirstChild (wxPGPropNameStr name)
wxPGId GetFirstProperty ()
wxPGId GetFirstVisible () const
int GetFontHeight () const
wxPoint GetGoodEditorDialogPosition (wxPGProperty *p, const wxSize &sz)
wxPropertyGridGetGrid ()
wxSize GetImageSize (wxPGId id=wxPGIdGen((wxPGProperty *) NULL)) const
long GetInternalFlags () const
wxPGId GetItemAtY (int y)
wxPGId GetLastChild (wxPGId id)
wxPGId GetLastChild (wxPGPropNameStr name)
wxPGId GetLastProperty ()
wxPGId GetLastVisible ()
wxColour GetLineColour () const
wxColour GetMarginColour () const
wxPGId GetNextCategory (wxPGId id) const
wxPGId GetNextProperty (wxPGId id)
wxPGId GetNextSiblingProperty (wxPGId id)
wxPGId GetNextSiblingProperty (wxPGPropNameStr name)
wxPGId GetNextVisible (wxPGId property) const
wxPGId GetPrevProperty (wxPGId id)
wxPGId GetPrevSiblingProperty (wxPGId id)
wxPGId GetPrevSiblingProperty (wxPGPropNameStr name)
wxPGId GetPrevVisible (wxPGId id)
wxWindow * GetPrimaryEditor () const
wxString GetPropertyAttributes (wxPGId id, unsigned int flagmask=0xFFFF) const
wxColour GetPropertyBackgroundColour (wxPGId id) const
wxColour GetPropertyBackgroundColour (wxPGPropNameStr name) const
wxPGId GetPropertyByLabel (const wxString &name) const
wxPGId GetPropertyByName (wxPGPropNameStr name) const
wxPGId GetPropertyByName (wxPGPropNameStr name, wxPGPropNameStr subname) const
wxPGId GetPropertyByNameA (wxPGPropNameStr name) const
wxPGId GetPropertyCategory (wxPGId id) const
wxPGId GetPropertyCategory (wxPGPropNameStr name) const
wxPGChoicesGetPropertyChoices (wxPGId id)
wxPGChoicesGetPropertyChoices (wxPGPropNameStr name)
wxPG_CONST_WXCHAR_PTR GetPropertyClassName (wxPGId id) const
wxPG_CONST_WXCHAR_PTR GetPropertyClassName (wxPGPropNameStr name) const
wxPGProperty::ClientDataType GetPropertyClientData (wxPGId id) const
wxPGProperty::ClientDataType GetPropertyClientData (wxPGPropNameStr name) const
wxColour GetPropertyColour (wxPGId id) const
wxColour GetPropertyColour (wxPGPropNameStr name) const
const wxPGEditorGetPropertyEditor (wxPGId id) const
const wxPGEditorGetPropertyEditor (wxPGPropNameStr name) const
wxString GetPropertyHelpString (wxPGId id) const
wxString GetPropertyHelpString (wxPGPropNameStr name) const
wxBitmap * GetPropertyImage (wxPGId id) const
wxBitmap * GetPropertyImage (wxPGPropNameStr name) const
unsigned int GetPropertyIndex (wxPGPropNameStr name)
unsigned int GetPropertyIndex (wxPGId id)
const wxString & GetPropertyLabel (wxPGId id)
const wxString & GetPropertyLabel (wxPGPropNameStr name)
const wxString & GetPropertyName (wxPGId id)
wxPGId GetPropertyParent (wxPGId id)
wxPGId GetPropertyParent (wxPGPropNameStr name)
int GetPropertyPriority (wxPGId id)
int GetPropertyPriority (wxPGPropNameStr name)
wxPGPropertyGetPropertyPtr (wxPGId id) const
wxPGPropertyGetPropertyPtr (wxPGPropNameStr name) const
wxRect GetPropertyRect (const wxPGProperty *p1, const wxPGProperty *p2) const
wxPG_PYTHON_STATIC wxString GetPropertyShortClassName (wxPGId id)
wxColour GetPropertyTextColour (wxPGId id) const
wxColour GetPropertyTextColour (wxPGPropNameStr name) const
wxValidator * GetPropertyValidator (wxPGId id)
wxValidator * GetPropertyValidator (wxPGPropNameStr name)
wxVariant GetPropertyValue (wxPGId id)
wxVariant GetPropertyValue (wxPGPropNameStr name)
wxArrayInt & 
GetPropertyValueAsArrayInt (wxPGId id) wxPG_GETVALUE_CONST
const wxArrayInt & GetPropertyValueAsArrayInt (wxPGPropNameStr name) const
wxArrayString & 
GetPropertyValueAsArrayString (wxPGId id) wxPG_GETVALUE_CONST
const wxArrayString & GetPropertyValueAsArrayString (wxPGPropNameStr name) const
wxPG_PYTHON_STATIC bool GetPropertyValueAsBool (wxPGId id) wxPG_GETVALUE_CONST
bool GetPropertyValueAsBool (wxPGPropNameStr name) const
wxDateTime GetPropertyValueAsDateTime (wxPGPropNameStr name) const
wxPG_PYTHON_STATIC wxDateTime GetPropertyValueAsDateTime (wxPGId id) wxPG_GETVALUE_CONST
wxPG_PYTHON_STATIC double GetPropertyValueAsDouble (wxPGId id) wxPG_GETVALUE_CONST
double GetPropertyValueAsDouble (wxPGPropNameStr name) const
wxPG_PYTHON_STATIC int GetPropertyValueAsInt (wxPGId id) wxPG_GETVALUE_CONST
int GetPropertyValueAsInt (wxPGPropNameStr name) const
wxPG_PYTHON_STATIC long GetPropertyValueAsLong (wxPGId id) wxPG_GETVALUE_CONST
long GetPropertyValueAsLong (wxPGPropNameStr name) const
wxLongLong & 
GetPropertyValueAsLongLong (wxPGId id) wxPG_GETVALUE_CONST
const wxPoint & GetPropertyValueAsPoint (wxPGPropNameStr name) const
wxPG_PYTHON_STATIC const wxPoint & GetPropertyValueAsPoint (wxPGId id) wxPG_GETVALUE_CONST
const wxSize & GetPropertyValueAsSize (wxPGPropNameStr name) const
wxPG_PYTHON_STATIC const wxSize & GetPropertyValueAsSize (wxPGId id) wxPG_GETVALUE_CONST
wxPG_PYTHON_STATIC wxString GetPropertyValueAsString (wxPGId id) wxPG_GETVALUE_CONST
wxString GetPropertyValueAsString (wxPGPropNameStr name) const
wxULongLong & 
GetPropertyValueAsULongLong (wxPGId id) wxPG_GETVALUE_CONST
wxPG_PYTHON_STATIC void * GetPropertyValueAsVoidPtr (wxPGId id) wxPG_GETVALUE_CONST
wxPG_PYTHON_STATIC const wxObject * GetPropertyValueAsWxObjectPtr (wxPGId id) wxPG_GETVALUE_CONST
const wxObject * GetPropertyValueAsWxObjectPtr (wxPGPropNameStr name) const
wxVariant GetPropertyValues (const wxString &listname=wxEmptyString, wxPGId baseparent=wxPGIdGen((wxPGProperty *) NULL), long flags=0) const
wxPG_VALUETYPE_MSGVAL GetPropertyValueType (wxPGId id)
wxPG_VALUETYPE_MSGVAL GetPropertyValueType (wxPGPropNameStr name)
size_t GetPVTI (wxPGId id)
size_t GetPVTI (wxPGPropNameStr name)
wxString GetPVTN (wxPGId id)
wxString GetPVTN (wxPGPropNameStr name)
wxPGId GetRoot () const
int GetRowHeight () const
wxPGId GetSelectedProperty () const
wxPGId GetSelection () const
wxColour GetSelectionBackgroundColour () const
wxColour GetSelectionForegroundColour () const
int GetSplitterPosition () const
wxPropertyGridStateGetState () const
int GetVerticalSpacing () const
bool HasSelection () const
void HideLowPriority ()
bool HideProperty (wxPGId id, bool hide=true)
bool HideProperty (wxPGPropNameStr name)
void IgnoredEventPasses ()
void IgnoreNextEvent ()
void IncFrozen ()
wxPGId Insert (wxPGId priorthis, wxPGProperty *newproperty)
wxPGId Insert (wxPGPropNameStr name, wxPGProperty *newproperty)
wxPGId Insert (wxPGId id, int index, wxPGProperty *newproperty)
wxPGId Insert (wxPGPropNameStr name, int index, wxPGProperty *newproperty)
wxPGId Insert (wxPGId id, int index, const wxString &label, const wxString &name, const wxString &value=wxEmptyString)
wxPGId Insert (wxPGId id, int index, const wxString &label, const wxString &name, int value)
wxPGId Insert (wxPGId id, int index, const wxString &label, const wxString &name, double value)
wxPGId Insert (wxPGId id, int index, const wxString &label, const wxString &name, bool value)
wxPGId InsertCategory (wxPGId id, int index, const wxString &label, const wxString &name=wxPG_LABEL)
void InsertPropertyChoice (wxPGId id, const wxString &label, int index, int value=wxPG_INVALID_VALUE)
void InsertPropertyChoice (wxPGPropNameStr name, const wxString &label, int index, int value=wxPG_INVALID_VALUE)
bool IsAnyModified () const
bool IsEditorsValueModified () const
bool IsFrozen () const
bool IsModified (wxPGPropNameStr name)
bool IsModified (wxPGId id) const
int IsNextEventIgnored () const
bool IsPropertyCategory (wxPGId id) const
bool IsPropertyCategory (wxPGPropNameStr name)
bool IsPropertyEnabled (wxPGPropNameStr name)
bool IsPropertyEnabled (wxPGId id) const
bool IsPropertyExpanded (wxPGPropNameStr name)
bool IsPropertyKindOf (wxPGPropNameStr name, wxPGPropertyClassInfo &info)
bool IsPropertyModified (wxPGId id) const
bool IsPropertyModified (wxPGPropNameStr name)
bool IsPropertySelected (wxPGId id) const
bool IsPropertySelected (wxPGPropNameStr name)
bool IsPropertyShown (wxPGId id) const
bool IsPropertyShown (wxPGPropNameStr name)
bool IsPropertyUnspecified (wxPGId id) const
bool IsPropertyUnspecified (wxPGPropNameStr name)
bool IsPropertyValueType (wxPGId id, const wxClassInfo *classinfo)
bool IsPropertyValueType (wxPGPropNameStr name, const wxPGValueType *valuetype)
bool IsPropertyValueType (wxPGPropNameStr name, const wxChar *typestr)
bool IsPropertyValueType (wxPGId id, const wxChar *typestr)
bool IsPropertyValueType (wxPGId id, const wxPGValueType *valuetype)
bool IsPropertyValueType (wxPGPropNameStr name, const wxClassInfo *classinfo)
void LimitPropertyEditing (wxPGId id, bool limit=true)
void LimitPropertyEditing (wxPGPropNameStr name, bool limit=true)
void OnComboItemPaint (wxPGCustomComboControl *pCb, int item, wxDC &dc, wxRect &rect, int flags)
void OnCustomEditorEvent (wxCommandEvent &event)
void PropertyWasModified (wxPGProperty *p, int selFlags=0)
wxPGId ReplaceProperty (wxPGId id, wxPGProperty *property)
wxPGId ReplaceProperty (wxPGPropNameStr name, wxPGProperty *property)
void ResetColours ()
void ResetDefaultPriority ()
bool SelectProperty (wxPGPropNameStr name, bool focus=false)
bool SelectProperty (wxPGId id, bool focus=false)
void SendNavigationKeyEvent (int dir)
void SetBottomY (unsigned int y)
void SetButtonShortcut (int keycode, bool ctrlDown=false, bool altDown=false)
void SetCaptionBackgroundColour (const wxColour &col)
void SetCaptionForegroundColour (const wxColour &col)
void SetCaptionTextColour (wxPGId id, const wxColour &col)
void SetCaptionTextColour (wxPGPropNameStr name, const wxColour &col)
void SetCellBackgroundColour (const wxColour &col)
void SetCellDisabledTextColour (const wxColour &col)
void SetCellTextColour (const wxColour &col)
void SetCurrentCategory (wxPGId id)
void SetCurrentCategory (wxPGPropNameStr name=wxEmptyString)
void SetDefaultPriority (int priority)
void SetLineColour (const wxColour &col)
void SetMarginColour (const wxColour &col)
void SetPropertyAttribute (wxPGId id, int attrid, wxVariant value, long argFlags=0)
void SetPropertyAttribute (wxPGPropNameStr name, int attrid, wxVariant value, long argFlags=0)
void SetPropertyAttributeAll (int attrid, wxVariant value)
void SetPropertyAttributes (wxPGPropNameStr name, const wxString &attributes) const
void SetPropertyBackgroundColour (wxPGPropNameStr name, const wxColour &col)
void SetPropertyBackgroundColour (wxPGId id, const wxColour &col)
void SetPropertyChoices (wxPGPropNameStr name, wxPGChoices &choices)
void SetPropertyChoicesExclusive (wxPGId id)
void SetPropertyChoicesExclusive (wxPGPropNameStr name)
void SetPropertyClientData (wxPGId id, wxPGProperty::ClientDataType clientData)
void SetPropertyClientData (wxPGPropNameStr name, wxPGProperty::ClientDataType clientData)
void SetPropertyColour (wxPGId id, const wxColour &col)
void SetPropertyColour (wxPGPropNameStr name, const wxColour &col)
void SetPropertyColourToDefault (wxPGId id)
void SetPropertyColourToDefault (wxPGPropNameStr name)
void SetPropertyEditor (wxPGPropNameStr name, const wxString &editorName)
void SetPropertyEditor (wxPGId id, const wxString &editorName)
void SetPropertyEditor (wxPGId id, const wxPGEditor *editor)
void SetPropertyEditor (wxPGPropNameStr name, const wxPGEditor *editor)
void SetPropertyHelpString (wxPGPropNameStr name, const wxString &helpString)
void SetPropertyHelpString (wxPGId id, const wxString &helpString)
void SetPropertyImage (wxPGPropNameStr name, wxBitmap &bmp)
void SetPropertyImage (wxPGId id, wxBitmap &bmp)
void SetPropertyLabel (wxPGPropNameStr name, const wxString &newproplabel)
void SetPropertyLabel (wxPGId id, const wxString &newproplabel)
bool SetPropertyMaxLength (wxPGPropNameStr name, int maxLen)
bool SetPropertyMaxLength (wxPGId id, int maxLen)
void SetPropertyName (wxPGId id, const wxString &newname)
void SetPropertyName (wxPGPropNameStr name, const wxString &newname)
bool SetPropertyPriority (wxPGId id, int priority)
bool SetPropertyPriority (wxPGPropNameStr name, int priority)
void SetPropertyReadOnly (wxPGPropNameStr name, bool readOnly=true)
void SetPropertyReadOnly (wxPGId id, bool readOnly=true)
void SetPropertyTextColour (wxPGId id, const wxColour &col)
void SetPropertyTextColour (wxPGPropNameStr name, const wxColour &col)
void SetPropertyUnspecified (wxPGPropNameStr name)
void SetPropertyUnspecified (wxPGId id)
void SetPropertyValidator (wxPGId id, const wxValidator &validator)
void SetPropertyValidator (wxPGPropNameStr name, const wxValidator &validator)
void SetPropertyValue (wxPGId id, int value)
void SetPropertyValue (wxPGPropNameStr name, void *value)
void SetPropertyValue (wxPGId id, void *value)
void SetPropertyValue (wxPGId id, const wxChar *value)
void SetPropertyValue (wxPGPropNameStr name, wxVariant &value)
void SetPropertyValue (wxPGPropNameStr name, wxObject &value)
void SetPropertyValue (wxPGId id, wxVariant &value)
void SetPropertyValue (wxPGPropNameStr name, const wxChar *value)
void SetPropertyValue (wxPGId id, wxObject &value)
void SetPropertyValue (wxPGPropNameStr name, int value)
void SetPropertyValueArrint2 (wxPGId id, const wxArrayInt &value)
void SetPropertyValueArrint2 (wxPGPropNameStr name, const wxArrayInt &value)
void SetPropertyValueArrstr2 (wxPGPropNameStr name, const wxArrayString &value)
void SetPropertyValueArrstr2 (wxPGId id, const wxArrayString &value)
void SetPropertyValueBool (wxPGPropNameStr name, bool value)
void SetPropertyValueBool (wxPGId id, bool value)
void SetPropertyValueDatetime (wxPGPropNameStr name, const wxDateTime &value)
void SetPropertyValueDatetime (wxPGId id, const wxDateTime &value)
void SetPropertyValueDouble (wxPGId id, double value)
void SetPropertyValueDouble (wxPGPropNameStr name, double value)
void SetPropertyValueLong (wxPGPropNameStr name, long value)
void SetPropertyValueLong (wxPGId id, long value)
void SetPropertyValueLongLong (wxPGPropNameStr name, const wxLongLong &value)
void SetPropertyValueLongLong (wxPGId id, const wxLongLong &value)
void SetPropertyValuePoint (wxPGId id, const wxPoint &value)
void SetPropertyValuePoint (wxPGPropNameStr name, const wxPoint &value)
void SetPropertyValues (const wxVariantList &list, const wxString &default_category=wxEmptyString)
void SetPropertyValues (const wxVariant &list, wxPGId default_category)
void SetPropertyValues (const wxVariantList &list, wxPGId default_category)
void SetPropertyValues (const wxVariant &list, const wxString &default_category=wxEmptyString)
void SetPropertyValueSize (wxPGId id, const wxSize &value)
void SetPropertyValueSize (wxPGPropNameStr name, const wxSize &value)
void SetPropertyValueString (wxPGId id, const wxString &value)
void SetPropertyValueString (wxPGPropNameStr name, const wxString &value)
void SetPropertyValueULongLong (wxPGId id, const wxULongLong &value)
void SetPropertyValueULongLong (wxPGPropNameStr name, const wxULongLong &value)
void SetPropertyValueWxObjectPtr (wxPGId id, wxObject *value)
void SetPropertyValueWxObjectPtr (wxPGPropNameStr name, wxObject *value)
void SetSelectionBackground (const wxColour &col)
void SetSelectionForeground (const wxColour &col)
void SetSplitterLeft (bool subProps=false)
void SetSplitterPosition (int newxpos, bool refresh=true)
void SetVerticalSpacing (int vspacing)
virtual void SetWindowStyleFlag (long style)
void ShowLowPriority ()
void ShowPropertyError (wxPGPropNameStr name, const wxString &msg)
void ShowPropertyError (wxPGId id, const wxString &msg)
void SLAlloc (unsigned int itemcount, const wxChar **items)
wxArrayString & SLGet ()
void Sort (wxPGPropNameStr name)
void Sort (wxPGId id)
void Sort ()
void SwitchState (wxPropertyGridState *pNewState)
void TogglePropertyPriority (wxPGPropNameStr name)
void TogglePropertyPriority (wxPGId id)
 wxPropertyGrid (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxPG_DEFAULT_STYLE, const wxChar *name=wxPropertyGridNameStr)
 wxPropertyGrid ()
virtual ~wxPropertyGrid ()

Static Public Member Functions

static void ArrayStringToString (wxString &dst, const wxArrayString &src, wxChar preDelim, wxChar postDelim, int flags)
static void AutoGetTranslation (bool enable)
static wxString & CreateEscapeSequences (wxString &dst_str, wxString &src_str)
static wxPGPropertyCreatePropertyByClass (const wxString &classname, const wxString &label, const wxString &name)
static wxPGPropertyCreatePropertyByType (const wxString &valuetype, const wxString &label, const wxString &name)
static void DoubleToString (wxString &target, double value, int precision, bool removeZeroes, wxString *precTemplate)
static wxString & ExpandEscapeSequences (wxString &dst_str, wxString &src_str)
static wxPGEditorGetEditorByName (const wxString &editorName)
static wxPGValueTypeGetValueType (const wxString &type)
static void InitAllTypeHandlers ()
static bool IsPropertyExpanded (wxPGId id)
static bool IsPropertyKindOf (wxPGId id, wxPGPropertyClassInfo &info)
static void RegisterAdditionalEditors ()
static void RegisterAdvancedPropertyClasses ()
static wxPGEditorRegisterEditorClass (wxPGEditor *editor, const wxString &name, bool noDefCheck=false)
static bool RegisterPropertyClass (const wxChar *name, wxPGPropertyClassInfo *classinfo)
static wxPGValueTypeRegisterValueType (wxPGValueType *valueclass, bool noDefCheck=false, const wxString &className=wxEmptyString)
static void SetBoolChoices (const wxChar *true_choice, const wxChar *false_choice)
static void SetPropertyAttributes (wxPGId id, const wxString &attributes)
static void SetPropertyChoices (wxPGId id, wxPGChoices &choices)

Protected Member Functions

virtual wxPropertyGridStateCreateState () const
virtual wxPGId DoGetPropertyByName (wxPGPropNameStr name) const
virtual void RefreshProperty (wxPGProperty *p)=0

Static Protected Member Functions

static void DoSetPropertyAttribute (wxPGId id, int attrid, wxVariant &value, long argFlags)

Protected Attributes

wxString m_emptyString


class wxPropertyContainerMethods
class wxPropertyGridManager
class wxPropertyGridState

Detailed Description

wxPropertyGrid is a specialized two-column grid for editing properties such as strings, numbers, flagsets, fonts, and colours. wxPropertySheet used to do the very same thing, but it hasn't been updated for a while and it is currently deprecated.

wxPropertyGrid is modeled after .NET propertygrid (hence the name), and thus features are similar. However, inorder to keep the widget lightweight, it does not (and will not) have toolbar for mode and page selection, nor the help text box. wxAdvancedPropertyGrid (or something similarly named) is planned to have these features in some distant future.

Derived from


Include files


Window styles

Additional Window Styles

Event handling

To process input from a propertygrid control, use these event handler macros to direct input to member functions that take a wxPropertyGridEvent argument.

EVT_PG_SELECTED (id, func)Property is selected.
EVT_PG_CHANGED (id, func)Property value is modified.
EVT_PG_HIGHLIGHTED (id, func)Mouse moves over property. Event's property is NULL if hovered on area that is not a property.
EVT_PG_RIGHT_CLICK (id, func)Mouse right-clicked on a property.
EVT_PG_DOUBLE_CLICK (id, func)Mouse double-clicked on a property.
EVT_PG_ITEM_COLLAPSED (id, func)User collapses a property or category.
EVT_PG_ITEM_EXPANDED (id, func)User expands a property or category.
EVT_BUTTON (id, func)Button in a property editor was clicked. Only occurs if the property doesn't handle button clicks itself.
EVT_TEXT (id, func)wxTextCtrl based editor was updated (but property value was not yet modified)
See also:

For code examples, see the main page.

Definition at line 4853 of file propgrid.h.

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

Generated by  Doxygen 1.6.0   Back to index