wxPropertyGridManager Class Reference

wxPropertyGridManager is an efficient multi-page version of wxPropertyGrid, which can optionally have toolbar for mode and page selection, help text box, and a compactor button. More...

#include <manager.h>

Inheritance diagram for wxPropertyGridManager:

wxPropertyContainerMethods List of all members.

Public Member Functions

int AddPage (const wxString &label=wxEmptyString, const wxBitmap &bmp=wxNullBitmap, wxPropertyGridPage *pageObj=(wxPropertyGridPage *) NULL)
void AddPropertyChoice (const wxString &name, const wxString &label, int value=INT_MAX)
void AddPropertyChoice (wxPGId id, const wxString &label, int value=INT_MAX)
wxPGId Append (const wxString &label, const wxString &name, bool value)
wxPGId Append (const wxString &label, const wxString &name, double value)
wxPGId Append (const wxString &label, const wxString &name, int value)
wxPGId Append (const wxString &label, const wxString &name, const wxString &value=wxEmptyString)
wxPGId Append (wxPGProperty *property)
wxPGId AppendCategory (const wxString &label, const wxString &name=(*((wxString *) NULL)))
wxPGId AppendIn (const wxString &name, wxPGProperty *property)
wxPGId AppendIn (wxPGId id, wxPGProperty *property)
void BeginAddChildren (const wxString &name)
void BeginAddChildren (wxPGId id)
bool CanClose ()
void ClearModifiedStatus ()
void ClearModifiedStatus (wxPGId id)
void ClearPage (int page)
bool ClearPropertyValue (const wxString &name)
bool ClearPropertyValue (wxPGId id)
bool ClearSelection ()
bool Collapse (const wxString &name)
bool Collapse (wxPGId id)
bool CollapseAll ()
bool Compact (bool compact)
bool Create (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=(0), const wxChar *name=wxPropertyGridManagerNameStr)
void Delete (const wxString &name)
void Delete (wxPGId id)
void DeletePropertyChoice (const wxString &name, int index)
void DeletePropertyChoice (wxPGId id, int index)
bool DisableProperty (const wxString &name)
bool DisableProperty (wxPGId id)
bool EnableCategories (bool enable)
bool EnableProperty (const wxString &name, bool enable=true)
bool EnableProperty (wxPGId id, bool enable=true)
void EndAddChildren (const wxString &name)
void EndAddChildren (wxPGId id)
bool EnsureVisible (const wxString &name)
bool EnsureVisible (wxPGId id)
bool Expand (const wxString &name)
bool Expand (wxPGId id)
bool ExpandAll ()
size_t GetChildrenCount (const wxString &name)
size_t GetChildrenCount (wxPGId id) const
size_t GetChildrenCount (int pageIndex)
size_t GetChildrenCount ()
int GetDescBoxHeight () const
wxPGId GetFirst () const
wxPGId GetFirstCategory () const
wxPGId GetFirstChild (const wxString &name)
wxPGId GetFirstChild (wxPGId id)
wxPGId GetFirstProperty () const
wxPropertyGridGetGrid ()
wxPGId GetLastChild (const wxString &name)
wxPGId GetLastChild (wxPGId id)
wxPGId GetNextCategory (wxPGId id) const
wxPGId GetNextProperty (wxPGId id) const
wxPGId GetNextSibling (const wxString &name)
wxPGId GetNextSibling (wxPGId id)
wxPropertyGridPageGetPage (unsigned int ind) const
int GetPageByName (const wxChar *name) const
int GetPageByState (wxPropertyGridState *pstate) const
size_t GetPageCount () const
const wxString & GetPageName (int index) const
wxPGId GetPageRoot (int index) const
wxPGId GetPrevProperty (wxPGId id) const
wxPGId GetPrevSibling (const wxString &name)
wxPGId GetPrevSibling (wxPGId id)
wxString GetPropertyAttributes (wxPGId id, unsigned int flagmask=0xFFFF) const
wxPGId GetPropertyByLabel (const wxString &name, wxPropertyGridState **ppState=(wxPropertyGridState **) NULL) const
wxPGId GetPropertyByName (const wxString &name, const wxString &subname) const
wxPGId GetPropertyByName (const wxString &name) const
wxPGId GetPropertyByNameA (const wxString &name) const
wxPGId GetPropertyCategory (const wxString &name) const
wxPGId GetPropertyCategory (wxPGId id) const
wxPGChoicesGetPropertyChoices (const wxString &name)
wxPGChoicesGetPropertyChoices (wxPGId id)
const wxChar * GetPropertyClassName (const wxString &name) const
const wxChar * GetPropertyClassName (wxPGId id) const
void * GetPropertyClientData (const wxString &name) const
void * GetPropertyClientData (wxPGId id) const
wxColour GetPropertyColour (const wxString &name) const
wxColour GetPropertyColour (wxPGId id) const
const wxPGEditorGetPropertyEditor (const wxString &name) const
const wxPGEditorGetPropertyEditor (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)
wxPGPropertyGetPropertyPtr (const wxString &name) const
wxPGPropertyGetPropertyPtr (wxPGId id) const
wxColour GetPropertyTextColour (const wxString &name) const
wxColour GetPropertyTextColour (wxPGId id) const
wxValidator * GetPropertyValidator (const wxString &name)
wxValidator * GetPropertyValidator (wxPGId id)
wxVariant GetPropertyValue (const wxString &name)
wxVariant GetPropertyValue (wxPGId id)
const wxArrayInt & GetPropertyValueAsArrayInt (const wxString &name) const
const wxArrayString & GetPropertyValueAsArrayString (const wxString &name) const
bool GetPropertyValueAsBool (const wxString &name) const
wxDateTime GetPropertyValueAsDateTime (const wxString &name) const
double GetPropertyValueAsDouble (const wxString &name) const
int GetPropertyValueAsInt (const wxString &name) const
long GetPropertyValueAsLong (const wxString &name) const
const wxPoint & GetPropertyValueAsPoint (const wxString &name) const
const wxSize & GetPropertyValueAsSize (const wxString &name) const
wxString GetPropertyValueAsString (const wxString &name) const
const wxObject * GetPropertyValueAsWxObjectPtr (const wxString &name) const
wxVariant GetPropertyValues (const wxString &listname=wxEmptyString, wxPGId baseparent=wxPGId(NULL), long flags=0) const
const wxPGValueTypeGetPropertyValueType (const wxString &name)
const wxPGValueTypeGetPropertyValueType (wxPGId id)
size_t GetPVTI (const wxString &name)
size_t GetPVTI (wxPGId id)
wxString GetPVTN (const wxString &name)
wxString GetPVTN (wxPGId id)
wxPGId GetRoot () const
int GetSelectedPage () const
wxPGId GetSelectedProperty () const
int GetSelection () const
wxPropertyGridStateGetState () const
int GetTargetPage () const
wxToolBar * GetToolBar () const
bool HideProperty (const wxString &name)
bool HideProperty (wxPGId id, bool hide=true)
void InitAllTypeHandlers ()
wxPGId Insert (const wxString &name, int index, wxPGProperty *property)
wxPGId Insert (wxPGId id, int index, wxPGProperty *property)
virtual int InsertPage (int index, const wxString &label, const wxBitmap &bmp=wxNullBitmap, wxPropertyGridPage *pageObj=(wxPropertyGridPage *) NULL)
void InsertPropertyChoice (const wxString &name, const wxString &label, int index, int value=INT_MAX)
void InsertPropertyChoice (wxPGId id, const wxString &label, int index, int value=INT_MAX)
bool IsAnyModified () const
bool IsFrozen () const
bool IsModified (const wxString &name)
bool IsModified (wxPGId id) const
bool IsPageModified (size_t index) 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)
void LimitPropertyEditing (const wxString &name, bool limit=true)
void LimitPropertyEditing (wxPGId id, bool limit=true)
virtual void Refresh (bool eraseBackground=true, const wxRect *rect=(const wxRect *) NULL)
virtual bool RemovePage (int page)
wxPGId ReplaceProperty (const wxString &name, wxPGProperty *property)
wxPGId ReplaceProperty (wxPGId id, wxPGProperty *property)
void ResetDefaultPriority ()
void SelectPage (const wxChar *name)
void SelectPage (int index)
bool SelectProperty (const wxString &name, bool focus=false)
bool SelectProperty (wxPGId id, bool focus=false)
void SetCaptionTextColour (const wxString &name, const wxColour &col)
void SetCaptionTextColour (wxPGId id, const wxColour &col)
void SetCurrentCategory (const wxString &name)
void SetCurrentCategory (wxPGId id)
void SetDefaultPriority (int priority)
void SetDescBoxHeight (int ht, bool refresh=true)
void SetDescription (const wxString &label, const wxString &content)
void SetPropertyAttribute (const wxString &name, int attrid, wxVariant value, long argFlags=0)
void SetPropertyAttribute (wxPGId id, int attrid, wxVariant value, long argFlags=0)
void SetPropertyAttributeAll (int attrid, wxVariant value)
void SetPropertyAttributes (const wxString &name, const wxString &attributes) const
void SetPropertyBackgroundColour (const wxString &name, const wxColour &col)
void SetPropertyBackgroundColour (wxPGId id, const wxColour &col)
void SetPropertyChoices (const wxString &name, wxPGChoices &choices)
void SetPropertyChoicesExclusive (const wxString &name)
void SetPropertyChoicesExclusive (wxPGId id)
void SetPropertyClientData (const wxString &name, void *clientData)
void SetPropertyClientData (wxPGId id, void *clientData)
void SetPropertyColour (const wxString &name, const wxColour &col)
void SetPropertyColour (wxPGId id, const wxColour &col)
void SetPropertyColourToDefault (const wxString &name)
void SetPropertyColourToDefault (wxPGId id)
void SetPropertyEditor (const wxString &name, const wxString &editorName)
void SetPropertyEditor (wxPGId id, const wxString &editorName)
void SetPropertyEditor (const wxString &name, const wxPGEditor *editor)
void SetPropertyEditor (wxPGId id, const wxPGEditor *editor)
void SetPropertyHelpString (const wxString &name, const wxString &helpString)
void SetPropertyHelpString (wxPGId id, const wxString &helpString)
void SetPropertyImage (const wxString &name, wxBitmap &bmp)
void SetPropertyImage (wxPGId id, wxBitmap &bmp)
void SetPropertyLabel (const wxString &name, const wxString &newlabel)
void SetPropertyLabel (wxPGId id, const wxString &newlabel)
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 SetPropertyTextColour (const wxString &name, const wxColour &col)
void SetPropertyTextColour (wxPGId id, const wxColour &col)
void SetPropertyUnspecified (const wxString &name)
void SetPropertyUnspecified (wxPGId id)
void SetPropertyValidator (const wxString &name, const wxValidator &validator)
void SetPropertyValidator (wxPGId id, const wxValidator &validator)
void SetPropertyValue (const wxString &name, const wxChar *value)
void SetPropertyValue (wxPGId id, const wxChar *value)
void SetPropertyValue (const wxString &name, wxObject &value)
void SetPropertyValue (wxPGId id, wxObject &value)
void SetPropertyValue (const wxString &name, const wxULongLong &_av1_)
void SetPropertyValue (wxPGId id, const wxULongLong &_av1_)
void SetPropertyValue (const wxString &name, const wxLongLong &_av1_)
void SetPropertyValue (wxPGId id, const wxLongLong &_av1_)
void SetPropertyValue (const wxString &name, const wxSize &_av1_)
void SetPropertyValue (wxPGId id, const wxSize &_av1_)
void SetPropertyValue (const wxString &name, const wxPoint &_av1_)
void SetPropertyValue (wxPGId id, const wxPoint &_av1_)
void SetPropertyValue (const wxString &name, wxDateTime _av1_)
void SetPropertyValue (wxPGId id, wxDateTime _av1_)
void SetPropertyValue (const wxString &name, const wxArrayInt &_av1_)
void SetPropertyValue (wxPGId id, const wxArrayInt &_av1_)
void SetPropertyValue (const wxString &name, const wxArrayString &value)
void SetPropertyValue (const wxString &name, wxVariant &value)
void SetPropertyValue (const wxString &name, void *value)
void SetPropertyValue (const wxString &name, wxObject *value)
void SetPropertyValue (const wxString &name, const wxString &value)
void SetPropertyValue (const wxString &name, bool value)
void SetPropertyValue (const wxString &name, double value)
void SetPropertyValue (const wxString &name, int value)
void SetPropertyValue (const wxString &name, long value)
void SetPropertyValue (wxPGId id, wxVariant &value)
void SetPropertyValue (wxPGId id, void *value)
void SetPropertyValue (wxPGId id, wxObject *value)
void SetPropertyValue (wxPGId id, const wxArrayString &value)
void SetPropertyValue (wxPGId id, const wxString &value)
void SetPropertyValue (wxPGId id, bool value)
void SetPropertyValue (wxPGId id, double value)
void SetPropertyValue (wxPGId id, int value)
void SetPropertyValue (wxPGId id, long value)
void SetPropertyValues (const wxVariant &list, const wxString &defaultCategory=wxEmptyString)
void SetPropertyValues (const wxList &list, const wxString &defaultCategory=wxEmptyString)
void SetPropertyValues (const wxVariant &list, wxPGId defaultCategory)
void SetPropertyValues (const wxList &list, wxPGId defaultCategory)
void SetSplitterLeft (bool subProps=false, bool allPages=true)
void SetSplitterPosition (int newx, bool refresh=true)
void SetStringSelection (const wxChar *name)
void SetTargetPage (const wxChar *name)
void SetTargetPage (int index)
void Sort (const wxString &name)
void Sort (wxPGId id)
void Sort ()
void TogglePropertyPriority (const wxString &name)
void TogglePropertyPriority (wxPGId id)
 wxPropertyGridManager (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=(0), const wxChar *name=wxPropertyGridManagerNameStr)
 wxPropertyGridManager ()
