wxPropertyGridInterface Class Reference

In order to have most same base methods, both wxPropertyGrid and wxPropertyGridManager must derive from this. More...

#include <propgrid.h>

Inheritance diagram for wxPropertyGridInterface:
Inheritance graph
[legend]

List of all members.

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=wxPG_INVALID_VALUE)
wxPGProperty * Append (wxPGProperty *property)
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 validation=true)
bool Collapse (wxPGPropArg id)
bool CollapseAll ()
void DeleteProperty (wxPGPropArg id)
void DeletePropertyChoice (wxPGPropArg id, int index)
bool DisableProperty (wxPGPropArg id)
bool EnableProperty (wxPGPropArg id, bool enable=true)
void EndAddChildren (wxPGPropArg id)
bool Expand (wxPGPropArg id)
bool ExpandAll (bool expand=true)
int GetColumnProportion (unsigned int column) const
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)
void GetPropertiesWithFlag (wxArrayPGProperty *targetArr, wxPGProperty::FlagType flags, bool inverse=false, int iterFlags=(wxPG_ITERATE_PROPERTIES|wxPG_ITERATE_HIDDEN|wxPG_ITERATE_CATEGORIES)) const
wxPGProperty * GetProperty (wxPGPropNameStr name) const
wxVariant GetPropertyAttribute (wxPGPropArg id, const wxString &attrName) const
const wxPGAttributeStorage & GetPropertyAttributes (wxPGPropArg id) const
wxPGProperty * GetPropertyByName (wxPGPropNameStr name, wxPGPropNameStr subname) const
wxPGProperty * GetPropertyByName (wxPGPropNameStr name) const
wxPGProperty * GetPropertyByNameA (wxPGPropNameStr name) const
wxPropertyCategory * GetPropertyCategory (wxPGPropArg id) const
wxPGChoices & GetPropertyChoices (wxPGPropArg id)
wxPG_CONST_WXCHAR_PTR 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)
wxString GetPropertyShortClassName (wxPGPropArg id)
wxVariant GetPropertyValue (wxPGPropArg id)
wxArrayInt GetPropertyValueAsArrayInt (wxPGPropArg id) const
wxArrayString GetPropertyValueAsArrayString (wxPGPropArg id) const
bool GetPropertyValueAsBool (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)
const wxArrayPGProperty & GetSelectedProperties () const
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)
void InsertPropertyChoice (wxPGPropArg id, const wxString &label, int index, int value=wxPG_INVALID_VALUE)
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
virtual bool IsPropertySelected (wxPGPropArg id) const
bool IsPropertyShown (wxPGPropArg id) const
bool IsPropertyUnspecified (wxPGPropArg id) 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 * RemoveProperty (wxPGPropArg id)
wxPGProperty * ReplaceProperty (wxPGPropArg id, wxPGProperty *property)
bool RestoreEditableState (const wxString &src, int restoreStates=AllStates)
wxString SaveEditableState (int includedStates=AllStates) const
bool SetColumnProportion (unsigned int column, int proportion)
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 SetPropertyValue (wxPGPropArg id, wxVariant value)
void SetPropertyValue (wxPGPropArg id, wxObject &value)
void SetPropertyValue (wxPGPropArg id, void *value)
void SetPropertyValue (wxPGPropArg id, const wxChar *value)
void SetPropertyValue (wxPGPropArg id, int value)
void SetPropertyValueArrint2 (wxPGPropArg id, const wxArrayInt &value)
void SetPropertyValueArrstr2 (wxPGPropArg id, const wxArrayString &value)
void SetPropertyValueBool (wxPGPropArg id, bool value)
void SetPropertyValueDouble (wxPGPropArg id, double value)
void SetPropertyValueLong (wxPGPropArg id, long value)
void SetPropertyValueLongLong (wxPGPropArg id, wxLongLong_t value)
void SetPropertyValuePoint (wxPGPropArg id, const wxPoint &value)
void SetPropertyValues (const wxVariant &list, wxPGPropArg defaultCategory=wxNullProperty)
void SetPropertyValues (const wxVariantList &list, wxPGPropArg defaultCategory=wxNullProperty)
void SetPropertyValueSize (wxPGPropArg id, const wxSize &value)
void SetPropertyValueString (wxPGPropArg id, const wxString &value)
void SetPropertyValueULongLong (wxPGPropArg id, wxULongLong_t value)
void SetPropertyValueUnspecified (wxPGPropArg id)
void SetPropertyValueWxObjectPtr (wxPGPropArg id, wxObject *value)
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

