wxPropertyGrid
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
wxPropertyGridPage Class Reference

Holder of property grid page information. More...

#include <manager.h>

Inheritance diagram for wxPropertyGridPage:
wxPropertyGridInterface wxPropertyGridState

Public Member Functions

virtual void Clear ()
 Deletes all properties on page.
 
wxSize FitColumns ()
 Reduces column sizes to minimum possible that contents are still visibly (naturally some margin space will be applied as well). More...
 
int GetIndex () const
 Returns page index in manager;.
 
wxPGPropertyGetRoot () const
 Returns "root property". More...
 
int GetSplitterPosition (int col=0) const
 Returns x-coordinate position of splitter on a page.
 
wxPropertyGridStateGetStatePtr ()
 Return pointer to contained property grid state.
 
const wxPropertyGridStateGetStatePtr () const
 Return pointer to contained property grid state.
 
int GetToolId () const
 Returns id of the tool bar item that represents this page on wxPropertyGridManager's wxToolBar.
 
virtual void Init ()
 Do any member initialization in this method. More...
 
virtual bool IsHandlingAllEvents () const
 Return false here to indicate unhandled events should be propagated to manager's parent, as normal.
 
virtual void OnShow ()
 Called every time page is about to be shown. More...
 
virtual void RefreshProperty (wxPGProperty *p)
 
void SetSplitterPosition (int splitterPos, int col=0)
 Sets splitter position on page. More...
 
- Public Member Functions inherited from wxPropertyGridInterface
void AddPropertyChoice (wxPGPropArg id, const wxString &label, int value=INT_MAX)
 Adds choice to a property that can accept one. More...
 
wxPGPropertyAppend (wxPGProperty *property)
 Appends property to the list. More...
 
wxPGPropertyAppendCategory (const wxString &label, const wxString &name=(*((wxString *) NULL)))
 
wxPGPropertyAppendIn (wxPGPropArg id, wxPGProperty *newproperty)
 
void BeginAddChildren (wxPGPropArg id)
 Inorder to add new items into a property with fixed children (for instance, wxFlagsProperty), you need to call this method. More...
 
bool ChangePropertyValue (wxPGPropArg id, wxVariant newValue)
 Changes value of a property, as if from an editor. More...
 
bool ClearPropertyValue (wxPGPropArg id)
 Resets value of a property to its default. More...
 
bool ClearSelection (bool validation=true)
 Clears current selection, if any. More...
 
bool Collapse (wxPGPropArg id)
 Collapses given category or property with children. More...
 
bool CollapseAll ()
 Collapses all items that can be collapsed. More...
 
void Delete (wxPGPropArg id)
 Deletes a property by id. More...
 
void DeleteProperty (wxPGPropArg id)
 Removes and deletes a property. More...
 
void DeletePropertyChoice (wxPGPropArg id, int index)
 Deletes choice from a property. More...
 
bool Disable (wxPGPropArg id)
 Disables property. More...
 
bool DisableProperty (wxPGPropArg id)
 Disables property. More...
 
bool EnableProperty (wxPGPropArg id, bool enable=true)
 Enables or disables property, depending on whether enable is true or false. More...
 
void EndAddChildren (wxPGPropArg id)
 Called after population of property with fixed children has finished.
 
bool Expand (wxPGPropArg id)
 Expands given category or property with children. More...
 
bool ExpandAll (bool expand=true)
 Expands all items that can be expanded.
 
int GetColumnProportion (unsigned int column) const
 Returns auto-resize proportion of the given column. More...
 
wxArrayPGProperty GetExpandedProperties () const
 Returns list of expanded properties. More...
 
wxPGPropertyGetFirst (int flags=wxPG_ITERATE_ALL)
 Returns id of first item, whether it is a category or property. More...
 
const wxPGPropertyGetFirst (int flags=wxPG_ITERATE_ALL) const
 
wxPGPropertyGetFirstChild (wxPGPropArg id)
 Returns id of first child of given property. More...
 