virtual ~wxPropertyGridManager ()

Static Public Member Functions

static wxPGPropertyCreatePropertyByClass (const wxString &classname, const wxString &label, const wxString &name)
static wxPGPropertyCreatePropertyByType (const wxString &valuetype, const wxString &label, const wxString &name)
static wxPGEditorGetEditorByName (const wxString &editorName)
static wxString GetPropertyShortClassName (wxPGId id)
static const wxArrayInt & GetPropertyValueAsArrayInt (wxPGId id)
static const wxArrayString & GetPropertyValueAsArrayString (wxPGId id)
static bool GetPropertyValueAsBool (wxPGId id)
static wxDateTime GetPropertyValueAsDateTime (wxPGId id)
static double GetPropertyValueAsDouble (wxPGId id)
static int GetPropertyValueAsInt (wxPGId id)
static long GetPropertyValueAsLong (wxPGId id)
static const wxLongLong & GetPropertyValueAsLongLong (wxPGId id)
static const wxPoint & GetPropertyValueAsPoint (wxPGId id)
static const wxSize & GetPropertyValueAsSize (wxPGId id)
static wxString GetPropertyValueAsString (wxPGId id)
static const wxULongLong & GetPropertyValueAsULongLong (wxPGId id)
static void * GetPropertyValueAsVoidPtr (wxPGId id)
static const wxObject * GetPropertyValueAsWxObjectPtr (wxPGId id)
static wxPGValueTypeGetValueType (const wxString &type)
static bool IsPropertyExpanded (wxPGId id)
static bool IsPropertyKindOf (wxPGId id, wxPGPropertyClassInfo &info)
static void RegisterAdditionalEditors ()
static void RegisterAdvancedPropertyClasses ()
static bool RegisterPropertyClass (const wxChar *name, wxPGPropertyClassInfo *classinfo)
static void SetBoolChoices (const wxChar *true_choice, const wxChar *false_choice)
static void SetPropertyAttributes (wxPGId id, const wxString &attributes)
static void SetPropertyChoices (wxPGId id, wxPGChoices &choices)