bool DoClearSelection (bool validation, int selFlags=0)
virtual wxPGProperty * DoGetPropertyByName (wxPGPropNameStr 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

Private Member Functions

const wxPropertyGrid * GetPropertyGrid () const
wxPropertyGrid * GetPropertyGrid ()

Friends

class wxPropertyGrid
class wxPropertyGridManager

Detailed Description

In order to have most same base methods, both wxPropertyGrid and wxPropertyGridManager must derive from this.

Definition at line 4815 of file propgrid.h.

Member Enumeration Documentation

enum wxPropertyGridInterface::EditableStateFlags

Flags for wxPropertyGridInterface::SaveEditableState() and wxPropertyGridInterface::RestoreEditableState().

Enumerator:
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.

Definition at line 5635 of file propgrid.h.

Constructor & Destructor Documentation

virtual wxPropertyGridInterface::~wxPropertyGridInterface (  )  [inline, virtual]

Destructor

Definition at line 4823 of file propgrid.h.

Member Function Documentation

void wxPropertyGridInterface::AddPropertyChoice ( wxPGPropArg  id,
const wxString &  label,
int  value = wxPG_INVALID_VALUE 
)

Adds choice to a property that can accept one.

Remarks:
  • If you need to make sure that you modify only the set of choices of a single property (and not also choices of other properties with initially identical set), call wxPropertyGrid::SetPropertyChoicesPrivate.
  • This usually only works for wxEnumProperty and derivatives (wxFlagsProperty can get accept new items but its items may not get updated).
wxPGProperty* wxPropertyGridInterface::Append ( wxPGProperty *  property  ) 

Appends property to the list. wxPropertyGrid assumes ownership of the object. Becomes child of most recently added category.

Remarks:
  • wxPropertyGrid takes the ownership of the property pointer.
  • If appending a category with name identical to a category already in the wxPropertyGrid, then newly created category is deleted, and most recently added category (under which properties are appended) is set to the one with same name. This allows easier adding of items to same categories in multiple passes.
  • Does not automatically redraw the control, so you may need to call Refresh when calling this function after control has been shown for the first time.
wxPGProperty* wxPropertyGridInterface::AppendIn ( wxPGPropArg  id,
wxPGProperty *  newproperty 
)
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.

Return values:
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  )  [inline]

Resets value of a property to its default.

Definition at line 4912 of file propgrid.h.

bool wxPropertyGridInterface::ClearSelection ( bool  validation = true  ) 

Clears current selection, if any. Returns true if success (ie. validator did not intercept). You can set validation = false to let selection be cleared even if property had invalid value in its editor.

bool wxPropertyGridInterface::Collapse ( wxPGPropArg  id  ) 

Collapses given category or property with children. Returns true if actually collapses.

bool wxPropertyGridInterface::CollapseAll (  )  [inline]

Collapses all items that can be collapsed.

Return values:
Return false if failed (may fail if editor value cannot be validated).

Definition at line 4892 of file propgrid.h.

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.

Remarks:
Cannot generate property category.
void wxPropertyGridInterface::DeleteProperty ( wxPGPropArg  id  ) 

Removes and deletes a property.

Parameters:
id Pointer or name of a property.
Remarks:
If you delete a property in a wxPropertyGrid event handler, the actual deletion is postponed until the next idle event.
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::DisableProperty ( wxPGPropArg  id  )  [inline]

Disables property.

Definition at line 4984 of file propgrid.h.