wxPropertyGridIterator GetIterator (int flags=wxPG_ITERATE_DEFAULT, wxPGProperty *firstProp=NULL)
 Returns iterator class instance. More...
 
wxPropertyGridConstIterator GetIterator (int flags=wxPG_ITERATE_DEFAULT, wxPGProperty *firstProp=NULL) const
 
wxPropertyGridIterator GetIterator (int flags, int startPos)
 Returns iterator class instance. More...
 
wxPropertyGridConstIterator GetIterator (int flags, int startPos) const
 
wxPGPropertyGetNextSiblingProperty (wxPGPropArg id)
 Returns next item under the same parent. More...
 
void 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. More...
 
wxPGPropertyGetProperty (const wxString &name) const
 Returns pointer to the property with given name (case-sensitive). More...
 
wxVariant GetPropertyAttribute (wxPGPropArg id, const wxString &attrName) const
 Returns value of given attribute. More...
 
const wxPGAttributeStorageGetPropertyAttributes (wxPGPropArg id) const
 Returns map-like storage of property's attributes. More...
 
wxPGPropertyGetPropertyByName (const wxString &name) const
 Returns pointer to the property with given name (case-sensitive). More...
 
wxPGPropertyGetPropertyByName (const wxString &name, const wxString &subname) const
 Returns id of a sub-property 'subname' of property 'name'. More...
 
wxPGPropertyGetPropertyByNameA (const wxString &name) const
 
wxPropertyCategoryGetPropertyCategory (wxPGPropArg id) const
 Returns pointer of property's nearest parent category. More...
 
wxPGChoicesGetPropertyChoices (wxPGPropArg id)
 Returns writable reference to property's list of choices (and relevant values). More...
 
const wxChar * GetPropertyClassName (wxPGPropArg id) const
 Gets name of property's constructor function. More...
 
wxPGProperty::ClientDataType GetPropertyClientData (wxPGPropArg id) const
 Returns client data (void*) of a property. More...
 
const wxPGEditorGetPropertyEditor (wxPGPropArg id) const
 Returns property's editor. More...
 
wxString GetPropertyHelpString (wxPGPropArg id) const
 Returns help string associated with a property. More...
 
wxBitmap * GetPropertyImage (wxPGPropArg id) const
 Returns property's custom value image (NULL of none). More...
 
unsigned int GetPropertyIndex (wxPGPropArg id)
 Returns property's position under its parent. More...
 
const wxString & GetPropertyLabel (wxPGPropArg id)
 Returns label of a property. More...
 
wxString GetPropertyName (wxPGPropArg id)
 Returns name of a property, by which it is globally accessible. More...
 
wxPGPropertyGetPropertyParent (wxPGPropArg id)
 Returns parent item of a property. More...
 
wxPGPropertyGetPropertyPtr (wxPGPropArg id) const
 Returns pointer to a property.
 
wxString GetPropertyShortClassName (wxPGPropArg id)
 Returns short name for property's class. More...
 
wxValidator * GetPropertyValidator (wxPGPropArg id)
 Returns validator of a property as a reference, which you can pass to any number of SetPropertyValidator.
 
wxVariant GetPropertyValue (wxPGPropArg id)
 Returns value as wxVariant. More...
 
wxArrayInt GetPropertyValueAsArrayInt (wxPGPropArg id) const
 
wxArrayString GetPropertyValueAsArrayString (wxPGPropArg id) const
 
bool GetPropertyValueAsBool (wxPGPropArg id) const
 
wxDateTime GetPropertyValueAsDateTime (wxPGPropArg id) const
 
double GetPropertyValueAsDouble (wxPGPropArg id) const
 
int GetPropertyValueAsInt (wxPGPropArg id) const
 
long GetPropertyValueAsLong (wxPGPropArg id) const
 
wxLongLong_t GetPropertyValueAsLongLong (wxPGPropArg id) const
 
wxPoint GetPropertyValueAsPoint (wxPGPropArg id) const
 
