#include <propgrid.h>
Public Types | |
enum | EditableStateFlags { SelectionState = 0x01, ExpandedState = 0x02, ScrollPosState = 0x04, PageState = 0x08, SplitterPosState = 0x10, DescBoxState = 0x20, AllStates } |
Public Member Functions | |
void | AddPropertyChoice (wxPGPropArg id, const wxString &label, int value=INT_MAX) |
wxPGProperty * | Append (wxPGProperty *property) |
wxPGProperty * | AppendCategory (const wxString &label, const wxString &name=(*((wxString *) NULL))) |
wxPGProperty * | AppendIn (wxPGPropArg id, wxPGProperty *newproperty) |
void | BeginAddChildren (wxPGPropArg id) |
bool | ChangePropertyValue (wxPGPropArg id, wxVariant newValue) |
virtual void | Clear ()=0 |
bool | ClearPropertyValue (wxPGPropArg id) |
bool | ClearSelection () |
bool | Collapse (wxPGPropArg id) |
bool | CollapseAll () |
void | Delete (wxPGPropArg id) |
void | DeleteProperty (wxPGPropArg id) |
void | DeletePropertyChoice (wxPGPropArg id, int index) |
bool | Disable (wxPGPropArg id) |
bool | DisableProperty (wxPGPropArg id) |
bool | EnableProperty (wxPGPropArg id, bool enable=true) |
void | EndAddChildren (wxPGPropArg id) |
bool | Expand (wxPGPropArg id) |
bool | ExpandAll (bool expand=true) |
wxArrayPGProperty | GetExpandedProperties () const |
const wxPGProperty * | GetFirst (int flags=wxPG_ITERATE_ALL) const |
wxPGProperty * | GetFirst (int flags=wxPG_ITERATE_ALL) |
wxPGProperty * | GetFirstChild (wxPGPropArg id) |
wxPropertyGridConstIterator | GetIterator (int flags, int startPos) const |
wxPropertyGridIterator | GetIterator (int flags, int startPos) |
wxPropertyGridConstIterator | GetIterator (int flags=wxPG_ITERATE_DEFAULT, wxPGProperty *firstProp=NULL) const |
wxPropertyGridIterator | GetIterator (int flags=wxPG_ITERATE_DEFAULT, wxPGProperty *firstProp=NULL) |
wxPGProperty * | GetNextSiblingProperty (wxPGPropArg id) |
void | GetPropertiesWithFlag (wxArrayPGProperty *targetArr, wxPGProperty::FlagType flags, bool inverse=false, int iterFlags=(wxPG_ITERATE_PROPERTIES|wxPG_ITERATE_HIDDEN|wxPG_ITERATE_CATEGORIES)) const |
wxPGProperty * | GetProperty (const wxString &name) const |
wxVariant | GetPropertyAttribute (wxPGPropArg id, const wxString &attrName) const |
const wxPGAttributeStorage & | GetPropertyAttributes (wxPGPropArg id) const |
wxPGProperty * | GetPropertyByName (const wxString &name, const wxString &subname) const |
wxPGProperty * | GetPropertyByName (const wxString &name) const |
wxPGProperty * | GetPropertyByNameA (const wxString &name) const |
wxPropertyCategory * | GetPropertyCategory (wxPGPropArg id) const |
wxPGChoices & | GetPropertyChoices (wxPGPropArg id) |
const wxChar * | GetPropertyClassName (wxPGPropArg id) const |
wxPGProperty::ClientDataType | GetPropertyClientData (wxPGPropArg id) const |
const wxPGEditor * | GetPropertyEditor (wxPGPropArg id) const |
wxString | GetPropertyHelpString (wxPGPropArg id) const |
wxBitmap * | GetPropertyImage (wxPGPropArg id) const |
unsigned int | GetPropertyIndex (wxPGPropArg id) |
const wxString & | GetPropertyLabel (wxPGPropArg id) |
wxString | GetPropertyName (wxPGPropArg id) |
wxPGProperty * | GetPropertyParent (wxPGPropArg id) |
wxPGProperty * | GetPropertyPtr (wxPGPropArg id) const |
wxString | GetPropertyShortClassName (wxPGPropArg id) |
wxValidator * | GetPropertyValidator (wxPGPropArg id) |
wxVariant | GetPropertyValue (wxPGPropArg id) |
wxArrayInt | GetPropertyValueAsArrayInt (wxPGPropArg id) const |
wxArrayString | GetPropertyValueAsArrayString (wxPGPropArg id) const |
bool | GetPropertyValueAsBool (wxPGPropArg id) const |
wxDateTime | GetPropertyValueAsDateTime (wxPGPropArg id) const |
double | GetPropertyValueAsDouble (wxPGPropArg id) const |
int | GetPropertyValueAsInt (wxPGPropArg id) const |
long | GetPropertyValueAsLong (wxPGPropArg id) const |
wxLongLong_t | GetPropertyValueAsLongLong (wxPGPropArg id) const |
wxPoint | GetPropertyValueAsPoint (wxPGPropArg id) const |
wxSize | GetPropertyValueAsSize (wxPGPropArg id) const |
wxString | GetPropertyValueAsString (wxPGPropArg id) const |
unsigned long | GetPropertyValueAsULong (wxPGPropArg id) const |
wxULongLong_t | GetPropertyValueAsULongLong (wxPGPropArg id) const |
void * | GetPropertyValueAsVoidPtr (wxPGPropArg id) const |
wxObject * | GetPropertyValueAsWxObjectPtr (wxPGPropArg id) const |
wxVariant | GetPropertyValues (const wxString &listname=wxEmptyString, wxPGProperty *baseparent=NULL, long flags=0) const |
wxString | GetPropertyValueType (wxPGPropArg id) |
wxPGProperty * | GetSelection () const |
wxPropertyGridState * | GetState () const |
virtual wxPGVIterator | GetVIterator (int flags) const |
bool | HideProperty (wxPGPropArg id, bool hide=true, int flags=wxPG_RECURSE) |
wxPGProperty * | Insert (wxPGPropArg parent, int index, wxPGProperty *newproperty) |
wxPGProperty * | Insert (wxPGPropArg priorThis, wxPGProperty *newproperty) |
wxPGProperty * | InsertCategory (wxPGPropArg id, int index, const wxString &label, const wxString &name=(*((wxString *) NULL))) |
void | InsertPropertyChoice (wxPGPropArg id, const wxString &label, int index, int value=INT_MAX) |
bool | IsModified (wxPGPropArg id) const |
bool | IsPropertyCategory (wxPGPropArg id) const |
bool | IsPropertyEnabled (wxPGPropArg id) const |
bool | IsPropertyExpanded (wxPGPropArg id) const |
bool | IsPropertyKindOf (wxPGPropArg id, wxClassInfo *info) const |
bool | IsPropertyModified (wxPGPropArg id) const |
bool | IsPropertyShown (wxPGPropArg id) const |
bool | IsPropertyUnspecified (wxPGPropArg id) const |
bool | IsPropertyValueType (wxPGPropArg id, const wxChar *typestr) const |
void | LimitPropertyEditing (wxPGPropArg id, bool limit=true) |
void | NamesToProperties (wxArrayPGProperty *properties, const wxArrayString &names) const |
void | PropertiesToNames (wxArrayString *names, const wxArrayPGProperty &properties) const |
virtual void | RefreshGrid (wxPropertyGridState *state=NULL) |
virtual void | RefreshProperty (wxPGProperty *p)=0 |
wxPGProperty * | ReplaceProperty (wxPGPropArg id, wxPGProperty *property) |
bool | RestoreEditableState (const wxString &src, int restoreStates=AllStates) |
wxString | SaveEditableState (int includedStates=AllStates) const |
void | SetExpandedProperties (const wxArrayPGProperty &array, bool expand=true) |
void | SetPropertiesFlag (const wxArrayPGProperty &srcArr, wxPGProperty::FlagType flags, bool inverse=false) |
void | SetPropertyAttribute (wxPGPropArg id, const wxString &attrName, wxVariant value, long argFlags=0) |
void | SetPropertyAttributes (wxPGPropArg id, const wxPGAttributeStorage &attributes) |
void | SetPropertyCell (wxPGPropArg id, int column, const wxString &text=wxEmptyString, const wxBitmap &bitmap=wxNullBitmap, const wxColour &fgCol=wxNullColour, const wxColour &bgCol=wxNullColour) |
void | SetPropertyChoices (wxPGPropArg id, wxPGChoices &choices) |
void | SetPropertyChoicesExclusive (wxPGPropArg id) |
void | SetPropertyClientData (wxPGPropArg id, wxPGProperty::ClientDataType clientData) |
void | SetPropertyEditor (wxPGPropArg id, const wxString &editorName) |
void | SetPropertyEditor (wxPGPropArg id, const wxPGEditor *editor) |
void | SetPropertyHelpString (wxPGPropArg id, const wxString &helpString) |
void | SetPropertyImage (wxPGPropArg id, wxBitmap &bmp) |
void | SetPropertyLabel (wxPGPropArg id, const wxString &newproplabel) |
bool | SetPropertyMaxLength (wxPGPropArg id, int maxLen) |
void | SetPropertyReadOnly (wxPGPropArg id, bool set=true, int flags=wxPG_RECURSE) |
void | SetPropertyValidator (wxPGPropArg id, const wxValidator &validator) |
void | SetPropertyValue (wxPGPropArg id, const wxArrayInt &value) |
void | SetPropertyValue (wxPGPropArg id, wxULongLong_t value) |
void | SetPropertyValue (wxPGPropArg id, wxLongLong_t value) |
void | SetPropertyValue (wxPGPropArg id, const wxSize &value) |
void | SetPropertyValue (wxPGPropArg id, const wxPoint &value) |
void | SetPropertyValue (wxPGPropArg id, wxVariant value) |
void | SetPropertyValue (wxPGPropArg id, wxObject &value) |
void | SetPropertyValue (wxPGPropArg id, void *value) |
void | SetPropertyValue (wxPGPropArg id, wxObject *value) |
void | SetPropertyValue (wxPGPropArg id, const wxString &value) |
void | SetPropertyValue (wxPGPropArg id, const wxDateTime &value) |
void | SetPropertyValue (wxPGPropArg id, const wxArrayString &value) |
void | SetPropertyValue (wxPGPropArg id, const wxChar *value) |
void | SetPropertyValue (wxPGPropArg id, bool value) |
void | SetPropertyValue (wxPGPropArg id, double value) |
void | SetPropertyValue (wxPGPropArg id, int value) |
void | SetPropertyValue (wxPGPropArg id, long value) |
void | SetPropertyValues (const wxVariant &list, wxPGPropArg defaultCategory=((wxPGProperty *) NULL)) |
void | SetPropertyValues (const wxVariantList &list, wxPGPropArg defaultCategory=((wxPGProperty *) NULL)) |
void | SetPropertyValueUnspecified (wxPGPropArg id) |
void | SetPropVal (wxPGPropArg id, wxVariant &value) |
void | SetValidationFailureBehavior (int vfbFlags) |
virtual | ~wxPropertyGridInterface () |
Static Public Member Functions | |
static wxPGProperty * | CreatePropertyByClass (const wxString &classname, const wxString &label, const wxString &name) |
static wxPGProperty * | CreatePropertyByType (const wxString &valuetype, const wxString &label, const wxString &name) |
static wxPGEditor * | GetEditorByName (const wxString &editorName) |
static void | InitAllTypeHandlers () |
static void | RegisterAdditionalEditors () |
static void | SetBoolChoices (const wxString &true_choice, const wxString &false_choice) |
Protected Member Functions | |
virtual wxPGProperty * | DoGetPropertyByName (const wxString &name) const |
virtual bool | DoSelectPage (int WXUNUSED(index)) |
void | DoSetPropertyAttribute (wxPGPropArg id, const wxString &name, wxVariant &value, long argFlags) |
virtual wxVariant | GetEditableStateItem (const wxString &name) const |
virtual wxPropertyGridState * | GetPageState (int pageIndex) const |
virtual bool | SetEditableStateItem (const wxString &name, wxVariant value) |
Protected Attributes | |
wxString | m_emptyString |
wxPropertyGridState * | m_pState |
Flags for wxPropertyGridInterface::SaveEditableState() and wxPropertyGridInterface::RestoreEditableState().
SelectionState |
Include selected property.
|
ExpandedState |
Include expanded/collapsed property information.
|
ScrollPosState |
Include scrolled position.
|
PageState |
Include selected page information.
Only applies to wxPropertyGridManager. |
SplitterPosState |
Include splitter position.
Stored for each page. |
DescBoxState |
Include description box size.
Only applies to wxPropertyGridManager. |
AllStates |
Include all supported user editable state information.
This is usually the default value. |
virtual wxPropertyGridInterface::~wxPropertyGridInterface | ( | ) | [virtual] |
Destructor.
void wxPropertyGridInterface::AddPropertyChoice | ( | wxPGPropArg | id, | |
const wxString & | label, | |||
int | value = INT_MAX | |||
) |
Adds choice to a property that can accept one.
wxPGProperty* wxPropertyGridInterface::Append | ( | wxPGProperty * | property | ) |
Appends property to the list.
wxPropertyGrid assumes ownership of the object. Becomes child of most recently added category.
void wxPropertyGridInterface::BeginAddChildren | ( | wxPGPropArg | id | ) |
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.
bool wxPropertyGridInterface::ChangePropertyValue | ( | wxPGPropArg | id, | |
wxVariant | newValue | |||
) |
Changes value of a property, as if from an editor.
Use this instead of SetPropertyValue() if you need the value to run through validation process, and also send the property change event.
Returns | true if value was succesfully changed. |
Reimplemented in wxPropertyGrid.
virtual void wxPropertyGridInterface::Clear | ( | ) | [pure virtual] |
Deletes all properties.
Implemented in wxPropertyGridPage, wxPropertyGridManager, and wxPropertyGrid.
bool wxPropertyGridInterface::ClearPropertyValue | ( | wxPGPropArg | id | ) |
Resets value of a property to its default.
bool wxPropertyGridInterface::ClearSelection | ( | ) |
Deselect current selection, if any.
Returns true if success (ie. validator did not intercept).
Reimplemented in wxPropertyGridManager, and wxPropertyGrid.
bool wxPropertyGridInterface::Collapse | ( | wxPGPropArg | id | ) |
Collapses given category or property with children.
Returns true if actually collapses.
bool wxPropertyGridInterface::CollapseAll | ( | ) |
Collapses all items that can be collapsed.
Return | false if failed (may fail if editor value cannot be validated). |
static wxPGProperty* wxPropertyGridInterface::CreatePropertyByClass | ( | const wxString & | classname, | |
const wxString & | label, | |||
const wxString & | name | |||
) | [static] |
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".
static wxPGProperty* wxPropertyGridInterface::CreatePropertyByType | ( | const wxString & | valuetype, | |
const wxString & | label, | |||
const wxString & | name | |||
) | [static] |
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.
void wxPropertyGridInterface::Delete | ( | wxPGPropArg | id | ) |
Deletes a property by id.
If category is deleted, all children are automatically deleted as well.
void wxPropertyGridInterface::DeleteProperty | ( | wxPGPropArg | id | ) |
Deletes a property by id.
If category is deleted, all children are automatically deleted as well.
void wxPropertyGridInterface::DeletePropertyChoice | ( | wxPGPropArg | id, | |
int | index | |||
) |
Deletes choice from a property.
If selected item is deleted, then the value is set to unspecified.
See AddPropertyChoice for more details.
bool wxPropertyGridInterface::Disable | ( | wxPGPropArg | id | ) |
Disables property.
bool wxPropertyGridInterface::DisableProperty | ( | wxPGPropArg | id | ) |
Disables property.
bool wxPropertyGridInterface::EnableProperty | ( | wxPGPropArg | id, | |
bool | enable = true | |||
) |
Enables or disables property, depending on whether enable is true or false.
void wxPropertyGridInterface::EndAddChildren | ( | wxPGPropArg | id | ) |
Called after population of property with fixed children has finished.
bool wxPropertyGridInterface::Expand | ( | wxPGPropArg | id | ) |
Expands given category or property with children.
Returns true if actually expands.
bool wxPropertyGridInterface::ExpandAll | ( | bool | expand = true |
) |
Expands all items that can be expanded.
virtual wxVariant wxPropertyGridInterface::GetEditableStateItem | ( | const wxString & | name | ) | const [protected, virtual] |
In derived class, implement to return editable state component with given name.
wxArrayPGProperty wxPropertyGridInterface::GetExpandedProperties | ( | ) | const |
Returns list of expanded properties.
wxPGProperty* wxPropertyGridInterface::GetFirst | ( | int | flags = wxPG_ITERATE_ALL |
) |
Returns id of first item, whether it is a category or property.
flags | List of iterator flags |
wxPGProperty* wxPropertyGridInterface::GetFirstChild | ( | wxPGPropArg | id | ) |
Returns id of first child of given property.
wxPropertyGridIterator wxPropertyGridInterface::GetIterator | ( | int | flags, | |
int | startPos | |||
) |
Returns iterator class instance.
flags | wxPropertyGridIterator flags. If default wxPG_ITERATE_DEFAULT supplied, everything except private child properties are iterated. List of iterator flags | |
startPos | Either wxTOP or wxBOTTOM. wxTOP will indicate that iterations start from the first property from the top, and wxBOTTOM means that the iteration will instead begin from bottommost valid item. |
Reimplemented in wxPropertyGridManager.
wxPropertyGridIterator wxPropertyGridInterface::GetIterator | ( | int | flags = wxPG_ITERATE_DEFAULT , |
|
wxPGProperty * | firstProp = NULL | |||
) |
Returns iterator class instance.
flags | wxPropertyGridIterator flags. If default wxPG_ITERATE_DEFAULT supplied, everything except private child properties are iterated. List of iterator flags | |
firstProp | Property to start iteration from. If NULL, then first child of root is used. |
Reimplemented in wxPropertyGridManager.
wxPGProperty* wxPropertyGridInterface::GetNextSiblingProperty | ( | wxPGPropArg | id | ) |
Returns next item under the same parent.
void wxPropertyGridInterface::GetPropertiesWithFlag | ( | wxArrayPGProperty * | targetArr, | |
wxPGProperty::FlagType | flags, | |||
bool | inverse = false , |
|||
int | iterFlags = (wxPG_ITERATE_PROPERTIES|wxPG_ITERATE_HIDDEN|wxPG_ITERATE_CATEGORIES) | |||
) | const |
Adds to 'targetArr' pointers to properties that have given flags 'flags' set.
However, if 'inverse' is set to true, then only properties without given flags are stored.
flags | Property flags to use. | |
iterFlags | Iterator flags to use. Default is everything expect private children. |
wxPGProperty* wxPropertyGridInterface::GetProperty | ( | const wxString & | name | ) | const |
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).
wxVariant wxPropertyGridInterface::GetPropertyAttribute | ( | wxPGPropArg | id, | |
const wxString & | attrName | |||
) | const |
Returns value of given attribute.
If none found, returns NULL-variant.
const wxPGAttributeStorage& wxPropertyGridInterface::GetPropertyAttributes | ( | wxPGPropArg | id | ) | const |
Returns map-like storage of property's attributes.
wxPGProperty* wxPropertyGridInterface::GetPropertyByName | ( | const wxString & | name, | |
const wxString & | subname | |||
) | const |
Returns id of a sub-property 'subname' of property 'name'.
Same as calling GetPropertyByNameI(wxT("name.subname")), albeit slightly faster.
wxPropertyCategory* wxPropertyGridInterface::GetPropertyCategory | ( | wxPGPropArg | id | ) | const |
Returns pointer of property's nearest parent category.
If no category found, returns NULL.
wxPGChoices& wxPropertyGridInterface::GetPropertyChoices | ( | wxPGPropArg | id | ) |
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.
const wxChar* wxPropertyGridInterface::GetPropertyClassName | ( | wxPGPropArg | id | ) | const |
Gets name of property's constructor function.
wxPGProperty::ClientDataType wxPropertyGridInterface::GetPropertyClientData | ( | wxPGPropArg | id | ) | const |
Returns client data (void*) of a property.
const wxPGEditor* wxPropertyGridInterface::GetPropertyEditor | ( | wxPGPropArg | id | ) | const |
Returns property's editor.
wxString wxPropertyGridInterface::GetPropertyHelpString | ( | wxPGPropArg | id | ) | const |
Returns help string associated with a property.
wxBitmap* wxPropertyGridInterface::GetPropertyImage | ( | wxPGPropArg | id | ) | const |
Returns property's custom value image (NULL of none).
unsigned int wxPropertyGridInterface::GetPropertyIndex | ( | wxPGPropArg | id | ) |
Returns property's position under its parent.
const wxString& wxPropertyGridInterface::GetPropertyLabel | ( | wxPGPropArg | id | ) |
Returns label of a property.
wxString wxPropertyGridInterface::GetPropertyName | ( | wxPGPropArg | id | ) |
Returns name of a property, by which it is globally accessible.
wxPGProperty* wxPropertyGridInterface::GetPropertyParent | ( | wxPGPropArg | id | ) |
Returns parent item of a property.
wxPGProperty* wxPropertyGridInterface::GetPropertyPtr | ( | wxPGPropArg | id | ) | const |
Returns pointer to a property.
wxString wxPropertyGridInterface::GetPropertyShortClassName | ( | wxPGPropArg | id | ) |
Returns short name for property's class.
For example, "wxPropertyCategory" translates to "Category" and "wxIntProperty" to "Int".
wxValidator* wxPropertyGridInterface::GetPropertyValidator | ( | wxPGPropArg | id | ) |
Returns validator of a property as a reference, which you can pass to any number of SetPropertyValidator.
wxVariant wxPropertyGridInterface::GetPropertyValue | ( | wxPGPropArg | id | ) |
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.
wxVariant wxPropertyGridInterface::GetPropertyValues | ( | const wxString & | listname = wxEmptyString , |
|
wxPGProperty * | baseparent = NULL , |
|||
long | flags = 0 | |||
) | const |
Returns a wxVariant list containing wxVariant versions of all property values.
Order is not guaranteed.
flags | Use wxPG_KEEP_STRUCTURE to retain category structure; each sub category will be its own wxVariantList of wxVariant. Use wxPG_INC_ATTRIBUTES to include property attributes as well. Each attribute will be stored as list variant named "@@<propname>@@attr." |
wxPGProperty* wxPropertyGridInterface::GetSelection | ( | ) | const |
virtual wxPGVIterator wxPropertyGridInterface::GetVIterator | ( | int | flags | ) | const [virtual] |
Similar to GetIterator, but instead returns wxPGVIterator instance, which can be useful for forward-iterating through arbitrary property containers.
Reimplemented in wxPropertyGridManager.
bool wxPropertyGridInterface::HideProperty | ( | wxPGPropArg | id, | |
bool | hide = true , |
|||
int | flags = wxPG_RECURSE | |||
) |
Hides or reveals a property.
hide | If true, hides property, otherwise reveals it. | |
flags | By default changes are applied recursively. Set this paramter wxPG_DONT_RECURSE to prevent this. |
static void wxPropertyGridInterface::InitAllTypeHandlers | ( | ) | [static] |
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.
wxPGProperty* wxPropertyGridInterface::Insert | ( | wxPGPropArg | parent, | |
int | index, | |||
wxPGProperty * | newproperty | |||
) |
Also see documentation for Insert .
parent | New property is inserted under this category. Available only in the second variant. There are two versions of this function to allow this parameter to be either an id or name to a property. | |
index | Index under category. Available only in the second variant. If index is < 0, property is appended in category. |
wxPGProperty* wxPropertyGridInterface::Insert | ( | wxPGPropArg | priorThis, | |
wxPGProperty * | newproperty | |||
) |
Inserts property to the property container.
priorThis | New property is inserted just prior to this. Available only in the first variant. There are two versions of this function to allow this parameter to be either an id or name to a property. | |
newproperty | Pointer to the inserted property. wxPropertyGrid will take ownership of this object. |
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:
// append category wxPGProperty* my_cat_id = propertygrid->Append( new wxPropertyCategory (wxT("My Category")) ); ... // insert into category - using second variant wxPGProperty* my_item_id_1 = propertygrid->Insert( my_cat_id, 0, new wxStringProperty(wxT("My String 1")) ); // insert before to first item - using first variant wxPGProperty* my_item_id_2 = propertygrid->Insert( my_item_id, new wxStringProperty(wxT("My String 2")) );
void wxPropertyGridInterface::InsertPropertyChoice | ( | wxPGPropArg | id, | |
const wxString & | label, | |||
int | index, | |||
int | value = INT_MAX | |||
) |
Inserts choice to a property that can accept one.
See AddPropertyChoice for more details.
bool wxPropertyGridInterface::IsModified | ( | wxPGPropArg | id | ) | const |
Returns true if property has been modified after value set or modify flag clear by software.
bool wxPropertyGridInterface::IsPropertyCategory | ( | wxPGPropArg | id | ) | const |
Returns true if property is a category.
bool wxPropertyGridInterface::IsPropertyEnabled | ( | wxPGPropArg | id | ) | const |
Returns true if property is enabled.
bool wxPropertyGridInterface::IsPropertyExpanded | ( | wxPGPropArg | id | ) | const |
Returns true if given property is expanded.
Naturally, always returns false for properties that cannot be expanded.
bool wxPropertyGridInterface::IsPropertyKindOf | ( | wxPGPropArg | id, | |
wxClassInfo * | info | |||
) | const |
Returns true if property is of certain type.
info | Preferably use WX_PG_CLASSINFO(PROPERTYNAME). Alternative is PROPERTYNAMEClassInfo. |
bool wxPropertyGridInterface::IsPropertyModified | ( | wxPGPropArg | id | ) | const |
Returns true if property has been modified after value set or modify flag clear by software.
bool wxPropertyGridInterface::IsPropertyShown | ( | wxPGPropArg | id | ) | const |
Returns true if property is shown (ie.
hideproperty with true not called for it).
bool wxPropertyGridInterface::IsPropertyUnspecified | ( | wxPGPropArg | id | ) | const |
Returns true if property value is set to unspecified.
bool wxPropertyGridInterface::IsPropertyValueType | ( | wxPGPropArg | id, | |
const wxChar * | typestr | |||
) | const |
Returns true if property's value type has name typestr.
void wxPropertyGridInterface::LimitPropertyEditing | ( | wxPGPropArg | id, | |
bool | limit = true | |||
) |
Disables (limit = true) or enables (limit = false) wxTextCtrl editor of a property, if it is not the sole mean to edit the value.
void wxPropertyGridInterface::NamesToProperties | ( | wxArrayPGProperty * | properties, | |
const wxArrayString & | names | |||
) | const |
Converts array of names to array of property pointers.
void wxPropertyGridInterface::PropertiesToNames | ( | wxArrayString * | names, | |
const wxArrayPGProperty & | properties | |||
) | const |
Converts array of properties to array of names.
virtual void wxPropertyGridInterface::RefreshGrid | ( | wxPropertyGridState * | state = NULL |
) | [virtual] |
If state is shown in it's grid, refresh it now.
static void wxPropertyGridInterface::RegisterAdditionalEditors | ( | ) | [static] |
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.
wxPGProperty* wxPropertyGridInterface::ReplaceProperty | ( | wxPGPropArg | id, | |
wxPGProperty * | property | |||
) |
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:
pg->ReplaceProperty(wxT("Flags"), wxFlagsProperty(wxT("Flags"),wxPG_LABEL,newItems))
bool wxPropertyGridInterface::RestoreEditableState | ( | const wxString & | src, | |
int | restoreStates = AllStates | |||
) |
Restores user-editable state.
See also wxPropertyGridInterface::SaveEditableState().
src | String generated by SaveEditableState. | |
restoreStates | Which parts to restore from source string. See list of editable state flags". |
wxString wxPropertyGridInterface::SaveEditableState | ( | int | includedStates = AllStates |
) | const |
Used to acquire user-editable state (selected property, expanded properties, scrolled position, splitter positions).
includedStates | Which parts of state to include. See list of editable state flags. |
static void wxPropertyGridInterface::SetBoolChoices | ( | const wxString & | true_choice, | |
const wxString & | false_choice | |||
) | [static] |
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.
virtual bool wxPropertyGridInterface::SetEditableStateItem | ( | const wxString & | name, | |
wxVariant | value | |||
) | [protected, virtual] |
In derived class, implement to set editable state component with given name to given value.
void wxPropertyGridInterface::SetExpandedProperties | ( | const wxArrayPGProperty & | array, | |
bool | expand = true | |||
) |
Sets all properties in given array as expanded.
expand | False if you want to collapse properties instead. |
void wxPropertyGridInterface::SetPropertiesFlag | ( | const wxArrayPGProperty & | srcArr, | |
wxPGProperty::FlagType | flags, | |||
bool | inverse = false | |||
) |
Sets or clears flag(s) of all properties in given array.
flags | Property flags to set or clear. | |
inverse | Set to true if you want to clear flag instead of setting them. |
void wxPropertyGridInterface::SetPropertyAttribute | ( | wxPGPropArg | id, | |
const wxString & | attrName, | |||
wxVariant | value, | |||
long | argFlags = 0 | |||
) |
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.
argFlags | Optional. Use wxPG_RECURSE to set the attribute to child properties as well. |
void wxPropertyGridInterface::SetPropertyAttributes | ( | wxPGPropArg | id, | |
const wxPGAttributeStorage & | attributes | |||
) |
Sets attributes from a wxPGAttributeStorage.
void wxPropertyGridInterface::SetPropertyCell | ( | wxPGPropArg | id, | |
int | column, | |||
const wxString & | text = wxEmptyString , |
|||
const wxBitmap & | bitmap = wxNullBitmap , |
|||
const wxColour & | fgCol = wxNullColour , |
|||
const wxColour & | bgCol = wxNullColour | |||
) |
Sets text, bitmap, and colours for given column's cell.
void wxPropertyGridInterface::SetPropertyChoices | ( | wxPGPropArg | id, | |
wxPGChoices & | choices | |||
) |
Set choices of a property to specified set of labels and values.
void wxPropertyGridInterface::SetPropertyChoicesExclusive | ( | wxPGPropArg | id | ) |
If property's set of choices is shared, then calling this method converts it to private.
void wxPropertyGridInterface::SetPropertyClientData | ( | wxPGPropArg | id, | |
wxPGProperty::ClientDataType | clientData | |||
) |
Sets client data (void*) of a property.
void wxPropertyGridInterface::SetPropertyEditor | ( | wxPGPropArg | id, | |
const wxString & | editorName | |||
) |
Sets editor control of a property.
As editor argument, use editor name string, such as wxT("TextCtrl") or wxT("Choice").
void wxPropertyGridInterface::SetPropertyEditor | ( | wxPGPropArg | id, | |
const wxPGEditor * | editor | |||
) |
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.
void wxPropertyGridInterface::SetPropertyHelpString | ( | wxPGPropArg | id, | |
const wxString & | helpString | |||
) |
Associates the help string with property.
void wxPropertyGridInterface::SetPropertyImage | ( | wxPGPropArg | id, | |
wxBitmap & | bmp | |||
) |
Set wxBitmap in front of the value.
void wxPropertyGridInterface::SetPropertyLabel | ( | wxPGPropArg | id, | |
const wxString & | newproplabel | |||
) |
Sets label of a property.
bool wxPropertyGridInterface::SetPropertyMaxLength | ( | wxPGPropArg | id, | |
int | maxLen | |||
) |
Sets max length of property's text.
void wxPropertyGridInterface::SetPropertyReadOnly | ( | wxPGPropArg | id, | |
bool | set = true , |
|||
int | flags = wxPG_RECURSE | |||
) |
Sets property (and, recursively, its children) to have read-only value.
In other words, user cannot change the value in the editor, but they can still copy it.
flags | By default changes are applied recursively. Set this paramter wxPG_DONT_RECURSE to prevent this. |
void wxPropertyGridInterface::SetPropertyValidator | ( | wxPGPropArg | id, | |
const wxValidator & | validator | |||
) |
Sets validator of a property.
void wxPropertyGridInterface::SetPropertyValue | ( | wxPGPropArg | id, | |
const wxArrayInt & | value | |||
) |
Sets value (wxArrayInt&) of a property.
void wxPropertyGridInterface::SetPropertyValue | ( | wxPGPropArg | id, | |
wxULongLong_t | value | |||
) |
Sets value (wxULongLong&) of a property.
void wxPropertyGridInterface::SetPropertyValue | ( | wxPGPropArg | id, | |
wxLongLong_t | value | |||
) |
Sets value (wxLongLong&) of a property.
void wxPropertyGridInterface::SetPropertyValue | ( | wxPGPropArg | id, | |
const wxSize & | value | |||
) |
Sets value (wxSize&) of a property.
void wxPropertyGridInterface::SetPropertyValue | ( | wxPGPropArg | id, | |
const wxPoint & | value | |||
) |
Sets value (wxPoint&) of a property.
void wxPropertyGridInterface::SetPropertyValue | ( | wxPGPropArg | id, | |
wxVariant | value | |||
) |
Sets value (wxVariant&) of a property.
void wxPropertyGridInterface::SetPropertyValue | ( | wxPGPropArg | id, | |
void * | value | |||
) |
Sets value (void*) of a property.
void wxPropertyGridInterface::SetPropertyValue | ( | wxPGPropArg | id, | |
wxObject * | value | |||
) |
Sets value (wxObject*) of a property.
void wxPropertyGridInterface::SetPropertyValue | ( | wxPGPropArg | id, | |
const wxString & | value | |||
) |
Sets value (wxString) of a property.
void wxPropertyGridInterface::SetPropertyValue | ( | wxPGPropArg | id, | |
const wxArrayString & | value | |||
) |
Sets value (wxArrayString) of a property.
void wxPropertyGridInterface::SetPropertyValue | ( | wxPGPropArg | id, | |
bool | value | |||
) |
Sets value (bool) of a property.
void wxPropertyGridInterface::SetPropertyValue | ( | wxPGPropArg | id, | |
double | value | |||
) |
Sets value (floating point) of a property.
void wxPropertyGridInterface::SetPropertyValue | ( | wxPGPropArg | id, | |
int | value | |||
) |
Sets value (integer) of a property.
void wxPropertyGridInterface::SetPropertyValue | ( | wxPGPropArg | id, | |
long | value | |||
) |
Sets value (long integer) of a property.
void wxPropertyGridInterface::SetPropertyValues | ( | const wxVariantList & | list, | |
wxPGPropArg | defaultCategory = ((wxPGProperty*)NULL) | |||
) |
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).
void wxPropertyGridInterface::SetPropertyValueUnspecified | ( | wxPGPropArg | id | ) |
Sets property's value to unspecified.
If it has children (it may be category), then the same thing is done to them.
void wxPropertyGridInterface::SetPropVal | ( | wxPGPropArg | id, | |
wxVariant & | value | |||
) |
Sets value (wxDateTime&) of a property.
Sets value (wxVariant&) of a property. Same as SetPropertyValue, but accepts reference.
void wxPropertyGridInterface::SetValidationFailureBehavior | ( | int | vfbFlags | ) |
Adjusts how wxPropertyGrid behaves when invalid value is entered in a property.
vfbFlags | See list of valid flags values |