bool wxPropertyGridInterface::DoClearSelection ( bool  validation,
int  selFlags = 0 
) [protected]
virtual wxPGProperty* wxPropertyGridInterface::DoGetPropertyByName ( wxPGPropNameStr  name  )  const [protected, virtual]
virtual bool wxPropertyGridInterface::DoSelectPage ( int   WXUNUSEDindex  )  [inline, protected, virtual]

Definition at line 6410 of file propgrid.h.

void wxPropertyGridInterface::DoSetPropertyAttribute ( wxPGPropArg  id,
const wxString &  name,
wxVariant &  value,
long  argFlags 
) [protected]
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.

int wxPropertyGridInterface::GetColumnProportion ( unsigned int  column  )  const [inline]

Returns auto-resize proportion of the given column.

See also:
SetColumnProportion()

Definition at line 5724 of file propgrid.h.

virtual wxVariant wxPropertyGridInterface::GetEditableStateItem ( const wxString &  name  )  const [inline, protected, virtual]

In derived class, implement to return editable state component with given name.

Definition at line 6396 of file propgrid.h.

static wxPGEditor* wxPropertyGridInterface::GetEditorByName ( const wxString &  editorName  )  [static]
wxArrayPGProperty wxPropertyGridInterface::GetExpandedProperties (  )  const [inline]

Returns list of expanded properties.

Remarks:
If wxPG_USE_STL is 1, then wxArrayPGProperty is typedef of std::vector<wxPGProperty*>.

Definition at line 5003 of file propgrid.h.

const wxPGProperty* wxPropertyGridInterface::GetFirst ( int  flags = wxPG_ITERATE_ALL  )  const [inline]

Definition at line 5079 of file propgrid.h.

wxPGProperty* wxPropertyGridInterface::GetFirst ( int  flags = wxPG_ITERATE_ALL  )  [inline]

Returns id of first item, whether it is a category or property.

Parameters:
flags List of iterator flags

Definition at line 5073 of file propgrid.h.

wxPGProperty* wxPropertyGridInterface::GetFirstChild ( wxPGPropArg  id  )  [inline]

Returns id of first child of given property.

Remarks:
Does not return sub-properties!

Definition at line 5015 of file propgrid.h.

wxPropertyGridConstIterator wxPropertyGridInterface::GetIterator ( int  flags,
int  startPos 
) const [inline]

Reimplemented in wxPropertyGridManager.

Definition at line 5058 of file propgrid.h.

wxPropertyGridIterator wxPropertyGridInterface::GetIterator ( int  flags,
int  startPos 
) [inline]

Returns iterator class instance.

Parameters:
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.

Definition at line 5053 of file propgrid.h.

wxPropertyGridConstIterator wxPropertyGridInterface::GetIterator ( int  flags = wxPG_ITERATE_DEFAULT,
wxPGProperty *  firstProp = NULL 
) const [inline]

Reimplemented in wxPropertyGridManager.

Definition at line 5038 of file propgrid.h.

wxPropertyGridIterator wxPropertyGridInterface::GetIterator ( int  flags = wxPG_ITERATE_DEFAULT,
wxPGProperty *  firstProp = NULL 
) [inline]

Returns iterator class instance.

Parameters:
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.

Definition at line 5033 of file propgrid.h.

virtual wxPropertyGridState* wxPropertyGridInterface::GetPageState ( int  pageIndex  )  const [inline, protected, virtual]

Reimplemented in wxPropertyGridManager.

Definition at line 6403 of file propgrid.h.

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.

Parameters:
flags Property flags to use.
iterFlags Iterator flags to use. Default is everything expect private children.
Remarks:
If wxPG_USE_STL is 1, then wxArrayPGProperty is typedef of std::vector<wxPGProperty*>.
wxPGProperty* wxPropertyGridInterface::GetProperty ( wxPGPropNameStr  name  )  const [inline]

Returns pointer to the property with given name (case-sensitive). If there is no property with such name, pointer is returned.

Remarks:
Properties which have non-category, non-root parent can not be accessed globally by their name. Instead, use "<property>.<subproperty>" instead of "<subproperty>".

Definition at line 5144 of file propgrid.h.

wxVariant wxPropertyGridInterface::GetPropertyAttribute ( wxPGPropArg  id,
const wxString &  attrName 
) const [inline]

Returns value of given attribute. If none found, returns NULL-variant.

Definition at line 5130 of file propgrid.h.

const wxPGAttributeStorage& wxPropertyGridInterface::GetPropertyAttributes ( wxPGPropArg  id  )  const [inline]

Returns map-like storage of property's attributes.

Remarks:
Note that if extra style wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES is set, then builtin-attributes are not included in the storage.

Definition at line 5098 of file propgrid.h.

wxPGProperty* wxPropertyGridInterface::GetPropertyByName ( wxPGPropNameStr  name,
wxPGPropNameStr  subname 
) const

Returns id of a sub-property 'subname' of property 'name'. Same as calling GetPropertyByNameI(wxT("name.subname")), albeit slightly faster.

wxPGProperty* wxPropertyGridInterface::GetPropertyByName ( wxPGPropNameStr  name  )  const

Returns pointer to the property with given name (case-sensitive). If there is no property with such name, pointer is returned.

Remarks:
Properties which have non-category, non-root parent can not be accessed globally by their name. Instead, use "<property>.<subproperty>" instead of "<subproperty>".
wxPGProperty* wxPropertyGridInterface::GetPropertyByNameA ( wxPGPropNameStr  name  )  const
wxPropertyCategory* wxPropertyGridInterface::GetPropertyCategory ( wxPGPropArg  id  )  const [inline]

Returns pointer of property's nearest parent category. If no category found, returns NULL.

Definition at line 5915 of file propgrid.h.

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.

wxPG_CONST_WXCHAR_PTR wxPropertyGridInterface::GetPropertyClassName ( wxPGPropArg  id  )  const [inline]

Gets name of property's constructor function.

Definition at line 5171 of file propgrid.h.

wxPGProperty::ClientDataType wxPropertyGridInterface::GetPropertyClientData ( wxPGPropArg  id  )  const [inline]

Returns client data (void*) of a property.

Definition at line 5178 of file propgrid.h.

const wxPGEditor* wxPropertyGridInterface::GetPropertyEditor ( wxPGPropArg  id  )  const [inline]

Returns property's editor.

Definition at line 5184 of file propgrid.h.

const wxPropertyGrid* wxPropertyGridInterface::GetPropertyGrid (  )  const [inline, private]

Definition at line 6433 of file propgrid.h.

wxPropertyGrid* wxPropertyGridInterface::GetPropertyGrid (  )  [inline, private]

Definition at line 6427 of file propgrid.h.

wxString wxPropertyGridInterface::GetPropertyHelpString ( wxPGPropArg  id  )  const [inline]

Returns help string associated with a property.

Definition at line 5235 of file propgrid.h.

wxBitmap* wxPropertyGridInterface::GetPropertyImage ( wxPGPropArg  id  )  const [inline]

Returns property's custom value image (NULL of none).

Definition at line 5191 of file propgrid.h.

unsigned int wxPropertyGridInterface::GetPropertyIndex ( wxPGPropArg  id  )  [inline]

Returns property's position under its parent.

Definition at line 5198 of file propgrid.h.

const wxString& wxPropertyGridInterface::GetPropertyLabel ( wxPGPropArg  id  )  [inline]

Returns label of a property.

Definition at line 5205 of file propgrid.h.

wxString wxPropertyGridInterface::GetPropertyName ( wxPGPropArg  id  )  [inline]

Returns name of a property, by which it is globally accessible.

Definition at line 5211 of file propgrid.h.

wxPGProperty* wxPropertyGridInterface::GetPropertyParent ( wxPGPropArg  id  )  [inline]

Returns parent item of a property.

Definition at line 5218 of file propgrid.h.

wxString wxPropertyGridInterface::GetPropertyShortClassName ( wxPGPropArg  id  ) 

Returns short name for property's class. For example, "wxPropertyCategory" translates to "Category" and "wxIntProperty" to "Int".

wxVariant wxPropertyGridInterface::GetPropertyValue ( wxPGPropArg  id  )  [inline]

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.