wxSize GetPropertyValueAsSize (wxPGPropArg id) const
 
wxString GetPropertyValueAsString (wxPGPropArg id) const
 
unsigned long GetPropertyValueAsULong (wxPGPropArg id) const
 
wxULongLong_t GetPropertyValueAsULongLong (wxPGPropArg id) const
 
void * GetPropertyValueAsVoidPtr (wxPGPropArg id) const
 
wxObject * GetPropertyValueAsWxObjectPtr (wxPGPropArg id) const
 
wxVariant GetPropertyValues (const wxString &listname=wxEmptyString, wxPGProperty *baseparent=NULL, long flags=0) const
 Returns a wxVariant list containing wxVariant versions of all property values. More...
 
wxString GetPropertyValueType (wxPGPropArg id)
 
const wxArrayPGProperty & GetSelectedProperties () const
 Returns list of currently selected properties. More...
 
wxPGPropertyGetSelection () const
 Returns currently selected property. More...
 
wxPropertyGridStateGetState () const
 
virtual wxPGVIterator GetVIterator (int flags) const
 Similar to GetIterator, but instead returns wxPGVIterator instance, which can be useful for forward-iterating through arbitrary property containers.
 
bool HideProperty (wxPGPropArg id, bool hide=true, int flags=wxPG_RECURSE)
 Hides or reveals a property. More...
 
wxPGPropertyInsert (wxPGPropArg priorThis, wxPGProperty *newproperty)
 Inserts property to the property container. More...
 
wxPGPropertyInsert (wxPGPropArg parent, int index, wxPGProperty *newproperty)
 Also see documentation for Insert . More...
 
wxPGPropertyInsertCategory (wxPGPropArg id, int index, const wxString &label, const wxString &name=(*((wxString *) NULL)))
 
void InsertPropertyChoice (wxPGPropArg id, const wxString &label, int index, int value=INT_MAX)
 Inserts choice to a property that can accept one. More...
 
bool IsModified (wxPGPropArg id) const
 Returns true if property has been modified after value set or modify flag clear by software. More...
 
bool IsPropertyCategory (wxPGPropArg id) const
 Returns true if property is a category. More...
 
bool IsPropertyEnabled (wxPGPropArg id) const
 Returns true if property is enabled. More...
 
bool IsPropertyExpanded (wxPGPropArg id) const
 Returns true if given property is expanded. More...
 
bool IsPropertyKindOf (wxPGPropArg id, wxClassInfo *info) const
 Returns true if property is of certain type. More...
 
bool IsPropertyModified (wxPGPropArg id) const
 Returns true if property has been modified after value set or modify flag clear by software.
 
virtual bool IsPropertySelected (wxPGPropArg id) const
 Returns true if property is selected.
 