Protected Member Functions

virtual wxPropertyGridCreatePropertyGrid () const
virtual wxPGId DoGetPropertyByName (const wxString &name) const
virtual void RefreshProperty (wxPGProperty *p)=0

Static Protected Member Functions

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

Protected Attributes

wxString m_emptyString
wxPropertyGridStatem_pState

Detailed Description

wxPropertyGridManager is an efficient multi-page version of wxPropertyGrid, which can optionally have toolbar for mode and page selection, help text box, and a compactor button.

Use window flags to select which ones to include.

Derived from

wxPropertyContainerMethods
wxWindow
wxEvtHandler
wxObject

Include files

<wx/propgrid/manager.h>

Window styles

Additional Window Styles

Event handling

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

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

See also:
wxPropertyGridEvent


Constructor & Destructor Documentation

wxPropertyGridManager::wxPropertyGridManager (  ) 

Two step constructor.

Call Create when this constructor is called to build up the wxPropertyGridManager.

wxPropertyGridManager::wxPropertyGridManager ( wxWindow *  parent,
wxWindowID  id = wxID_ANY,
const wxPoint &  pos = wxDefaultPosition,
const wxSize &  size = wxDefaultSize,
long  style = (0),
const wxChar *  name = wxPropertyGridManagerNameStr 
)

The default constructor.

The styles to be used are styles valid for the wxWindow.

See also:
Additional Window Styles

virtual wxPropertyGridManager::~wxPropertyGridManager (  )  [virtual]

Destructor.


Member Function Documentation

int wxPropertyGridManager::AddPage ( const wxString &  label = wxEmptyString,
const wxBitmap &  bmp = wxNullBitmap,
wxPropertyGridPage pageObj = (wxPropertyGridPage*) NULL 
) [inline]

Creates new property page.

Note that the first page is not created automatically.

Parameters:
label A label for the page. This may be shown as a toolbar tooltip etc.
bmp Bitmap image for toolbar. If wxNullBitmap is used, then a built-in default image is used.
pageObj wxPropertyGridPage instance. Manager will take ownership of this object. NULL indicates that a default page instance should be created.
Return values:
Returns index to the page created.
Remarks:
If toolbar is used, it is highly recommended that the pages are added when the toolbar is not turned off using window style flag switching.

void wxPropertyContainerMethods::AddPropertyChoice ( wxPGId  id,
const wxString &  label,
int  value = INT_MAX 
) [inherited]

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

wxPGId wxPropertyGridManager::Append ( wxPGProperty property  )  [inline]

See wxPropertyGrid::Append.

wxPGId wxPropertyGridManager::AppendCategory ( const wxString &  label,
const wxString &  name = (*((wxString*)NULL)) 
) [inline]

See wxPropertyGrid::Append.

wxPGId wxPropertyGridManager::AppendIn ( const wxString &  name,
wxPGProperty property 
) [inline]

See wxPropertyGrid::AppendIn.

wxPGId wxPropertyGridManager::AppendIn ( wxPGId  id,
wxPGProperty property 
) [inline]

See wxPropertyGrid::AppendIn.

void wxPropertyContainerMethods::BeginAddChildren ( wxPGId  id  )  [inherited]

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 wxPropertyGridManager::CanClose (  )  [inline]

Returns true if all property grid data changes have been committed.

Usually only returns false if value in active editor has been invalidated by a wxValidator.

void wxPropertyGridManager::ClearPage ( int  page  ) 

Deletes all properties on given page.

bool wxPropertyGridManager::ClearSelection (  )  [inline]

Deselect current selection, if any (from current page).

Return values:
false if editor could not be closed.

bool wxPropertyGridManager::Collapse ( wxPGId  id  ) 

Collapses given item.

Returns true if it was collapsable and previously expanded.

bool wxPropertyGridManager::CollapseAll (  )  [inline]

Collapses all items that can be collapsed.

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

bool wxPropertyGridManager::Compact ( bool  compact  ) 

Compacts (arg is true) or expands the propertygrid (i.e.

low priority items are already hidden or shown).

bool wxPropertyGridManager::Create ( wxWindow *  parent,
wxWindowID  id = wxID_ANY,
const wxPoint &  pos = wxDefaultPosition,
const wxSize &  size = wxDefaultSize,
long  style = (0),
const wxChar *  name = wxPropertyGridManagerNameStr 
)

Two step creation.

Whenever the control is created without any parameters, use Create to actually create it. Don't access the control's public methods before this is called.

See also:
Additional Window Styles

static wxPGProperty* wxPropertyContainerMethods::CreatePropertyByClass ( const wxString &  classname,
const wxString &  label,
const wxString &  name 
) [static, inherited]

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* wxPropertyContainerMethods::CreatePropertyByType ( const wxString &  valuetype,
const wxString &  label,
const wxString &  name 
) [static, inherited]

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.

virtual wxPropertyGrid* wxPropertyGridManager::CreatePropertyGrid (  )  const [protected, virtual]

Creates property grid for the manager.

Override to use subclassed wxPropertyGrid.

void wxPropertyContainerMethods::Delete ( const wxString &  name  )  [inline, inherited]

Deletes a property by name.

void wxPropertyContainerMethods::Delete ( wxPGId  id  )  [inherited]

Deletes a property by id.

If category is deleted, all children are automatically deleted as well.

void wxPropertyContainerMethods::DeletePropertyChoice ( wxPGId  id,
int  index 
) [inherited]

Deletes choice from a property.

If selected item is deleted, then the value is set to unspecified.

See AddPropertyChoice for more details.

bool wxPropertyGridManager::DisableProperty ( const wxString &  name  )  [inline]

Disables a property.

bool wxPropertyGridManager::DisableProperty ( wxPGId  id  )  [inline]

Disables a property.

bool wxPropertyGridManager::EnableCategories ( bool  enable  )  [inline]

Enables or disables (shows/hides) categories according to parameter enable.

WARNING: Not tested properly, use at your own risk.

bool wxPropertyGridManager::EnableProperty ( wxPGId  id,
bool  enable = true 
)

Enables or disables a property on target page.

void wxPropertyContainerMethods::EndAddChildren ( wxPGId  id  )  [inherited]

Called after population of property with fixed children has finished.

bool wxPropertyGridManager::EnsureVisible ( const wxString &  name  )  [inline]

Selects page, scrolls and/or expands items to ensure that the given item is visible.

Returns true if something was actually done.

bool wxPropertyGridManager::EnsureVisible ( wxPGId  id  ) 

Selects page, scrolls and/or expands items to ensure that the given item is visible.

Returns true if something was actually done.

bool wxPropertyGridManager::Expand ( wxPGId  id  ) 

Expands given item.

Returns true if it was expandable and previously collapsed.

bool wxPropertyGridManager::ExpandAll (  )  [inline]

Expands all parents on target page.

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

size_t wxPropertyGridManager::GetChildrenCount ( const wxString &  name  )  [inline]

Returns number of children for the property.

size_t wxPropertyGridManager::GetChildrenCount ( wxPGId  id  )  const [inline]

Returns number of children for the property.

NB: Cannot be in container methods class due to name hiding.

size_t wxPropertyGridManager::GetChildrenCount ( int  pageIndex  ) 

Returns number of children of the root property of given page.

size_t wxPropertyGridManager::GetChildrenCount (  )  [inline]

Returns number of children of the root property of the selected page.

int wxPropertyGridManager::GetDescBoxHeight (  )  const

Returns height of the description text box.

wxPGId wxPropertyGridManager::GetFirst (  )  const [inline]

Returns id of first item (in target page), whether it is a category or a property.

wxPGId wxPropertyGridManager::GetFirstCategory (  )  const [inline]

Returns id of first category (in target page).