Definition at line 5264 of file propgrid.h.

wxArrayInt wxPropertyGridInterface::GetPropertyValueAsArrayInt ( wxPGPropArg  id  )  const [inline]

Definition at line 5335 of file propgrid.h.

wxArrayString wxPropertyGridInterface::GetPropertyValueAsArrayString ( wxPGPropArg  id  )  const [inline]

Definition at line 5305 of file propgrid.h.

bool wxPropertyGridInterface::GetPropertyValueAsBool ( wxPGPropArg  id  )  const
double wxPropertyGridInterface::GetPropertyValueAsDouble ( wxPGPropArg  id  )  const
int wxPropertyGridInterface::GetPropertyValueAsInt ( wxPGPropArg  id  )  const [inline]

Definition at line 5285 of file propgrid.h.

long wxPropertyGridInterface::GetPropertyValueAsLong ( wxPGPropArg  id  )  const
wxLongLong_t wxPropertyGridInterface::GetPropertyValueAsLongLong ( wxPGPropArg  id  )  const [inline]

Definition at line 5323 of file propgrid.h.

wxPoint wxPropertyGridInterface::GetPropertyValueAsPoint ( wxPGPropArg  id  )  const [inline]

Definition at line 5311 of file propgrid.h.

wxSize wxPropertyGridInterface::GetPropertyValueAsSize ( wxPGPropArg  id  )  const [inline]

Definition at line 5317 of file propgrid.h.

wxString wxPropertyGridInterface::GetPropertyValueAsString ( wxPGPropArg  id  )  const
unsigned long wxPropertyGridInterface::GetPropertyValueAsULong ( wxPGPropArg  id  )  const [inline]

Definition at line 5280 of file propgrid.h.

wxULongLong_t wxPropertyGridInterface::GetPropertyValueAsULongLong ( wxPGPropArg  id  )  const [inline]

Definition at line 5329 of file propgrid.h.

void* wxPropertyGridInterface::GetPropertyValueAsVoidPtr ( wxPGPropArg  id  )  const
wxObject* wxPropertyGridInterface::GetPropertyValueAsWxObjectPtr ( wxPGPropArg  id  )  const
wxVariant wxPropertyGridInterface::GetPropertyValues ( const wxString &  listname = wxEmptyString,
wxPGProperty *  baseparent = NULL,
long  flags = 0 
) const [inline]

Returns a wxVariant list containing wxVariant versions of all property values. Order is not guaranteed.

Parameters:
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."
Remarks:

Definition at line 5373 of file propgrid.h.

wxString wxPropertyGridInterface::GetPropertyValueType ( wxPGPropArg  id  )  [inline]

Definition at line 5380 of file propgrid.h.

const wxArrayPGProperty& wxPropertyGridInterface::GetSelectedProperties (  )  const [inline]

Returns list of currently selected properties.

Remarks:
wxArrayPGProperty should be compatible with std::vector API.

Definition at line 5413 of file propgrid.h.

wxPGProperty* wxPropertyGridInterface::GetSelection (  )  const

Returns currently selected property. NULL if none.

Remarks:
When wxPG_EX_MULTIPLE_SELECTION extra style is used, this member function returns the focused property, that is the one that can have active editor.

Reimplemented in wxPropertyGridManager.

wxPropertyGridState* wxPropertyGridInterface::GetState (  )  const [inline]

Definition at line 5419 of file propgrid.h.

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.

Parameters:
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 (  )  [inline, static]

Definition at line 5447 of file propgrid.h.

wxPGProperty* wxPropertyGridInterface::Insert ( wxPGPropArg  parent,
int  index,
wxPGProperty *  newproperty 
)

Also see documentation for Insert .

Parameters:
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.

Parameters:
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.
Returns:
Returns id for the property,
Remarks:

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 = wxPG_INVALID_VALUE 
)

Inserts choice to a property that can accept one.

See AddPropertyChoice for more details.

bool wxPropertyGridInterface::IsPropertyCategory ( wxPGPropArg  id  )  const [inline]

Returns true if property is a category.

Definition at line 5569 of file propgrid.h.