bool IsPropertyShown (wxPGPropArg id) const
 Returns true if property is shown (ie. More...
 
bool IsPropertyUnspecified (wxPGPropArg id) const
 Returns true if property value is set to unspecified.
 
bool IsPropertyValueType (wxPGPropArg id, const wxChar *typestr) const
 Returns true if property's value type has name typestr. More...
 
void 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 NamesToProperties (wxArrayPGProperty *properties, const wxArrayString &names) const
 Converts array of names to array of property pointers. More...
 
void PropertiesToNames (wxArrayString *names, const wxArrayPGProperty &properties) const
 Converts array of properties to array of names. More...
 
virtual void RefreshGrid (wxPropertyGridState *state=NULL)
 If state is shown in it's grid, refresh it now.
 
wxPGPropertyRemoveProperty (wxPGPropArg id)
 Removes a property. More...
 
wxPGPropertyReplaceProperty (wxPGPropArg id, wxPGProperty *property)
 Replaces property with id with newly created property. More...
 
bool RestoreEditableState (const wxString &src, int restoreStates=AllStates)
 Restores user-editable state. More...
 
wxString SaveEditableState (int includedStates=AllStates) const
 Used to acquire user-editable state (selected property, expanded properties, scrolled position, splitter positions). More...
 
bool SetColumnProportion (unsigned int column, int proportion)
 Set proportion of a auto-stretchable column. More...
 
void SetExpandedProperties (const wxArrayPGProperty &array, bool expand=true)
 Sets all properties in given array as expanded. More...
 
void SetPropertiesFlag (const wxArrayPGProperty &srcArr, wxPGProperty::FlagType flags, bool inverse=false)
 Sets or clears flag(s) of all properties in given array. More...
 
void SetPropertyAttribute (wxPGPropArg id, const wxString &attrName, wxVariant value, long argFlags=0)
 Sets an attribute of a property. More...
 
void SetPropertyAttributes (wxPGPropArg id, const wxPGAttributeStorage &attributes)
 Sets attributes from a wxPGAttributeStorage.
 
void SetPropertyCell (wxPGPropArg id, int column, const wxString &text=wxEmptyString, const wxBitmap &bitmap=wxNullBitmap, const wxColour &fgCol=wxNullColour, const wxColour &bgCol=wxNullColour)
 Sets text, bitmap, and colours for given column's cell. More...
 
void SetPropertyChoices (wxPGPropArg id, wxPGChoices &choices)
 Set choices of a property to specified set of labels and values. More...
 
void SetPropertyChoicesExclusive (wxPGPropArg id)
 If property's set of choices is shared, then calling this method converts it to private.
 
void SetPropertyClientData (wxPGPropArg id, wxPGProperty::ClientDataType clientData)
 Sets client data (void*) of a property. More...
 
void SetPropertyEditor (wxPGPropArg id, const wxPGEditor *editor)
 Sets editor control of a property. More...
 
void SetPropertyEditor (wxPGPropArg id, const wxString &editorName)
 Sets editor control of a property. More...
 
void SetPropertyHelpString (wxPGPropArg id, const wxString &helpString)
 Associates the help string with property. More...
 
void SetPropertyImage (wxPGPropArg id, wxBitmap &bmp)
 Set wxBitmap in front of the value. More...
 
void SetPropertyLabel (wxPGPropArg id, const wxString &newproplabel)
 Sets label of a property. More...
 
bool SetPropertyMaxLength (wxPGPropArg id, int maxLen)
 Sets max length of property's text.
 
void SetPropertyReadOnly (wxPGPropArg id, bool set=true, int flags=wxPG_RECURSE)
 Sets property (and, recursively, its children) to have read-only value. More...
 
void SetPropertyValidator (wxPGPropArg id, const wxValidator &validator)
 Sets validator of a property.
 
void SetPropertyValue (wxPGPropArg id, long value)
 Sets value (long integer) of a property.
 
void SetPropertyValue (wxPGPropArg id, int value)
 Sets value (integer) of a property.
 
void SetPropertyValue (wxPGPropArg id, double value)
 Sets value (floating point) of a property.
 
void SetPropertyValue (wxPGPropArg id, bool value)
 Sets value (bool) of a property.
 
void SetPropertyValue (wxPGPropArg id, const wxChar *value)
 
void SetPropertyValue (wxPGPropArg id, const wxArrayString &value)
 Sets value (wxArrayString) of a property.
 
void SetPropertyValue (wxPGPropArg id, const wxDateTime &value)
 
void SetPropertyValue (wxPGPropArg id, const wxString &value)
 Sets value (wxString) of a property. More...
 
void SetPropertyValue (wxPGPropArg id, wxObject *value)
 Sets value (wxObject*) of a property.
 
void SetPropertyValue (wxPGPropArg id, void *value)
 Sets value (void*) of a property. More...
 
void SetPropertyValue (wxPGPropArg id, wxObject &value)
 
void SetPropertyValue (wxPGPropArg id, wxVariant value)
 Sets value (wxVariant&) of a property. More...
 
void SetPropertyValue (wxPGPropArg id, const wxPoint &value)
 Sets value (wxPoint&) of a property.
 
void SetPropertyValue (wxPGPropArg id, const wxSize &value)
 Sets value (wxSize&) of a property.
 
void SetPropertyValue (wxPGPropArg id, wxLongLong_t value)
 Sets value (wxLongLong&) of a property.
 
void SetPropertyValue (wxPGPropArg id, wxULongLong_t value)
 Sets value (wxULongLong&) of a property.
 
void SetPropertyValue (wxPGPropArg id, const wxArrayInt &value)
 Sets value (wxArrayInt&) of a property.
 
void SetPropertyValues (const wxVariantList &list, wxPGPropArg defaultCategory=((wxPGProperty *) NULL))
 Sets property values from a list of wxVariants.
 
void SetPropertyValues (const wxVariant &list, wxPGPropArg defaultCategory=((wxPGProperty *) NULL))
 Sets property values from a list of wxVariants.
 
void SetPropertyValueUnspecified (wxPGPropArg id)
 Sets property's value to unspecified. More...
 
void SetPropVal (wxPGPropArg id, wxVariant &value)
 Sets value (wxDateTime&) of a property. More...
 
void SetValidationFailureBehavior (int vfbFlags)
 Adjusts how wxPropertyGrid behaves when invalid value is entered in a property. More...
 
virtual ~wxPropertyGridInterface ()
 Destructor.
 
- Public Member Functions inherited from wxPropertyGridState
wxPGPropertyBaseGetPropertyByName (const wxString &name) const
 Returns property by its name. More...
 
void CalculateFontAndBitmapStuff (int vspacing)
 
void CheckColumnWidths (int widthChange=0)
 Makes sure all columns have minimum width.
 
void ClearModifiedStatus (wxPGProperty *p)
 
wxPGPropertyDoAppend (wxPGProperty *property)
 Base append. More...
 
void DoClear ()
 Called in, for example, wxPropertyGrid::Clear. More...
 
bool DoClearSelection ()
 
bool DoCollapse (wxPGProperty *p)
 
virtual void DoDelete (wxPGProperty *item, bool doDelete=true)
 Override this member function to add custom behavior on property deletion.
 
bool DoEnableProperty (wxPGProperty *p, bool enable)
 Enables or disables given property and its subproperties. More...
 
bool DoExpand (wxPGProperty *p)
 
wxSize DoFitColumns (bool allowGridResize=false)
 
int DoGetColumnProportion (unsigned int column) const
 
wxPGPropertyDoGetItemAtY (int y) const
 
wxVariant DoGetPropertyValues (const wxString &listname, wxPGProperty *baseparent, long flags) const
 
wxPGPropertyDoGetRoot () const
 
bool DoHideProperty (wxPGProperty *p, bool hide, int flags=wxPG_RECURSE)
 
virtual wxPGPropertyDoInsert (wxPGProperty *parent, int index, wxPGProperty *property)
 Override this member function to add custom behavior on property insertion.
 
bool DoIsPropertySelected (wxPGProperty *prop) const
 
void DoLimitPropertyEditing (wxPGProperty *p, bool limit=true)
 
void DoRemoveFromSelection (wxPGProperty *prop)
 
bool DoSelectProperty (wxPGProperty *p, unsigned int flags=0)
 
void DoSetColumnProportion (unsigned int column, int proportion)
 
bool DoSetPropertyValue (wxPGProperty *p, wxVariant &value)
 
void DoSetPropertyValues (const wxVariantList &list, wxPGProperty *default_category)
 
bool DoSetPropertyValueString (wxPGProperty *p, const wxString &value)
 
bool DoSetPropertyValueWxObjectPtr (wxPGProperty *p, wxObject *value)
 
void DoSetSelection (wxPGProperty *prop)
 
bool EnableCategories (bool enable)
 
void EnsureVirtualHeight ()
 Make sure virtual height is up-to-date.
 
unsigned int GetActualVirtualHeight () const
 Returns actual height of contained visible properties. More...
 
unsigned int GetColumnCount () const
 
int GetColumnFitWidth (wxClientDC &dc, wxPGProperty *pwc, unsigned int col, bool subProps) const
 Returns minimal width for given column so that all images and texts will fit entirely. More...
 
int GetColumnMinWidth (int column) const
 
int GetColumnWidth (unsigned int column) const
 
wxPropertyGridGetGrid () const
 
wxPGPropertyGetLastItem (int flags=wxPG_ITERATE_DEFAULT)
 Returns last item which could be iterated using given flags. More...
 
const wxPGPropertyGetLastItem (int flags=wxPG_ITERATE_DEFAULT) const
 
wxPGPropertyGetNextCategory (wxPGProperty *id) const
 
wxPGPropertyGetNextProperty (wxPGProperty *id)
 
wxPGPropertyGetNextSiblingProperty (wxPGProperty *id)
 
wxPGPropertyGetPrevProperty (wxPGProperty *id)
 
wxPGPropertyGetPrevSiblingProperty (wxPGProperty *id)
 
wxPGPropertyGetPropertyByLabel (const wxString &name, wxPGProperty *parent=NULL) const
 
wxPropertyCategoryGetPropertyCategory (const wxPGProperty *p) const
 
wxPGPropertyGetSelection () const
 Returns currently selected property.
 
unsigned int GetVirtualHeight () const
 Returns (precalculated) height of contained visible properties.
 
unsigned int GetVirtualHeight ()
 Returns (precalculated) height of contained visible properties.
 
int GetVirtualWidth () const
 
wxPropertyGridHitTestResult HitTest (const wxPoint &pt) const
 Returns information about arbitrary position in the grid. More...
 
void InitNonCatMode ()
 Only inits arrays, doesn't migrate things or such. More...
 
bool IsDisplayed () const
 
bool IsInNonCatMode () const
 
void OnClientWidthChange (int newWidth, int widthChange, bool fromOnResize=false)
 widthChange is non-client.
 
void PropagateColSizeDec (int column, int decrease, int dir)
 
void RecalculateVirtualHeight ()
 Recalculates m_virtualHeight.
 
void ResetColumnSizes (bool fromAutoCenter)
 
void SetColumnCount (int colCount)
 
void SetSplitterLeft (bool subProps=false)
 
void SetVirtualWidth (int width)
 Set virtual width for this particular page. More...
 
void Sort (wxPGProperty *p)
 
void Sort ()
 
void VirtualHeightChanged ()
 Called after virtual height needs to be recalculated.
 
 wxPropertyGridState ()
 Constructor. More...
 
virtual ~wxPropertyGridState ()
 Destructor. More...
 

Protected Member Functions

virtual void DoSetSplitterPosition (int pos, int splitterColumn=0, bool allPages=false, bool fromAutoCenter=false)
 Propagate to other pages.
 
- Protected Member Functions inherited from wxPropertyGridInterface
bool DoClearSelection (bool validation, int selFlags=0)
 
virtual wxPGPropertyDoGetPropertyByName (const wxString &name) const
 
virtual bool DoSelectPage (int WXUNUSED(index))
 
void DoSetPropertyAttribute (wxPGPropArg id, const wxString &name, wxVariant &value, long argFlags)
 
virtual wxVariant GetEditableStateItem (const wxString &name) const
 In derived class, implement to return editable state component with given name.
 
virtual wxPropertyGridStateGetPageState (int pageIndex) const
 
virtual bool SetEditableStateItem (const wxString &name, wxVariant value)
 In derived class, implement to set editable state component with given name to given value.
 
- Protected Member Functions inherited from wxPropertyGridState
bool ArePropertiesAdjacent (wxPGProperty *prop1, wxPGProperty *prop2, int iterFlags=wxPG_ITERATE_VISIBLE) const
 
int DoGetSplitterPosition (int splitterIndex=0) const
 
int HitTestH (int x, int *pSplitterHit, int *pSplitterHitOffset) const
 Returns column at x coordinate (in GetGrid()->GetPanel()). More...
 

Protected Attributes

int m_id
 
wxString m_label
 Page label (may be referred as name in some parts of documentation). More...
 
wxPropertyGridManagerm_manager
 
- Protected Attributes inherited from wxPropertyGridInterface
wxString m_emptyString
 
wxPropertyGridStatem_pState
 

Additional Inherited Members

- Public Types inherited from wxPropertyGridInterface
enum  EditableStateFlags {
  SelectionState = 0x01, ExpandedState = 0x02, ScrollPosState = 0x04, PageState = 0x08,
  SplitterPosState = 0x10, DescBoxState = 0x20, AllStates
}
 
- Static Public Member Functions inherited from wxPropertyGridInterface
static wxPGPropertyCreatePropertyByClass (const wxString &classname, const wxString &label, const wxString &name)
 Constructs a property. More...
 
static wxPGPropertyCreatePropertyByType (const wxString &valuetype, const wxString &label, const wxString &name)
 Constructs a property. More...
 
static wxPGEditorGetEditorByName (const wxString &editorName)
 
static void InitAllTypeHandlers ()
 Initializes all property types. More...
 
static void RegisterAdditionalEditors ()
 Initializes additional property editors (SpinCtrl etc.). More...
 
static void SetBoolChoices (const wxString &true_choice, const wxString &false_choice)
 Lets user to set the strings listed in the choice dropdown of a wxBoolProperty. More...
 

Detailed Description

Holder of property grid page information.

You can subclass this and give instance in wxPropertyGridManager::AddPage. It inherits from wxEvtHandler and can be used to process events specific to this page (id of events will still be same as manager's). If you don't want to use it to process all events of the page, you need to return false in the derived wxPropertyGridPage::IsHandlingAllEvents.

Please note that wxPropertyGridPage lacks many non-const property manipulation functions found in wxPropertyGridManager. Please use parent manager (m_manager member variable) when needed.

Please note that most member functions are inherited and as such not documented on this page. This means you will probably also want to read wxPropertyGridInterface class reference.

Derived from

wxPropertyGridInterface
wxPropertyGridState
wxEvtHandler
wxObject

Include files

<wx/propgrid/manager.h>

Event handling

wxPropertyGridPage receives events emitted by its wxPropertyGridManager, but only those events that are specific to that page. If wxPropertyGridPage::IsHandlingAllEvents returns false, then unhandled events are sent to the manager's parent, as usual.

Member Function Documentation

◆ FitColumns()

wxSize wxPropertyGridPage::FitColumns ( )

Reduces column sizes to minimum possible that contents are still visibly (naturally some margin space will be applied as well).

Return values
Minimumsize for the page to still display everything.
Remarks
This function only works properly if size of containing grid was already fairly large.

Note that you can also get calculated column widths by calling GetColumnWidth() immediately after this function returns.

◆ GetRoot()

wxPGProperty* wxPropertyGridPage::GetRoot ( ) const

Returns "root property".

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

◆ Init()

virtual void wxPropertyGridPage::Init ( )
virtual

Do any member initialization in this method.

Remarks
  • Called every time the page is added into a manager.
  • You can add properties to the page here.

◆ OnShow()

virtual void wxPropertyGridPage::OnShow ( )
virtual

Called every time page is about to be shown.

Useful, for instance, creating properties just-in-time.

◆ SetSplitterPosition()

void wxPropertyGridPage::SetSplitterPosition ( int  splitterPos,
int  col = 0 
)

Sets splitter position on page.

Remarks
Splitter position cannot exceed grid size, and therefore setting it during form creation may fail as initial grid size is often smaller than desired splitter position, especially when sizers are being used.

Member Data Documentation

◆ m_label

wxString wxPropertyGridPage::m_label
protected

Page label (may be referred as name in some parts of documentation).

Can be set in constructor, or passed in wxPropertyGridManager::AddPage(), but not in both.


The documentation for this class was generated from the following file: