#include <propgrid.h>
Inheritance diagram for wxPropertyContainerMethods:
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) |
void | BeginAddChildren (const wxString &name) |
void | BeginAddChildren (wxPGId id) |
void | Delete (const wxString &name) |
void | Delete (wxPGId id) |
void | DeletePropertyChoice (const wxString &name, int index) |
void | DeletePropertyChoice (wxPGId id, int index) |
void | EndAddChildren (const wxString &name) |
void | EndAddChildren (wxPGId id) |
wxPGId | GetFirstChild (const wxString &name) |
wxPGId | GetFirstChild (wxPGId id) |
wxPGId | GetNextSibling (const wxString &name) |
wxPGId | GetNextSibling (wxPGId id) |
wxString | GetPropertyAttributes (wxPGId id, unsigned int flagmask=0xFFFF) const |
wxPGId | GetPropertyByName (const wxString &name, const wxString &subname) const |
wxPGId | GetPropertyByName (const wxString &name) const |
wxPGId | GetPropertyByNameA (const wxString &name) 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 |
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 |
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 |
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) |
wxPropertyGridState * | GetState () const |
bool | HideProperty (const wxString &name) |
bool | HideProperty (wxPGId id, bool hide=true) |
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 | 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 | 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) |
wxPGId | ReplaceProperty (const wxString &name, wxPGProperty *property) |
wxPGId | ReplaceProperty (wxPGId id, wxPGProperty *property) |
void | SetPropertyAttribute (const wxString &name, int attrid, wxVariant value, long argFlags=0) |
void | SetPropertyAttribute (wxPGId id, int attrid, wxVariant value, long argFlags=0) |
void | SetPropertyAttributes (const wxString &name, const wxString &attributes) const |
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 | 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) |
bool | SetPropertyMaxLength (const wxString &name, int maxLen) |
bool | SetPropertyMaxLength (wxPGId id, int maxLen) |
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 | SetPropertyValidator (const wxString &name, const wxValidator &validator) |
void | SetPropertyValidator (wxPGId id, const wxValidator &validator) |
void | TogglePropertyPriority (const wxString &name) |
void | TogglePropertyPriority (wxPGId id) |
virtual | ~wxPropertyContainerMethods () |
Static Public Member Functions | |
wxPGProperty * | CreatePropertyByClass (const wxString &classname, const wxString &label, const wxString &name) |
wxPGProperty * | CreatePropertyByType (const wxString &valuetype, const wxString &label, const wxString &name) |
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 () |
bool | RegisterPropertyClass (const wxChar *name, wxPGPropertyClassInfo *classinfo) |
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 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 |
|
Destructor.
|
|
Adds choice to a property that can accept one.
|
|
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. |
|
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.
|
|
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. |
|
Called after population of property with fixed children has finished.
|
|
Returns id of first child of given property.
|
|
Returns next item under the same parent.
|
|
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 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 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 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 short name for property's class. For example, "wxPropertyCategory" translates to "Category" and "wxIntProperty" to "Int". |
|
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 wxPGValueType class instance that describes the property's data type.
|
|
Returns property value type identifier.
|
|
Returns property value type name.
|
|
Returns value type class instance for given type name.
|
|
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 choice to a property that can accept one. See AddPropertyChoice for more details. |
|
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 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.
|
|
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 property class info with specific name. Preferably use wxPGRegisterPropertyClass(PROPERTYNAME) macro. |
|
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. |
|
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. |
|
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 attributes from a string generated by GetPropertyAttributes.
|
|
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 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 max length of property's text.
|
|
Sets max length of property's text.
|
|
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 validator of a property. For example
|
|
Toggles priority of a property between wxPG_HIGH and wxPG_LOW.
|
|
Toggles priority of a property between wxPG_HIGH and wxPG_LOW.
|