bool wxPropertyGridInterface::IsPropertyEnabled ( wxPGPropArg  id  )  const [inline]

Returns true if property is enabled.

Definition at line 5516 of file propgrid.h.

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 [inline]

Returns true if property is of certain type.

Parameters:
info Preferably use WX_PG_CLASSINFO(PROPERTYNAME). Alternative is PROPERTYNAMEClassInfo.

Definition at line 5552 of file propgrid.h.

bool wxPropertyGridInterface::IsPropertyModified ( wxPGPropArg  id  )  const [inline]

Returns true if property has been modified after value set or modify flag clear by software.

Definition at line 5578 of file propgrid.h.

virtual bool wxPropertyGridInterface::IsPropertySelected ( wxPGPropArg  id  )  const [virtual]

Returns true if property is selected.

Reimplemented in wxPropertyGridManager.

bool wxPropertyGridInterface::IsPropertyShown ( wxPGPropArg  id  )  const [inline]

Returns true if property is shown (ie. hideproperty with true not called for it).

Definition at line 5528 of file propgrid.h.

bool wxPropertyGridInterface::IsPropertyUnspecified ( wxPGPropArg  id  )  const [inline]

Returns true if property value is set to unspecified.

Definition at line 5589 of file propgrid.h.

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.

Remarks:
If wxPG_USE_STL is 1, then wxArrayPGProperty is typedef of std::vector<wxPGProperty*>.
void wxPropertyGridInterface::PropertiesToNames ( wxArrayString *  names,
const wxArrayPGProperty &  properties 
) const

Converts array of properties to array of names.

Remarks:
If wxPG_USE_STL is 1, then wxArrayPGProperty is typedef of std::vector<wxPGProperty*>.
virtual void wxPropertyGridInterface::RefreshGrid ( wxPropertyGridState *  state = NULL  )  [virtual]

If state is shown in it's grid, refresh it now.

virtual void wxPropertyGridInterface::RefreshProperty ( wxPGProperty *  p  )  [pure virtual]

Implemented in wxPropertyGridPage, wxPropertyGridManager, and wxPropertyGrid.

static void wxPropertyGridInterface::RegisterAdditionalEditors (  )  [inline, static]

Definition at line 5437 of file propgrid.h.

wxPGProperty* wxPropertyGridInterface::RemoveProperty ( wxPGPropArg  id  ) 

Removes a property. Does not delete the property object, but instead returns it.

Parameters:
id Pointer or name of a property.
Remarks:
Removed property cannot have any children.

Also, if you remove property in a wxPropertyGrid event handler, the actual removal is postponed until the next idle event.

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

For more info, see wxPropertyGrid::Insert.

bool wxPropertyGridInterface::RestoreEditableState ( const wxString &  src,
int  restoreStates = AllStates 
)

Restores user-editable state.

See also wxPropertyGridInterface::SaveEditableState().

Parameters:
src String generated by SaveEditableState.
restoreStates Which parts to restore from source string. See list of editable state flags".
Returns:
False if there was problem reading the string.
Remarks:
If some parts of state (such as scrolled or splitter position) fail to restore correctly, please make sure that you call this function after wxPropertyGrid size has been set (this may sometimes be tricky when sizers are used).
wxString wxPropertyGridInterface::SaveEditableState ( int  includedStates = AllStates  )  const

Used to acquire user-editable state (selected property, expanded properties, scrolled position, splitter positions).

Parameters:
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.

bool wxPropertyGridInterface::SetColumnProportion ( unsigned int  column,
int  proportion 
)

Set proportion of a auto-stretchable column.

Returns:
Returns on failure.
Remarks:
This member function will fail unless window style wxPG_SPLITTER_AUTO_CENTER is used.

Also, you should call this for individual pages of wxPropertyGridManager (if used).

See also:
GetColumnProportion()
virtual bool wxPropertyGridInterface::SetEditableStateItem ( const wxString &  name,
wxVariant  value 
) [inline, protected, virtual]

In derived class, implement to set editable state component with given name to given value.

Definition at line 6385 of file propgrid.h.