wxPGId wxPropertyContainerMethods::GetFirstChild ( wxPGId  id  )  [inline, inherited]

Returns id of first child of given property.

Remarks:
Does not return sub-properties!

wxPGId wxPropertyGridManager::GetFirstProperty (  )  const [inline]

Returns id of first property that is not a category (from target page).

wxPropertyGrid* wxPropertyGridManager::GetGrid (  )  [inline]

Returns pointer to the contained wxPropertyGrid.

This does not change after wxPropertyGridManager has been created, so you can safely obtain pointer once and use it for the entire lifetime of the instance.

wxPGId wxPropertyGridManager::GetLastChild ( wxPGId  id  )  [inline]

Returns id of last child of given property.

Remarks:
Returns even sub-properties.

wxPGId wxPropertyGridManager::GetNextCategory ( wxPGId  id  )  const [inline]

Returns id of next category after a given property (which does not have to be category).

wxPGId wxPropertyGridManager::GetNextProperty ( wxPGId  id  )  const [inline]

Returns id of next property (from target page).

This does not iterate to sub-properties or categories.

wxPGId wxPropertyContainerMethods::GetNextSibling ( wxPGId  id  )  [inline, inherited]

Returns next item under the same parent.

wxPropertyGridPage* wxPropertyGridManager::GetPage ( unsigned int  ind  )  const [inline]

Returns page object for given page index.

int wxPropertyGridManager::GetPageByName ( const wxChar *  name  )  const

Returns index for a page name.

If no match is found, wxNOT_FOUND is returned.

int wxPropertyGridManager::GetPageByState ( wxPropertyGridState pstate  )  const

Returns index for a relevant propertygrid state.

If no match is found, wxNOT_FOUND is returned.

size_t wxPropertyGridManager::GetPageCount (  )  const

Returns number of managed pages.

const wxString& wxPropertyGridManager::GetPageName ( int  index  )  const

Returns name of given page.

wxPGId wxPropertyGridManager::GetPageRoot ( int  index  )  const

Returns "root property" of the given page.

It does not have name, etc. and it is not visible. It is only useful for accessing its children.

wxPGId wxPropertyGridManager::GetPrevProperty ( wxPGId  id  )  const [inline]

Returns id of previous property (in target page).

wxPGId wxPropertyGridManager::GetPrevSibling ( wxPGId  id  )  [inline]

Returns id of previous item under the same parent.

wxString wxPropertyContainerMethods::GetPropertyAttributes ( wxPGId  id,
unsigned int  flagmask = 0xFFFF 
) const [inline, inherited]

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

Parameters:
flagmask Combination of property flags that should be included (in addition to any other attributes). For example, to avoid adding Modified attribute use ~(wxPG_PROP_MODIFIED).
Remarks:
Atleast in 1.2.x and earlier this does not return complete list of attributes (for example, no floating point precision) and some attributes have generic names (such as "Special1" instead of "UseCheckbox" etc)

wxPGId wxPropertyGridManager::GetPropertyByLabel ( const wxString &  name,
wxPropertyGridState **  ppState = (wxPropertyGridState **) NULL 
) const

Returns id of property with given label (case-sensitive).

If there is no property with such label, returned property id is invalid ( i.e. it will return false with IsOk method). If there are multiple properties with identical name, most recent added is returned.

wxPGId wxPropertyContainerMethods::GetPropertyByName ( const wxString &  name,
const wxString &  subname 
) const [inherited]

Returns id of a sub-property 'subname' of property 'name'.

Same as calling GetPropertyByNameI(wxT("name.subname")), albeit slightly faster.

wxPGId wxPropertyContainerMethods::GetPropertyByName ( const wxString &  name  )  const [inherited]

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

Remarks:
  • Sub-properties (i.e. properties which have parent that is not category or root) can not be accessed globally by their name. Instead, use "<property>.<subproperty>" in place of "<subproperty>".

wxPGId wxPropertyGridManager::GetPropertyCategory ( wxPGId  id  )  const [inline]

Returns id of property's nearest parent category.

If no category found, returns invalid wxPGId.

wxPGChoices& wxPropertyContainerMethods::GetPropertyChoices ( wxPGId  id  )  [inherited]

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* wxPropertyContainerMethods::GetPropertyClassName ( const wxString &  name  )  const [inline, inherited]

Gets name of property's constructor function.

const wxChar* wxPropertyContainerMethods::GetPropertyClassName ( wxPGId  id  )  const [inline, inherited]

Gets name of property's constructor function.

void* wxPropertyContainerMethods::GetPropertyClientData ( const wxString &  name  )  const [inline, inherited]

Returns client data (void*) of a property.

void* wxPropertyContainerMethods::GetPropertyClientData ( wxPGId  id  )  const [inline, inherited]

Returns client data (void*) of a property.

wxColour wxPropertyGridManager::GetPropertyColour ( wxPGId  id  )  const [inline]

Returns cell background colour of a property.

const wxPGEditor* wxPropertyContainerMethods::GetPropertyEditor ( wxPGId  id  )  const [inline, inherited]

Returns property's editor.

wxString wxPropertyContainerMethods::GetPropertyHelpString ( const wxString &  name  )  const [inline, inherited]

Returns help string associated with a property.

wxString wxPropertyContainerMethods::GetPropertyHelpString ( wxPGId  id  )  const [inline, inherited]

Returns help string associated with a property.

wxBitmap* wxPropertyContainerMethods::GetPropertyImage ( wxPGId  id  )  const [inline, inherited]

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

unsigned int wxPropertyContainerMethods::GetPropertyIndex ( const wxString &  name  )  [inline, inherited]

Returns property's position under its parent.

unsigned int wxPropertyContainerMethods::GetPropertyIndex ( wxPGId  id  )  [inline, inherited]

Returns property's position under its parent.

const wxString& wxPropertyContainerMethods::GetPropertyLabel ( wxPGId  id  )  [inline, inherited]

Returns label of a property.

const wxString& wxPropertyContainerMethods::GetPropertyName ( wxPGId  id  )  [inline, inherited]

Returns name of a property.

Note that obviously there is no name-version of this member function.

wxPGId wxPropertyContainerMethods::GetPropertyParent ( const wxString &  name  )  [inline, inherited]

Returns parent item of a property.

wxPGId wxPropertyContainerMethods::GetPropertyParent ( wxPGId  id  )  [inline, inherited]

Returns parent item of a property.

int wxPropertyContainerMethods::GetPropertyPriority ( const wxString &  name  )  [inline, inherited]

Returns priority of a property (wxPG_HIGH or wxPG_LOW).

int wxPropertyContainerMethods::GetPropertyPriority ( wxPGId  id  )  [inline, inherited]

Returns priority of a property (wxPG_HIGH or wxPG_LOW).

wxPGProperty* wxPropertyContainerMethods::GetPropertyPtr ( const wxString &  name  )  const [inline, inherited]

Returns pointer to a property.

wxPGProperty* wxPropertyContainerMethods::GetPropertyPtr ( wxPGId  id  )  const [inline, inherited]

Returns pointer to a property.

static wxString wxPropertyContainerMethods::GetPropertyShortClassName ( wxPGId  id  )  [static, inherited]

Returns short name for property's class.

For example, "wxPropertyCategory" translates to "Category" and "wxIntProperty" to "Int".

wxColour wxPropertyGridManager::GetPropertyTextColour ( wxPGId  id  )  const [inline]

Returns cell text colour of a property.

wxValidator* wxPropertyContainerMethods::GetPropertyValidator ( wxPGId  id  )  [inline, inherited]

Returns validator of a property as a reference, which you can pass to any number of SetPropertyValidator.

wxVariant wxPropertyContainerMethods::GetPropertyValue ( const wxString &  name  )  [inline, inherited]

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 wxPropertyContainerMethods::GetPropertyValue ( wxPGId  id  )  [inline, inherited]

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 wxPropertyGridManager::GetPropertyValues ( const wxString &  listname = wxEmptyString,
wxPGId  baseparent = wxPGId(NULL),
long  flags = 0 
) const [inline]

Returns a wxVariant list containing wxVariant versions of all property values.

Order is not guaranteed, but generally it should match the visible order in the grid.

Parameters:
flags Use wxKEEP_STRUCTURE to retain category structure; each sub category will be its own wxList of wxVariant.
Remarks:
This works on the target page (*not* the selected page).

const wxPGValueType* wxPropertyContainerMethods::GetPropertyValueType ( wxPGId  id  )  [inline, inherited]

Returns a wxPGValueType class instance that describes the property's data type.

size_t wxPropertyContainerMethods::GetPVTI ( wxPGId  id  )  [inline, inherited]

Returns property value type identifier.

wxString wxPropertyContainerMethods::GetPVTN ( wxPGId  id  )  [inline, inherited]

Returns property value type name.

wxPGId wxPropertyGridManager::GetRoot (  )  const [inline]

Returns "root property" of the target page.

It does not have name, etc. and it is not visible. It is only useful for accessing its children.

int wxPropertyGridManager::GetSelectedPage (  )  const [inline]

Returns index to currently selected page.

wxPGId wxPropertyGridManager::GetSelectedProperty (  )  const [inline]

Shortcut for GetGrid()->GetSelection().

int wxPropertyGridManager::GetSelection (  )  const [inline]

Synonyme for GetSelectedPage.

int wxPropertyGridManager::GetTargetPage (  )  const [inline]

Returns index of page that is target for insert operations etc.

wxToolBar* wxPropertyGridManager::GetToolBar (  )  const [inline]

Returns a pointer to the toolbar currently associated with the wxPropertyGridManager (if any).

static wxPGValueType* wxPropertyContainerMethods::GetValueType ( const wxString &  type  )  [static, inherited]

Returns value type class instance for given type name.

bool wxPropertyContainerMethods::HideProperty ( wxPGId  id,
bool  hide = true 
) [inherited]

Hides or reveals a property.

Parameters:
hide If true, hides property, otherwise reveals it.
Remarks:
Hiding properties is not compatible with priority system. Using both at the same time will yield unpredictable results.

void wxPropertyGridManager::InitAllTypeHandlers (  )  [inline]

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 from wxPropertyContainerMethods.

wxPGId wxPropertyGridManager::Insert ( const wxString &  name,
int  index,
wxPGProperty property 
) [inline]

See wxPropertyGrid::Insert.

wxPGId wxPropertyGridManager::Insert ( wxPGId  id,
int  index,
wxPGProperty property 
) [inline]

See wxPropertyGrid::Insert.

virtual int wxPropertyGridManager::InsertPage ( int  index,
const wxString &  label,
const wxBitmap &  bmp = wxNullBitmap,
wxPropertyGridPage pageObj = (wxPropertyGridPage *) NULL 
) [virtual]

Creates new property page.

Note that the first page is not created automatically.

Parameters:
index Add to this position. -1 will add as the last item.
label A label for the page. This may be shown as a toolbar tooltip etc.
bmp Bitmap image for toolbar. If wxNullBitmap is used, then a built-in default image is used.
pageObj wxPropertyGridPage instance. Manager will take ownership of this object. If NULL, default page object is constructed.
Return values:
Returns index to the page created.

void wxPropertyContainerMethods::InsertPropertyChoice ( wxPGId  id,
const wxString &  label,
int  index,
int  value = INT_MAX 
) [inherited]

Inserts choice to a property that can accept one.

See AddPropertyChoice for more details.

bool wxPropertyGridManager::IsAnyModified (  )  const

Returns true if any property on any page has been modified by the user.

bool wxPropertyGridManager::IsFrozen (  )  const [inline]

Returns true if updating is frozen (ie.

Freeze() called but not yet Thaw() ).

bool wxPropertyContainerMethods::IsModified ( wxPGId  id  )  const [inline, inherited]

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

NOTE: Try to use IsPropertyModified instead.

bool wxPropertyGridManager::IsPageModified ( size_t  index  )  const

