#include <propgrid.h>
Inheritance diagram for wxPropertyGrid:
[NOHEADER] | |
void | EditorsValueWasModified () |
void | EditorsValueWasNotModified () |
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) |
wxWindow * | GetEditorControl () const |
wxWindow * | GetEditorControlSecondary () const |
wxPoint | GetGoodEditorDialogPosition (wxPGProperty *p, const wxSize &sz) |
wxWindow * | GetPrimaryEditor () const |
wxRect | GetPropertyRect (const wxPGProperty *p1, const wxPGProperty *p2) const |
void | IgnoredEventPasses () |
void | IgnoreNextEvent () |
bool | IsEditorsValueModified () const |
int | IsNextEventIgnored () const |
void | OnCustomEditorEvent (wxCommandEvent &event) |
void | SLAlloc (unsigned int itemcount, const wxChar **items) |
wxArrayString & | SLGet () |
void | ArrayStringToString (wxString &dst, const wxArrayString &src, wxChar preDelim, wxChar postDelim, int flags) |
wxString & | CreateEscapeSequences (wxString &dst_str, wxString &src_str) |
wxString & | ExpandEscapeSequences (wxString &dst_str, wxString &src_str) |
Public Member Functions | |
void | AddPropertyChoice (const wxString &name, const wxString &label, int value=INT_MAX) |
void | AddPropertyChoice (wxPGId id, const wxString &label, int value=INT_MAX) |
wxPGId | Append (const wxString &label, const wxString &name=(*((wxString *) NULL)), bool value=false) |
wxPGId | Append (const wxString &label, const wxString &name=(*((wxString *) NULL)), double value=0.0) |
wxPGId | Append (const wxString &label, const wxString &name=(*((wxString *) NULL)), int value=0) |
wxPGId | Append (const wxString &label, const wxString &name=(*((wxString *) NULL)), const wxString &value=wxEmptyString) |
wxPGId | Append (wxPGProperty *property) |
wxPGId | AppendCategory (const wxString &label, const wxString &name=(*((wxString *) NULL))) |
wxPGId | AppendIn (const wxString &name, const wxString &label, const wxString &propname, wxVariant &value) |
wxPGId | AppendIn (wxPGId id, const wxString &label, const wxString &propname, wxVariant &value) |
wxPGId | AppendIn (const wxString &name, wxPGProperty *property) |
wxPGId | AppendIn (wxPGId id, wxPGProperty *property) |
void | BeginAddChildren (const wxString &name) |
void | BeginAddChildren (wxPGId id) |
bool | CanClose () |
void | CenterSplitter (bool enable_auto_centering=false) |
void | Clear () |
void | ClearInternalFlag (long flag) |
void | ClearModifiedStatus () |
void | ClearModifiedStatus (wxPGId id) |
bool | ClearPropertyValue (const wxString &name) |
bool | ClearPropertyValue (wxPGId id) |
bool | ClearSelection () |
void | ClearTargetPage () |
bool | Collapse (const wxString &name) |
bool | Collapse (wxPGId id) |
bool | CollapseAll () |
bool | Compact (bool compact) |
bool | Create (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=(0), const wxChar *name=wxPropertyGridNameStr) |
void | DecFrozen () |
void | Delete (const wxString &name) |
void | Delete (wxPGId id) |
void | DeletePropertyChoice (const wxString &name, int index) |
void | DeletePropertyChoice (wxPGId id, int index) |
bool | Disable (const wxString &name) |
bool | Disable (wxPGId id) |
bool | DisableProperty (const wxString &name) |
bool | DisableProperty (wxPGId id) |
bool | EditorValidate () |
bool | EnableCategories (bool enable) |
bool | EnableProperty (const wxString &name, bool enable=true) |
bool | EnableProperty (wxPGId id, bool enable=true) |
void | EndAddChildren (const wxString &name) |
void | EndAddChildren (wxPGId id) |
bool | EnsureVisible (const wxString &name) |
bool | EnsureVisible (wxPGId id) |
bool | Expand (const wxString &name) |
bool | Expand (wxPGId id) |
void | ExpandAll () |
unsigned int | GetBottomY () const |
wxColour | GetCaptionBackgroundColour () const |
wxFont & | GetCaptionFont () |
wxColour | GetCaptionForegroundColour () const |
wxColour | GetCellBackgroundColour () const |
wxColour | GetCellDisabledTextColour () const |
wxColour | GetCellTextColour () const |
size_t | GetChildrenCount (const wxString &name) |
size_t | GetChildrenCount (wxPGId id) const |
size_t | GetChildrenCount () |
wxPGId | GetFirst () const |
wxPGId | GetFirstCategory () const |
wxPGId | GetFirstChild (const wxString &name) |
wxPGId | GetFirstChild (wxPGId id) |
wxPGId | GetFirstProperty () |
wxPGId | GetFirstVisible () const |
int | GetFontHeight () const |
wxPropertyGrid * | GetGrid () |
wxSize | GetImageSize (wxPGId id=wxPGId((wxPGProperty *) NULL)) const |
long | GetInternalFlags () const |
wxPGId | GetItemAtY (int y) |
wxPGId | GetLastChild (const wxString &name) |
wxPGId | GetLastChild (wxPGId id) |
wxPGId | GetLastProperty () |
wxPGId | GetLastVisible () |
wxColour | GetLineColour () const |
wxColour | GetMarginColour () const |
wxPGId | GetNextCategory (wxPGId id) const |
wxPGId | GetNextProperty (wxPGId id) |
wxPGId | GetNextSibling (const wxString &name) |
wxPGId | GetNextSibling (wxPGId id) |
wxPGId | GetNextVisible (wxPGId property) const |
wxPGId | GetPrevProperty (wxPGId id) |
wxPGId | GetPrevSibling (const wxString &name) |
wxPGId | GetPrevSibling (wxPGId id) |
wxPGId | GetPrevVisible (wxPGId id) |
wxString | GetPropertyAttributes (wxPGId id, unsigned int flagmask=0xFFFF) const |
wxColour | GetPropertyBackgroundColour (const wxString &name) const |
wxColour | GetPropertyBackgroundColour (wxPGId id) const |
wxPGId | GetPropertyByLabel (const wxString &name) const |
wxPGId | GetPropertyByName (const wxString &name, const wxString &subname) const |
wxPGId | GetPropertyByName (const wxString &name) const |
wxPGId | GetPropertyByNameA (const wxString &name) const |
wxPGId | GetPropertyCategory (const wxString &name) const |
wxPGId | GetPropertyCategory (wxPGId id) const |
wxPGChoices & | GetPropertyChoices (const wxString &name) |
wxPGChoices & | GetPropertyChoices (wxPGId id) |
const wxChar * | GetPropertyClassName (const wxString &name) const |
const wxChar * | GetPropertyClassName (wxPGId id) const |
wxPGProperty::ClientDataType | GetPropertyClientData (const wxString &name) const |
wxPGProperty::ClientDataType | GetPropertyClientData (wxPGId id) const |
wxColour | GetPropertyColour (const wxString &name) const |
wxColour | GetPropertyColour (wxPGId id) const |
const wxPGEditor * | GetPropertyEditor (const wxString &name) const |
const wxPGEditor * | GetPropertyEditor (wxPGId id) const |
wxString | GetPropertyHelpString (const wxString &name) const |
wxString | GetPropertyHelpString (wxPGId id) const |
wxBitmap * | GetPropertyImage (const wxString &name) const |
wxBitmap * | GetPropertyImage (wxPGId id) const |
unsigned int | GetPropertyIndex (const wxString &name) |
unsigned int | GetPropertyIndex (wxPGId id) |
const wxString & | GetPropertyLabel (const wxString &name) |
const wxString & | GetPropertyLabel (wxPGId id) |
const wxString & | GetPropertyName (wxPGId id) |
wxPGId | GetPropertyParent (const wxString &name) |
wxPGId | GetPropertyParent (wxPGId id) |
int | GetPropertyPriority (const wxString &name) |
int | GetPropertyPriority (wxPGId id) |
wxPGProperty * | GetPropertyPtr (const wxString &name) const |
wxPGProperty * | GetPropertyPtr (wxPGId id) const |
wxColour | GetPropertyTextColour (const wxString &name) const |
wxColour | GetPropertyTextColour (wxPGId id) const |
wxValidator * | GetPropertyValidator (const wxString &name) |
wxValidator * | GetPropertyValidator (wxPGId id) |
wxVariant | GetPropertyValue (const wxString &name) |
wxVariant | GetPropertyValue (wxPGId id) |
const wxArrayInt & | GetPropertyValueAsArrayInt (const wxString &name) const |
const wxArrayString & | GetPropertyValueAsArrayString (const wxString &name) const |
bool | GetPropertyValueAsBool (const wxString &name) const |
wxDateTime | GetPropertyValueAsDateTime (const wxString &name) const |
double | GetPropertyValueAsDouble (const wxString &name) const |
int | GetPropertyValueAsInt (const wxString &name) const |
long | GetPropertyValueAsLong (const wxString &name) const |
const wxPoint & | GetPropertyValueAsPoint (const wxString &name) const |
const wxSize & | GetPropertyValueAsSize (const wxString &name) const |
wxString | GetPropertyValueAsString (const wxString &name) const |
const wxObject * | GetPropertyValueAsWxObjectPtr (const wxString &name) const |
wxVariant | GetPropertyValues (const wxString &listname=wxEmptyString, wxPGId baseparent=wxPGId((wxPGProperty *) NULL), long flags=0) const |
const wxPGValueType * | GetPropertyValueType (const wxString &name) |
const wxPGValueType * | GetPropertyValueType (wxPGId id) |
size_t | GetPVTI (const wxString &name) |
size_t | GetPVTI (wxPGId id) |
wxString | GetPVTN (const wxString &name) |
wxString | GetPVTN (wxPGId id) |
wxPGId | GetRoot () const |
int | GetRowHeight () const |
wxPGId | GetSelectedProperty () const |
wxPGId | GetSelection () const |
wxColour | GetSelectionBackgroundColour () const |
wxColour | GetSelectionForegroundColour () const |
int | GetSplitterPosition () const |
wxPropertyGridState * | GetState () const |
int | GetVerticalSpacing () const |
bool | HasSelection () const |
void | HideLowPriority () |
bool | HideProperty (const wxString &name) |
bool | HideProperty (wxPGId id, bool hide=true) |
void | IncFrozen () |
wxPGId | Insert (wxPGId id, int index, const wxString &label, const wxString &name, bool 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, int value) |
wxPGId | Insert (wxPGId id, int index, const wxString &label, const wxString &name, const wxString &value=wxEmptyString) |
wxPGId | Insert (const wxString &name, int index, wxPGProperty *newproperty) |
wxPGId | Insert (wxPGId id, int index, wxPGProperty *newproperty) |
wxPGId | Insert (const wxString &name, wxPGProperty *newproperty) |
wxPGId | Insert (wxPGId priorthis, wxPGProperty *newproperty) |
wxPGId | InsertCategory (wxPGId id, int index, const wxString &label, const wxString &name=(*((wxString *) NULL))) |
void | InsertPropertyChoice (const wxString &name, const wxString &label, int index, int value=INT_MAX) |
void | InsertPropertyChoice (wxPGId id, const wxString &label, int index, int value=INT_MAX) |
bool | IsAnyModified () const |
bool | IsFrozen () const |
bool | IsModified (const wxString &name) |
bool | IsModified (wxPGId id) const |
bool | IsPropertyCategory (const wxString &name) |
bool | IsPropertyCategory (wxPGId id) const |
bool | IsPropertyEnabled (const wxString &name) |
bool | IsPropertyEnabled (wxPGId id) const |
bool | IsPropertyExpanded (const wxString &name) |
bool | IsPropertyKindOf (const wxString &name, wxPGPropertyClassInfo &info) |
bool | IsPropertyModified (const wxString &name) |
bool | IsPropertyModified (wxPGId id) const |
bool | IsPropertySelected (const wxString &name) |
bool | IsPropertySelected (wxPGId id) const |
bool | IsPropertyShown (const wxString &name) |
bool | IsPropertyShown (wxPGId id) const |
bool | IsPropertyUnspecified (const wxString &name) |
bool | IsPropertyUnspecified (wxPGId id) const |
bool | IsPropertyValueType (const wxString &name, const wxClassInfo *classinfo) |
bool | IsPropertyValueType (const wxString &name, const wxPGValueType *valuetype) |
bool | IsPropertyValueType (const wxString &name, const wxChar *typestr) |
bool | IsPropertyValueType (wxPGId id, const wxClassInfo *classinfo) |
bool | IsPropertyValueType (wxPGId id, const wxPGValueType *valuetype) |
bool | IsPropertyValueType (wxPGId id, const wxChar *typestr) |
void | LimitPropertyEditing (const wxString &name, bool limit=true) |
void | LimitPropertyEditing (wxPGId id, bool limit=true) |
void | OnComboItemPaint (wxPGCustomComboControl *pCb, int item, wxDC &dc, wxRect &rect, int flags) |
void | PropertyWasModified (wxPGProperty *p, int selFlags=0) |
wxPGId | ReplaceProperty (const wxString &name, wxPGProperty *property) |
wxPGId | ReplaceProperty (wxPGId id, wxPGProperty *property) |
void | ResetColours () |
void | ResetDefaultPriority () |
bool | SelectProperty (const wxString &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 (const wxString &name, const wxColour &col) |
void | SetCaptionTextColour (wxPGId id, const wxColour &col) |
void | SetCellBackgroundColour (const wxColour &col) |
void | SetCellDisabledTextColour (const wxColour &col) |
void | SetCellTextColour (const wxColour &col) |
void | SetCurrentCategory (const wxString &name=wxEmptyString) |
void | SetCurrentCategory (wxPGId id) |
void | SetDefaultPriority (int priority) |
void | SetLineColour (const wxColour &col) |
void | SetMarginColour (const wxColour &col) |
void | SetPropertyAttribute (const wxString &name, int attrid, wxVariant value, long argFlags=0) |
void | SetPropertyAttribute (wxPGId id, int attrid, wxVariant value, long argFlags=0) |
void | SetPropertyAttributeAll (int attrid, wxVariant value) |
void | SetPropertyAttributes (const wxString &name, const wxString &attributes) const |
void | SetPropertyBackgroundColour (const wxString &name, const wxColour &col) |
void | SetPropertyBackgroundColour (wxPGId id, const wxColour &col) |
void | SetPropertyChoices (const wxString &name, wxPGChoices &choices) |
void | SetPropertyChoicesExclusive (const wxString &name) |
void | SetPropertyChoicesExclusive (wxPGId id) |
void | SetPropertyClientData (const wxString &name, wxPGProperty::ClientDataType clientData) |
void | SetPropertyClientData (wxPGId id, wxPGProperty::ClientDataType clientData) |
void | SetPropertyColour (const wxString &name, const wxColour &col) |
void | SetPropertyColour (wxPGId id, const wxColour &col) |
void | SetPropertyColourToDefault (const wxString &name) |
void | SetPropertyColourToDefault (wxPGId id) |
void | SetPropertyEditor (const wxString &name, const wxString &editorName) |
void | SetPropertyEditor (wxPGId id, const wxString &editorName) |
void | SetPropertyEditor (const wxString &name, const wxPGEditor *editor) |
void | SetPropertyEditor (wxPGId id, const wxPGEditor *editor) |
void | SetPropertyHelpString (const wxString &name, const wxString &helpString) |
void | SetPropertyHelpString (wxPGId id, const wxString &helpString) |
void | SetPropertyImage (const wxString &name, wxBitmap &bmp) |
void | SetPropertyImage (wxPGId id, wxBitmap &bmp) |
void | SetPropertyLabel (const wxString &name, const wxString &newproplabel) |
void | SetPropertyLabel (wxPGId id, const wxString &newproplabel) |
bool | SetPropertyMaxLength (const wxString &name, int maxLen) |
bool | SetPropertyMaxLength (wxPGId id, int maxLen) |
void | SetPropertyName (const wxString &name, const wxString &newname) |
void | SetPropertyName (wxPGId id, const wxString &newname) |
bool | SetPropertyPriority (const wxString &name, int priority) |
bool | SetPropertyPriority (wxPGId id, int priority) |
void | SetPropertyReadOnly (const wxString &name, bool readOnly=true) |
void | SetPropertyReadOnly (wxPGId id, bool readOnly=true) |
void | SetPropertyTextColour (const wxString &name, const wxColour &col) |
void | SetPropertyTextColour (wxPGId id, const wxColour &col) |
void | SetPropertyUnspecified (const wxString &name) |
void | SetPropertyUnspecified (wxPGId id) |
void | SetPropertyValidator (const wxString &name, const wxValidator &validator) |
void | SetPropertyValidator (wxPGId id, const wxValidator &validator) |
void | SetPropertyValue (const wxString &name, const wxULongLong &value) |
void | SetPropertyValue (const wxString &name, const wxLongLong &value) |
void | SetPropertyValue (const wxString &name, const wxSize &value) |
void | SetPropertyValue (const wxString &name, const wxPoint &value) |
void | SetPropertyValue (const wxString &name, const wxDateTime &value) |
void | SetPropertyValue (const wxString &name, const wxArrayInt &value) |
void | SetPropertyValue (const wxString &name, const wxArrayString &value) |
void | SetPropertyValue (const wxString &name, wxVariant &value) |
void | SetPropertyValue (const wxString &name, wxObject &value) |
void | SetPropertyValue (const wxString &name, wxObject *value) |
void | SetPropertyValue (const wxString &name, void *value) |
void | SetPropertyValue (const wxString &name, const wxChar *value) |
void | SetPropertyValue (const wxString &name, const wxString &value) |
void | SetPropertyValue (const wxString &name, bool value) |
void | SetPropertyValue (const wxString &name, double value) |
void | SetPropertyValue (const wxString &name, int value) |
void | SetPropertyValue (const wxString &name, long value) |
void | SetPropertyValue (wxPGId id, const wxDateTime &value) |
void | SetPropertyValue (wxPGId id, const wxArrayInt &value) |
void | SetPropertyValue (wxPGId id, const wxULongLong &value) |
void | SetPropertyValue (wxPGId id, const wxLongLong &value) |
void | SetPropertyValue (wxPGId id, const wxSize &value) |
void | SetPropertyValue (wxPGId id, const wxPoint &value) |
void | SetPropertyValue (wxPGId id, wxVariant &value) |
void | SetPropertyValue (wxPGId id, wxObject &value) |
void | SetPropertyValue (wxPGId id, void *value) |
void | SetPropertyValue (wxPGId id, wxObject *value) |
void | SetPropertyValue (wxPGId id, const wxArrayString &value) |
void | SetPropertyValue (wxPGId id, const wxChar *value) |
void | SetPropertyValue (wxPGId id, const wxString &value) |
void | SetPropertyValue (wxPGId id, bool value) |
void | SetPropertyValue (wxPGId id, double value) |
void | SetPropertyValue (wxPGId id, int value) |
void | SetPropertyValue (wxPGId id, long value) |
void | SetPropertyValues (const wxVariant &list, const wxString &default_category=wxEmptyString) |
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 | 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 (const wxString &name, const wxString &msg) |
void | ShowPropertyError (wxPGId id, const wxString &msg) |
void | Sort (const wxString &name) |
void | Sort (wxPGId id) |
void | Sort () |
void | SwitchState (wxPropertyGridState *pNewState) |
void | TogglePropertyPriority (const wxString &name) |
void | TogglePropertyPriority (wxPGId id) |
wxPropertyGrid (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=(0), const wxChar *name=wxPropertyGridNameStr) | |
wxPropertyGrid () | |
virtual | ~wxPropertyGrid () |
Static Public Member Functions | |
void | AutoGetTranslation (bool enable) |
wxPGProperty * | CreatePropertyByClass (const wxString &classname, const wxString &label, const wxString &name) |
wxPGProperty * | CreatePropertyByType (const wxString &valuetype, const wxString &label, const wxString &name) |
void | DoubleToString (wxString &target, double value, int precision, bool removeZeroes, wxString *precTemplate) |
wxPGEditor * | GetEditorByName (const wxString &editorName) |
wxString | GetPropertyShortClassName (wxPGId id) |
const wxArrayInt & | GetPropertyValueAsArrayInt (wxPGId id) |
const wxArrayString & | GetPropertyValueAsArrayString (wxPGId id) |
bool | GetPropertyValueAsBool (wxPGId id) |
wxDateTime | GetPropertyValueAsDateTime (wxPGId id) |
double | GetPropertyValueAsDouble (wxPGId id) |
int | GetPropertyValueAsInt (wxPGId id) |
long | GetPropertyValueAsLong (wxPGId id) |
const wxLongLong & | GetPropertyValueAsLongLong (wxPGId id) |
const wxPoint & | GetPropertyValueAsPoint (wxPGId id) |
const wxSize & | GetPropertyValueAsSize (wxPGId id) |
wxString | GetPropertyValueAsString (wxPGId id) |
const wxULongLong & | GetPropertyValueAsULongLong (wxPGId id) |
void * | GetPropertyValueAsVoidPtr (wxPGId id) |
const wxObject * | GetPropertyValueAsWxObjectPtr (wxPGId id) |
wxPGValueType * | GetValueType (const wxString &type) |
void | InitAllTypeHandlers () |
bool | IsPropertyExpanded (wxPGId id) |
bool | IsPropertyKindOf (wxPGId id, wxPGPropertyClassInfo &info) |
void | RegisterAdditionalEditors () |
void | RegisterAdvancedPropertyClasses () |
wxPGEditor * | RegisterEditorClass (wxPGEditor *editor, const wxString &name, bool noDefCheck=false) |
bool | RegisterPropertyClass (const wxChar *name, wxPGPropertyClassInfo *classinfo) |
wxPGValueType * | RegisterValueType (wxPGValueType *valueclass, bool noDefCheck=false, const wxString &className=wxEmptyString) |
void | SetBoolChoices (const wxChar *true_choice, const wxChar *false_choice) |
void | SetPropertyAttributes (wxPGId id, const wxString &attributes) |
void | SetPropertyChoices (wxPGId id, wxPGChoices &choices) |
Protected Member Functions | |
virtual wxPropertyGridState * | CreateState () const |
virtual wxPGId | DoGetPropertyByName (const wxString &name) const |
virtual void | RefreshProperty (wxPGProperty *p)=0 |
Static Protected Member Functions | |
void | DoSetPropertyAttribute (wxPGId id, int attrid, wxVariant &value, long argFlags) |
Protected Attributes | |
wxString | m_emptyString |
wxPropertyGridState * | m_pState |
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.
wxPropertyContainerMethods
wxScrolledWindow
wxPanel
wxWindow
wxEvtHandler
wxObject
<wx/propertygrid/propertygrid.h>
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) |
For code examples, see the main page.
|
Two step constructor. Call Create when this constructor is called to build up the wxPropertyGrid |
|
The default constructor. The styles to be used are styles valid for the wxWindow and wxScrolledWindow.
|
|
Destructor.
|
|
Adds choice to a property that can accept one.
|
|
Appends property to the list. wxPropertyGrid assumes ownership of the object. Becomes child of most recently added category.
|
|
Generates contents for string dst based on the convetents of wxArrayString src. Format will be str1<postDelim> str2<postDelim> and so on. Set flags to 1 inorder to convert backslashes to double-back- slashes and "<preDelims>"'s to "\<preDelims>". |
|
This static function enables or disables automatic use of wxGetTranslation for following strings: wxEnumProperty list labels, wxFlagsProperty sub-property labels. Default is false. |
|
Inorder to add new items into a property with fixed children (for instance, wxFlagsProperty), you need to call this method. After populating has been finished, you need to call EndAddChildren. |
|
Returns true if all property grid data changes have been committed. Usually only returns false if value in active editor has been invalidated by a wxValidator. |
|
Centers the splitter. If argument is true, automatic splitter centering is enabled (only applicapple if style wxPG_SPLITTER_AUTO_CENTER was defined). |
|
Deletes all properties. Does not free memory allocated for arrays etc. This should *not* be called in wxPropertyGridManager. |
|
Resets modified status of all properties.
|
|
Resets modified status of a property and all sub-properties.
|
|
Resets value of a property to its default.
|
|
Resets value of a property to its default.
|
|
Deselect current selection, if any. Returns true if success (ie. validator did not intercept). |
|
Synonymous to Clear.
|
|
Collapses given category or property with children. Returns true if actually collapses. |
|
Collapses given category or property with children. Returns true if actually collapses. |
|
Collapses all items that can be collapsed.
|
|
Shows(arg = false) or hides(arg = true) all hideable properties.
|
|
Two step creation. Whenever the control is created without any parameters, use Create to actually create it. Don't access the control's public methods before this is called
|
|
Constructs a property. Class used is given as the first string argument. It may be either normal property class name, such as "wxIntProperty" or a short one such as "Int". |
|
Constructs a property. Value type name used is given as the first string argument. It may be "string", "long", etc. Any value returned by wxVariant::GetType fits there. Otherwise, this is similar as CreatePropertyByClass.
|
|
wxPropertyGridState used by the grid is created here. If grid is used in wxPropertyGridManager, there is no point overriding this - instead, set custom wxPropertyGridPage classes. |
|
Deletes a property by name.
|
|
Deletes a property by id. If category is deleted, all children are automatically deleted as well. |
|
Deletes choice from a property. If selected item is deleted, then the value is set to unspecified. See AddPropertyChoice for more details. |
|
Disables property.
|
|
Disables property.
|
|
Disables property.
|
|
Disables property.
|
|
Standardized double-to-string conversion.
|
|
Call when editor widget's contents is modified. For example, this is called when changes text in wxTextCtrl (used in wxStringProperty and wxIntProperty).
|
|
Reverse of EditorsValueWasModified().
|
|
Returns true if all property grid data changes have been committed. Usually only returns false if value in active editor has been invalidated by a wxValidator. |
|
Enables or disables (shows/hides) categories according to parameter enable.
|
|
Enables or disables property, depending on whether enable is true or false.
|
|
Enables or disables property, depending on whether enable is true or false.
|
|
Called after population of property with fixed children has finished.
|
|
Scrolls and/or expands items to ensure that the given item is visible. Returns true if something was actually done. |
|
Scrolls and/or expands items to ensure that the given item is visible. Returns true if something was actually done. |
|
Expands given category or property with children. Returns true if actually expands. |
|
Expands given category or property with children. Returns true if actually expands. |
|
Expands all items that can be expanded.
|
|
Fixes position of wxTextCtrl-like control (wxSpinCtrl usually fits as one). Call after control has been created (but before shown). |
|
Shortcut for creating dialog-caller button. Used, for example, by wxFontProperty.
|
|
Shortcut for creating text editor widget.
|
|
Returns current category caption background colour.
|
|
Returns current category caption text colour.
|
|
Returns current cell background colour.
|
|
Returns current cell text colour when disabled.
|
|
Returns current cell text colour.
|
|
Returns number of children for the property.
|
|
Returns number of children for the property. NB: Cannot be in container methods class due to name hiding. |
|
Returns number of children of the root property.
|
|
Returns pointer to current active primary editor control (NULL if none). If editor uses clipper window, pointer is returned to the actual editor, not the clipper. |
|
Returns pointer to current active secondary editor control (NULL if none).
|
|
Returns id of first item, whether it is a category or property.
|
|
Returns id of first category (from target page).
|
|
Returns id of first child of given property.
|
|
Returns id of first property that is not a category.
|
|
Returns id of first visible item, whether it is a category or property. Note that visible item means category, property, or sub-property which user can see when control is scrolled properly. It does not only mean items that are actually painted on the screen. |
|
Returns height of highest characters of used font.
|
|
Generates position for a widget editor dialog box.
|
|
Returns pointer to itself. Dummy function that enables same kind of code to use wxPropertyGrid and wxPropertyGridManager. |
|
Returns size of the custom paint image in front of property. If no argument is given, returns preferred size. |
|
Returns property (or category) at given y coordinate (relative to control's top left).
|
|
Returns id of last child of given property.
|
|
Returns id of last item. Ignores categories and sub-properties. |
|
Returns id of last visible item. Does not ignore categories sub-properties. |
|
Returns colour of lines between cells.
|
|
Returns background colour of margin.
|
|
Returns id of next category after a given property (which does not have to be category).
|
|
Returns id of next property. This does not iterate to sub-properties or categories, unlike GetNextVisible. |
|
Returns next item under the same parent.
|
|
Returns id of next visible item. Note that visible item means category, property, or sub-property which user can see when control is scrolled properly. It does not only mean items that are actually painted on the screen. |
|
Returns id of previous property. Unlike GetPrevVisible, this skips categories and sub-properties. |
|
Returns id of previous item under the same parent.
|
|
Returns id of previous visible property.
|
|
Returns comma-delimited string with property's attributes (both pseudo-attributes such as "Disabled" and "Modified" and real attributes such as "BoolUseCheckbox" - actual names may vary).
|
|
Returns cell background colour of a property.
|
|
Returns id of property with given label (case-sensitive). If there is no property with such label, returned property id is invalid ( i.e. it will return false with IsOk method). If there are multiple properties with identical name, most recent added is returned. |
|
Returns id of a sub-property 'subname' of property 'name'. Same as calling GetPropertyByNameI(wxT("name.subname")), albeit slightly faster. |
|
Returns id of property with given name (case-sensitive). If there is no property with such name, returned property id is invalid ( i.e. it will return false with IsOk method).
|
|
Returns id of property's nearest parent category. If no category found, returns invalid wxPGId. |
|
Returns writable reference to property's list of choices (and relevant values). If property does not have any choices, will return reference to an invalid set of choices that will return false on IsOk call. |
|
Gets name of property's constructor function.
|
|
Gets name of property's constructor function.
|
|
Returns client data (void*) of a property.
|
|
Returns client data (void*) of a property.
|
|
Returns cell background colour of a property.
|
|
Returns property's editor.
|
|
Returns help string associated with a property.
|
|
Returns help string associated with a property.
|
|
Returns property's custom value image (NULL of none).
|
|
Returns property's position under its parent.
|
|
Returns property's position under its parent.
|
|
Returns label of a property.
|
|
Returns name of a property. Note that obviously there is no name-version of this member function. |
|
Returns parent item of a property.
|
|
Returns parent item of a property.
|
|
Returns priority of a property (wxPG_HIGH or wxPG_LOW).
|
|
Returns priority of a property (wxPG_HIGH or wxPG_LOW).
|
|
Returns pointer to a property.
|
|
Returns pointer to a property.
|
|
Returns rectangle that fully contains properties between and including p1 and p2.
|
|
Returns short name for property's class. For example, "wxPropertyCategory" translates to "Category" and "wxIntProperty" to "Int". |
|
Returns cell background colour of a property.
|
|
Returns validator of a property as a reference, which you can pass to any number of SetPropertyValidator.
|
|
Returns value as wxVariant. To get wxObject pointer from it, you will have to use WX_PG_VARIANT_TO_WXOBJECT(VARIANT,CLASSNAME) macro. If property value is unspecified, Null variant is returned. |
|
Returns value as wxVariant. To get wxObject pointer from it, you will have to use WX_PG_VARIANT_TO_WXOBJECT(VARIANT,CLASSNAME) macro. If property value is unspecified, Null variant is returned. |
|
Returns a wxVariant list containing wxVariant versions of all property values. Order is not guaranteed, but generally it should match the visible order in the grid.
|
|
Returns a wxPGValueType class instance that describes the property's data type.
|
|
Returns property value type identifier.
|
|
Returns property value type name.
|
|
Returns "root property". It does not have name, etc. and it is not visible. It is only useful for accessing its children. |
|
Returns height of a single grid row (in pixels).
|
|
Returns currently selected property.
|
|
Returns current selection background colour.
|
|
Returns current selection text colour.
|
|
Returns current splitter x position.
|
|
Returns value type class instance for given type name.
|
|
Returns current vertical spacing.
|
|
Returns true if a property is selected.
|
|
Hides all low priority properties.
|
|
Hides or reveals a property.
|
|
Initializes *all* property types. Causes references to most object files in the library, so calling this may cause significant increase in executable size when linking with static library. Reimplemented in wxPropertyGridManager. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Inserts property to the list.
While Append may be faster way to add items, make note that when both data storages (categoric and non-categoric) are active, Insert becomes even more slow. This is especially true if current mode is non-categoric. Example of use:
|
|
Inserts choice to a property that can accept one. See AddPropertyChoice for more details. |
|
Returns true if any property has been modified by the user.
|
|
Returns true if editor's value was marked modified.
|
|
Returns true if updating is frozen (ie. Freeze() called but not yet Thaw() ). |
|
Returns true if property has been modified after value set or modify flag clear by software. NOTE: Try to use IsPropertyModified instead. |
|
Returns true if property is a category.
|
|
Returns true if property is enabled.
|
|
Returns true if property is enabled.
|
|
Returns true if given property is expanded. Naturally, always returns false for properties that cannot be expanded. |
|
Returns true if property is of certain type.
|
|
Returns true if property has been modified after value set or modify flag clear by software.
|
|
Returns true if given property is selected.
|
|
Returns true if given property is selected.
|
|
Returns true if property is shown (ie. hideproperty with true not called for it). |
|
Returns true if property is shown (ie. hideproperty with true not called for it). |
|
Returns true if property value is set to unspecified.
|
|
Returns true if property's value type has same name as a class.
|
|
Returns true if property's value type is valuetype.
|
|
Returns true if property's value type has name typestr.
|
|
Returns true if property's value type has same name as a class.
|
|
Returns true if property's value type is valuetype.
|
|
Returns true if property's value type has name typestr.
|
|
Disables (limit = true) or enables (limit = false) wxTextCtrl editor of a property, if it is not the sole mean to edit the value.
|
|
Disables (limit = true) or enables (limit = false) wxTextCtrl editor of a property, if it is not the sole mean to edit the value.
|
|
Pass this function to Connect calls in propertyclass::CreateEditor.
|
|
Call after a property modified internally. selFlags are the same as with DoSelectProperty. NB: Avoid using this method, if possible. |
|
Initializes additional property editors (SpinCtrl etc.). Causes references to most object files in the library, so calling this may cause significant increase in executable size when linking with static library. |
|
Basic property classes are registered by the default, but this registers advanced ones as well.
|
|
Registers a new editor class.
|
|
Registers property class info with specific name. Preferably use wxPGRegisterPropertyClass(PROPERTYNAME) macro. |
|
Registers a new value type. Takes ownership of the object.
|
|
Replaces property with id with newly created property. For example, this code replaces existing property named "Flags" with one that will have different set of items: For more info, see wxPropertyGrid::Insert. |
|
Resets all colours to the original system values.
|
|
Same as SetDefaultPriority(wxPG_HIGH).
|
|
Selects a property. Editor widget is automatically created, but not focused unless focus is true. This will generate wxEVT_PG_SELECT event.
|
|
Lets user to set the strings listed in the choice dropdown of a wxBoolProperty. Defaults are "True" and "False", so changing them to, say, "Yes" and "No" may be useful in some less technical applications. |
|
Changes keyboard shortcut to push the editor button.
|
|
Sets category caption background colour.
|
|
Sets category caption text colour.
|
|
Sets text colour of a category caption (but not it's children).
|
|
Sets default cell background colour - applies to property cells. Note that appearance of editor widgets may not be affected. |
|
Sets cell text colour for disabled properties.
|
|
Sets default cell text colour - applies to property name and value text. Note that appearance of editor widgets may not be affected. |
|
Sets the current category - Append will add non-categories under this one.
|
|
Sets the current category - Append will add non-categories under this one.
|
|
All properties added/inserted will have given priority by default.
|
|
Sets colour of lines between cells.
|
|
Sets background colour of margin.
|
|
Sets an attribute of a property. Ids and relevants values are totally specific to property classes and may affect either the given instance or all instances of that class. See wxPropertyGrid Property Attribute Identifiers for list of built-in attributes.
|
|
Sets property attribute for all applicapple properties. Be sure to use this method after all properties have been added to the grid. |
|
Sets attributes from a string generated by GetPropertyAttributes.
|
|
Sets background colour of property and all its children, recursively. Colours of captions are not affected. Background brush cache is optimized for often set colours to be set last.
|
|
Set choices of a property to specified set of labels and values.
|
|
Set choices of a property to specified set of labels and values.
|
|
If property's set of choices is shared, then calling this method converts it to private.
|
|
Sets client data (void*) of a property.
|
|
Sets client data (void*) of a property.
|
|
Sets background colour of property and all its children. Colours of captions are not affected. Background brush cache is optimized for often set colours to be set last. NOTE: This function is deprecated. Use SetPropertyBackgroundColour. |
|
Sets background and text colour of property and all its children to the default.
|
|
Sets editor control of a property. As editor argument, use editor name string, such as wxT("TextCtrl") or wxT("Choice"). |
|
Sets editor control of a property. As editor argument, use wxPG_EDITOR(EditorName), where basic built-in editor names are TextCtrl, Choice, ComboBox, CheckBox, TextCtrlAndButton, and ChoiceAndButton. Additional editors include SpinCtrl and DatePickerCtrl, which also require wxPropertyGrid::RegisterAdditionalEditors() call prior using. |
|
Associates the help string with property.
|
|
Set wxBitmap in front of the value.
|
|
Sets label of a property.
|
|
Sets label of a property.
|
|
Sets max length of property's text.
|
|
Sets max length of property's text.
|
|
Sets name of a property.
|
|
Sets name of a property.
|
|
Property is to be hidden/shown when hider button is toggled or when wxPropertyGrid::Compact is called.
|
|
Property is to be hidden/shown when hider button is toggled or when wxPropertyGrid::Compact is called.
|
|
Sets property as read-only. It's value cannot be changed by the user, but the editor may still be created for copying purposes. |
|
Sets property as read-only. It's value cannot be changed by the user, but the editor may still be created for copying purposes. |
|
Sets text colour of property and all its children.
|
|
Sets property's value to unspecified. If it has children (it may be category), then the same thing is done to them. |
|
Sets validator of a property. For example
|
|
Sets value (wxULongLong&) of a property.
|
|
Sets value (wxLongLong&) of a property.
|
|
Sets value (wxSize&) of a property.
|
|
Sets value (wxPoint&) of a property.
|
|
Sets value (wxDateTime&) of a property.
|
|
Sets value (wxArrayInt&) of a property.
|
|
Sets value (wxArrayString) of a property.
|
|
Sets value (wxVariant&) of a property.
|
|
Sets value (wxObject*) of a property.
|
|
Sets value (void*) of a property.
|
|
Sets value (wxString) of a property. For properties which value type is not string, calls wxPGProperty::SetValueFromString to translate the value. |
|
Sets value (wxString) of a property. For properties which value type is not string, calls wxPGProperty::SetValueFromString to translate the value. |
|
Sets value (bool) of a property.
|
|
Sets value (floating point) of a property.
|
|
Sets value (integer) of a property.
|
|
Sets value (long integer) of a property.
|
|
Sets value (wxDateTime&) of a property.
|
|
Sets value (wxArrayInt&) of a property.
|
|
Sets value (wxULongLong&) of a property.
|
|
Sets value (wxLongLong&) of a property.
|
|
Sets value (wxSize&) of a property.
|
|
Sets value (wxPoint&) of a property.
|
|
Sets value (wxVariant&) of a property.
|
|
Sets value (void*) of a property.
|
|
Sets value (wxObject*) of a property.
|
|
Sets value (wxArrayString) of a property.
|
|
Sets value (wxString) of a property.
|
|
Sets value (bool) of a property.
|
|
Sets value (floating point) of a property.
|
|
Sets value (integer) of a property.
|
|
Sets value (long integer) of a property.
|
|
Sets various property values from a list of wxVariants. If property with name is missing from the grid, new property is created under given default category (or root if omitted). |
|
Sets selection background colour - applies to selected property name background.
|
|
Sets selection foreground colour - applies to selected property name text.
|
|
Moves splitter as left as possible, while still allowing all labels to be shown in full.
|
|
Sets x coordinate of the splitter.
|
|
Sets vertical spacing. Can be 1, 2, or 3 - a value relative to font height. Value of 2 should be default on most platforms.
|
|
Overridden function.
|
|
Shows all low priority properties.
|
|
Shows an brief error message that is related to a property.
|
|
Puts items into sl. Automatic wxGetTranslation is used if enabled. |
|
Returns sl.
|
|
Sorts children of a category.
|
|
Sorts children of a category.
|
|
Sorts all items at all levels (except sub-properties).
|
|
Mostly useful for page switching.
|
|
Toggles priority of a property between wxPG_HIGH and wxPG_LOW.
|
|
Toggles priority of a property between wxPG_HIGH and wxPG_LOW.
|