void wxPropertyGridInterface::SetExpandedProperties ( const wxArrayPGProperty &  array,
bool  expand = true 
) [inline]

Sets all properties in given array as expanded.

Parameters:
expand False if you want to collapse properties instead.
Remarks:
If wxPG_USE_STL is 1, then wxArrayPGProperty is typedef of std::vector<wxPGProperty*>.

Definition at line 5736 of file propgrid.h.

void wxPropertyGridInterface::SetPropertiesFlag ( const wxArrayPGProperty &  srcArr,
wxPGProperty::FlagType  flags,
bool  inverse = false 
)

Sets or clears flag(s) of all properties in given array.

Parameters:
flags Property flags to set or clear.
inverse Set to true if you want to clear flag instead of setting them.
Remarks:
If wxPG_USE_STL is 1, then wxArrayPGProperty is typedef of std::vector<wxPGProperty*>.
void wxPropertyGridInterface::SetPropertyAttribute ( wxPGPropArg  id,
const wxString &  attrName,
wxVariant  value,
long  argFlags = 0 
) [inline]

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.

Parameters:
argFlags Optional. Use wxPG_RECURSE to set the attribute to child properties as well.
Remarks:
  • Settings attribute's value to Null variant will simply remove it from property's set of attributes.
  • wxVariant doesn't have int constructor (as of 2.5.4), so you will need to cast int values (including most numeral constants) to long.

Definition at line 5809 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyAttributes ( wxPGPropArg  id,
const wxPGAttributeStorage &  attributes 
) [inline]

Sets attributes from a wxPGAttributeStorage.

Definition at line 5106 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyCell ( wxPGPropArg  id,
int  column,
const wxString &  text = wxEmptyString,
const wxBitmap &  bitmap = wxNullBitmap,
const wxColour &  fgCol = wxNullColour,
const wxColour &  bgCol = wxNullColour 
) [inline]

Sets text, bitmap, and colours for given column's cell.

Remarks:
  • You can set label cell by setting column to 0.
  • You can use wxPG_LABEL as text to use default text for column.

Definition at line 5759 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyChoices ( wxPGPropArg  id,
wxPGChoices &  choices 
) [inline]

Set choices of a property to specified set of labels and values.

Remarks:
This operation clears the property value. Also, if you try to use this on a property which cannot hold choices, a run-time error will be shown.

This function will deselect the property, if necessary.

Definition at line 5780 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyChoicesExclusive ( wxPGPropArg  id  )  [inline]

If property's set of choices is shared, then calling this method converts it to private.

Definition at line 5790 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyClientData ( wxPGPropArg  id,
wxPGProperty::ClientDataType  clientData 
) [inline]

Sets client data (void*) of a property.

Remarks:
This untyped client data has to be deleted manually.

Definition at line 5850 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyEditor ( wxPGPropArg  id,
const wxString &  editorName 
) [inline]

Sets editor control of a property. As editor argument, use editor name string, such as wxT("TextCtrl") or wxT("Choice").

Definition at line 5833 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyEditor ( wxPGPropArg  id,
const wxPGEditor *  editor 
) [inline]

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.

Definition at line 5821 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyHelpString ( wxPGPropArg  id,
const wxString &  helpString 
) [inline]

Associates the help string with property.

Remarks:
By default, text is shown either in the manager's "description" text box or in the status bar. If extra window style wxPG_EX_HELP_AS_TOOLTIPS is used, then the text will appear as a tooltip.

Definition at line 5927 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyImage ( wxPGPropArg  id,
wxBitmap &  bmp 
) [inline]

Set wxBitmap in front of the value.

Remarks:

Definition at line 5937 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyLabel ( wxPGPropArg  id,
const wxString &  newproplabel 
)

Sets label of a property.

Remarks:
  • Properties under same parent may have same labels. However, property names must still remain unique.
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 
) [inline]

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.

Parameters:
flags By default changes are applied recursively. Set this paramter wxPG_DONT_RECURSE to prevent this.
Remarks:
This is mainly for use with textctrl editor. Not all other editors fully support it.