Returns true if any property on given page has been modified by the user.

bool wxPropertyContainerMethods::IsPropertyCategory ( wxPGId  id  )  const [inline, inherited]

Returns true if property is a category.

bool wxPropertyContainerMethods::IsPropertyEnabled ( const wxString &  name  )  [inline, inherited]

Returns true if property is enabled.

bool wxPropertyContainerMethods::IsPropertyEnabled ( wxPGId  id  )  const [inline, inherited]

Returns true if property is enabled.

static bool wxPropertyContainerMethods::IsPropertyExpanded ( wxPGId  id  )  [static, inherited]

Returns true if given property is expanded.

Naturally, always returns false for properties that cannot be expanded.

static bool wxPropertyContainerMethods::IsPropertyKindOf ( wxPGId  id,
wxPGPropertyClassInfo info 
) [inline, static, inherited]

Returns true if property is of certain type.

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

bool wxPropertyContainerMethods::IsPropertyModified ( wxPGId  id  )  const [inline, inherited]

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

bool wxPropertyContainerMethods::IsPropertyShown ( const wxString &  name  )  [inline, inherited]

Returns true if property is shown (ie.

hideproperty with true not called for it).

bool wxPropertyContainerMethods::IsPropertyShown ( wxPGId  id  )  const [inline, inherited]

Returns true if property is shown (ie.

hideproperty with true not called for it).

bool wxPropertyContainerMethods::IsPropertyUnspecified ( wxPGId  id  )  const [inline, inherited]

Returns true if property value is set to unspecified.

bool wxPropertyContainerMethods::IsPropertyValueType ( const wxString &  name,
const wxClassInfo *  classinfo 
) [inline, inherited]

Returns true if property's value type has same name as a class.

bool wxPropertyContainerMethods::IsPropertyValueType ( const wxString &  name,
const wxPGValueType valuetype 
) [inline, inherited]

Returns true if property's value type is valuetype.

bool wxPropertyContainerMethods::IsPropertyValueType ( const wxString &  name,
const wxChar *  typestr 
) [inline, inherited]

Returns true if property's value type has name typestr.

bool wxPropertyContainerMethods::IsPropertyValueType ( wxPGId  id,
const wxClassInfo *  classinfo 
) [inline, inherited]

Returns true if property's value type has same name as a class.

bool wxPropertyContainerMethods::IsPropertyValueType ( wxPGId  id,
const wxPGValueType valuetype 
) [inline, inherited]

Returns true if property's value type is valuetype.

bool wxPropertyContainerMethods::IsPropertyValueType ( wxPGId  id,
const wxChar *  typestr 
) [inline, inherited]

Returns true if property's value type has name typestr.

void wxPropertyGridManager::LimitPropertyEditing ( wxPGId  id,
bool  limit = true 
)

Disables item's textctrl if other way of editing is available.

static void wxPropertyContainerMethods::RegisterAdditionalEditors (  )  [static, inherited]

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.

static void wxPropertyContainerMethods::RegisterAdvancedPropertyClasses (  )  [static, inherited]

Basic property classes are registered by the default, but this registers advanced ones as well.

static bool wxPropertyContainerMethods::RegisterPropertyClass ( const wxChar *  name,
wxPGPropertyClassInfo classinfo 
) [static, inherited]

Registers property class info with specific name.

Preferably use wxPGRegisterPropertyClass(PROPERTYNAME) macro.

virtual bool wxPropertyGridManager::RemovePage ( int  page  )  [virtual]

Removes a page.

Return values:
Returns false if it was not possible to remove page in question.

wxPGId wxPropertyContainerMethods::ReplaceProperty ( wxPGId  id,
wxPGProperty property 
) [inherited]

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.

void wxPropertyGridManager::ResetDefaultPriority (  )  [inline]

Same as SetDefaultPriority(wxPG_HIGH).

void wxPropertyGridManager::SelectPage ( const wxChar *  name  )  [inline]

Select and displays a given page.

void wxPropertyGridManager::SelectPage ( int  index  ) 

Select and displays a given page.

Also makes it target page for insert operations etc.

Parameters:
index Index of page being seleced. Can be -1 to select nothing.

bool wxPropertyGridManager::SelectProperty ( wxPGId  id,
bool  focus = false 
) [inline]

Select a property.

static void wxPropertyContainerMethods::SetBoolChoices ( const wxChar *  true_choice,
const wxChar *  false_choice 
) [static, inherited]

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.

void wxPropertyGridManager::SetCaptionTextColour ( wxPGId  id,
const wxColour &  col 
) [inline]

Sets text colour of a category caption (but not it's children).

void wxPropertyGridManager::SetCurrentCategory ( const wxString &  name  )  [inline]

Sets the current category - Append will add non-categories under this one.

void wxPropertyGridManager::SetCurrentCategory ( wxPGId  id  )  [inline]

Sets the current category - Append will add non-categories under this one.

void wxPropertyGridManager::SetDefaultPriority ( int  priority  )  [inline]

All properties added/inserted will have given priority by default.

Parameters:
priority can be wxPG_HIGH (default) or wxPG_LOW.

void wxPropertyGridManager::SetDescBoxHeight ( int  ht,
bool  refresh = true 
)

Sets y coordinate of the description box splitter.

void wxPropertyGridManager::SetDescription ( const wxString &  label,
const wxString &  content 
)

Sets label and text in description box.

void wxPropertyContainerMethods::SetPropertyAttribute ( wxPGId  id,
int  attrid,
wxVariant  value,
long  argFlags = 0 
) [inline, inherited]

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

void wxPropertyGridManager::SetPropertyAttributeAll ( int  attrid,
wxVariant  value 
)

Sets property attribute for all applicapple properties.

Be sure to use this method after all properties have been added to the grid.

static void wxPropertyContainerMethods::SetPropertyAttributes ( wxPGId  id,
const wxString &  attributes 
) [inline, static, inherited]

Sets attributes from a string generated by GetPropertyAttributes.

Remarks:
Performance may not be top-notch.

void wxPropertyGridManager::SetPropertyBackgroundColour ( wxPGId  id,
const wxColour &  col 
) [inline]

Sets background colour of property and all its children.

Colours of captions are not affected. Background brush cache is optimized for often set colours to be set last.

void wxPropertyContainerMethods::SetPropertyChoices ( const wxString &  name,
wxPGChoices choices 
) [inline, inherited]

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

static void wxPropertyContainerMethods::SetPropertyChoices ( wxPGId  id,
wxPGChoices choices 
) [inline, static, inherited]

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

void wxPropertyContainerMethods::SetPropertyChoicesExclusive ( wxPGId  id  )  [inline, inherited]

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

void wxPropertyContainerMethods::SetPropertyClientData ( const wxString &  name,
void *  clientData 
) [inline, inherited]

Sets client data (void*) of a property.

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

void wxPropertyContainerMethods::SetPropertyClientData ( wxPGId  id,
void *  clientData 
) [inline, inherited]

Sets client data (void*) of a property.

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

void wxPropertyGridManager::SetPropertyColour ( wxPGId  id,
const wxColour &  col 
) [inline]

Sets background colour of property and all its children.

Colours of captions are not affected. Background brush cache is optimized for often set colours to be set last.

NOTE: This function is deprecated. Use SetPropertyBackgroundColour.

void wxPropertyGridManager::SetPropertyColourToDefault ( wxPGId  id  )  [inline]

Sets background and text colour of property and all its children to the default.

void wxPropertyContainerMethods::SetPropertyEditor ( wxPGId  id,
const wxString &  editorName 
) [inline, inherited]

Sets editor control of a property.

As editor argument, use editor name string, such as wxT("TextCtrl") or wxT("Choice").

void wxPropertyContainerMethods::SetPropertyEditor ( wxPGId  id,
const wxPGEditor editor 
) [inline, inherited]

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 wxPropertyContainerMethods::SetPropertyHelpString ( wxPGId  id,
const wxString &  helpString 
) [inline, inherited]

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.

void wxPropertyContainerMethods::SetPropertyImage ( wxPGId  id,
wxBitmap &  bmp 
) [inline, inherited]

Set wxBitmap in front of the value.

Remarks:

void wxPropertyGridManager::SetPropertyLabel ( wxPGId  id,
const wxString &  newlabel 
)

Sets label of a property.

bool wxPropertyContainerMethods::SetPropertyMaxLength ( const wxString &  name,
int  maxLen 
) [inline, inherited]

Sets max length of property's text.

bool wxPropertyContainerMethods::SetPropertyMaxLength ( wxPGId  id,
int  maxLen 
) [inherited]

Sets max length of property's text.

bool wxPropertyContainerMethods::SetPropertyPriority ( const wxString &  name,
int  priority 
) [inline, inherited]

Property is to be hidden/shown when hider button is toggled or when wxPropertyGrid::Compact is called.

bool wxPropertyContainerMethods::SetPropertyPriority ( wxPGId  id,
int  priority 
) [inherited]

Property is to be hidden/shown when hider button is toggled or when wxPropertyGrid::Compact is called.

void wxPropertyGridManager::SetPropertyTextColour ( wxPGId  id,
const wxColour &  col 
) [inline]

Sets text colour of property and all its children.

void wxPropertyGridManager::SetPropertyUnspecified ( wxPGId  id  ) 

Sets property's value to unspecified.

If it has children (it may be category), then the same thing is done to them.

void wxPropertyContainerMethods::SetPropertyValidator ( wxPGId  id,
const wxValidator &  validator 
) [inline, inherited]

Sets validator of a property.

For example

          // Allow property's value range from -100 to 100
          wxIntPropertyValidator validator(-100,100);
          wxPGId id = pg->Append( wxIntProperty(wxT("Value 1",wxPG_LABEL,0)) );
          pg->SetPropertyValidator( id, validator );

void wxPropertyGridManager::SetPropertyValue ( wxPGId  id,
long  value 
)

Sets property value.

Remarks:
Actual name of this method is SetPropertyValue. It may be shown incorrectly due to limitations in Doxygen C preprocessor.

void wxPropertyGridManager::SetPropertyValues ( const wxList &  list,
wxPGId  defaultCategory 
) [inline]

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). Works on target page.

void wxPropertyGridManager::SetSplitterLeft ( bool  subProps = false,
bool  allPages = true 
)

Moves splitter as left as possible, while still allowing all labels to be shown in full.

Parameters:
subProps If false, will still allow sub-properties (ie. properties which parent is not root or category) to be cropped.
allPages If true, takes labels on all pages into account.

void wxPropertyGridManager::SetStringSelection ( const wxChar *  name  )  [inline]

Synonyme for SelectPage(name).

void wxPropertyGridManager::SetTargetPage ( const wxChar *  name  )  [inline]

Sets page to which append, insert, etc.

will add items. Every time a page is changed, target page is automatically switched to that.

void wxPropertyGridManager::SetTargetPage ( int  index  ) 

Sets page to which append, insert, etc.

will add items. Every time a page is changed, target page is automatically switched to that.

void wxPropertyGridManager::Sort ( const wxString &  name  )  [inline]

Sorts children of a category.

void wxPropertyGridManager::Sort ( wxPGId  id  )  [inline]

Sorts children of a category.

void wxPropertyGridManager::Sort (  )  [inline]

Sorts all items at all levels of the target page (except sub-properties).

void wxPropertyContainerMethods::TogglePropertyPriority ( const wxString &  name  )  [inline, inherited]

Toggles priority of a property between wxPG_HIGH and wxPG_LOW.

void wxPropertyContainerMethods::TogglePropertyPriority ( wxPGId  id  )  [inline, inherited]

Toggles priority of a property between wxPG_HIGH and wxPG_LOW.


The documentation for this class was generated from the following file:
Generated on Sun Mar 11 11:38:14 2007 for wxPropertyGrid by  doxygen 1.5.1-p1