Also note that read-only state does not immediately become active for currently open property editor.

Definition at line 5879 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyValue ( wxPGPropArg  id,
wxVariant  value 
) [inline]

Sets value (wxVariant&) of a property.

Remarks:
Use wxPropertyGrid::ChangePropertyValue() instead if you need to run through validation process and send property change event.

Definition at line 6049 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyValue ( wxPGPropArg  id,
wxObject &  value 
) [inline]

Definition at line 6036 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyValue ( wxPGPropArg  id,
void *  value 
) [inline]

Sets value (void*) of a property.

Definition at line 6031 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyValue ( wxPGPropArg  id,
const wxChar *  value 
) [inline]

Definition at line 5990 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyValue ( wxPGPropArg  id,
int  value 
) [inline]

Sets value (integer) of a property.

Definition at line 5969 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyValueArrint2 ( wxPGPropArg  id,
const wxArrayInt &  value 
) [inline]

Sets value (wxArrayInt&) of a property.

Definition at line 6084 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyValueArrstr2 ( wxPGPropArg  id,
const wxArrayString &  value 
) [inline]

Sets value (wxArrayString) of a property.

Definition at line 5998 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyValueBool ( wxPGPropArg  id,
bool  value 
) [inline]

Sets value (bool) of a property.

Definition at line 5984 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyValueDouble ( wxPGPropArg  id,
double  value 
) [inline]

Sets value (floating point) of a property.

Definition at line 5977 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyValueLong ( wxPGPropArg  id,
long  value 
) [inline]

Sets value (long integer) of a property.

Definition at line 5960 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyValueLongLong ( wxPGPropArg  id,
wxLongLong_t  value 
) [inline]

Sets value (wxLongLong&) of a property.

Definition at line 6070 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyValuePoint ( wxPGPropArg  id,
const wxPoint &  value 
) [inline]

Sets value (wxPoint&) of a property.

Definition at line 6056 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyValues ( const wxVariant &  list,
wxPGPropArg  defaultCategory = wxNullProperty 
) [inline]

Sets property values from a list of wxVariants.

Definition at line 5905 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyValues ( const wxVariantList &  list,
wxPGPropArg  defaultCategory = wxNullProperty 
) [inline]

Sets property values from a list of wxVariants.

Definition at line 5893 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyValueSize ( wxPGPropArg  id,
const wxSize &  value 
) [inline]

Sets value (wxSize&) of a property.

Definition at line 6063 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyValueString ( wxPGPropArg  id,
const wxString &  value 
)

Sets value (wxString) of a property.

Remarks:
This method uses wxPGProperty::SetValueFromString, which all properties should implement. This means that there should not be a type error, and instead the string is converted to property's actual value type.
void wxPropertyGridInterface::SetPropertyValueULongLong ( wxPGPropArg  id,
wxULongLong_t  value 
) [inline]

Sets value (wxULongLong&) of a property.

Definition at line 6077 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyValueUnspecified ( wxPGPropArg  id  )  [inline]

Sets property's value to unspecified. If it has children (it may be category), then the same thing is done to them.

Definition at line 5859 of file propgrid.h.

void wxPropertyGridInterface::SetPropertyValueWxObjectPtr ( wxPGPropArg  id,
wxObject *  value 
) [inline]

Sets value (wxObject*) of a property.

Definition at line 6023 of file propgrid.h.

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.

Parameters:
vfbFlags See list of valid flags values

Friends And Related Function Documentation

friend class wxPropertyGrid [friend]

Definition at line 4818 of file propgrid.h.

friend class wxPropertyGridManager [friend]

Reimplemented in wxPropertyGridPage, and wxPropertyGrid.

Definition at line 4819 of file propgrid.h.

Member Data Documentation

wxString wxPropertyGridInterface::m_emptyString [protected]

Definition at line 6423 of file propgrid.h.

wxPropertyGridState* wxPropertyGridInterface::m_pState [protected]

Definition at line 6417 of file propgrid.h.

The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

wxpropgrid
Author(s): Jaakko Salli
autogenerated on Fri Jan 11 11:37:54 2013