| Version: 3.0.5

- Main Page
- Related Pages
- Categories
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Static Public Member Functions | List of all members
wxPropertyGrid Class Reference
Class List by Category » wxPropertyGrid

`#include <wx/propgrid/propgrid.h>`

Inheritance diagram for wxPropertyGrid:
[legend]

## Detailed Description

wxPropertyGrid is a specialized grid for editing properties - in other words name = value pairs.

List of ready-to-use property classes include strings, numbers, flag sets, fonts, colours and many others. It is possible, for example, to categorize properties, set up a complete tree-hierarchy, add more than two columns, and set arbitrary per-property attributes.

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.

See also wxPropertyGrid Overview.

# Window Styles

See wxPropertyGrid Window Styles.

# Event Handling

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

## Events emitted by this class

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(wxPropertyGridEvent& event)

Event macros for events emitted by this class:

- EVT_PG_SELECTED (id, func):
  Respond to `wxEVT_PG_SELECTED` event, generated when a property selection has been changed, either by user action or by indirect program function. For instance, collapsing a parent property programmatically causes any selected child property to become unselected, and may therefore cause this event to be generated.
- EVT_PG_CHANGED(id, func):
  Respond to `wxEVT_PG_CHANGED` event, generated when property value has been changed by the user.
- EVT_PG_CHANGING(id, func):
  Respond to `wxEVT_PG_CHANGING` event, generated when property value is about to be changed by user. Use wxPropertyGridEvent::GetValue() to take a peek at the pending value, and wxPropertyGridEvent::Veto() to prevent change from taking place, if necessary.
- EVT_PG_HIGHLIGHTED(id, func):
  Respond to `wxEVT_PG_HIGHLIGHTED` event, which occurs when mouse moves over a property. Event's property is NULL if hovered area does not belong to any property.
- EVT_PG_RIGHT_CLICK(id, func):
  Respond to `wxEVT_PG_RIGHT_CLICK` event, which occurs when property is clicked on with right mouse button.
- EVT_PG_DOUBLE_CLICK(id, func):
  Respond to `wxEVT_PG_DOUBLE_CLICK` event, which occurs when property is double-clicked on with left mouse button.
- EVT_PG_ITEM_COLLAPSED(id, func):
  Respond to `wxEVT_PG_ITEM_COLLAPSED` event, generated when user collapses a property or category.
- EVT_PG_ITEM_EXPANDED(id, func):
  Respond to `wxEVT_PG_ITEM_EXPANDED` event, generated when user expands a property or category.
- EVT_PG_LABEL_EDIT_BEGIN(id, func):
  Respond to `wxEVT_PG_LABEL_EDIT_BEGIN` event, generated when user is about to begin editing a property label. You can veto this event to prevent the action.
- EVT_PG_LABEL_EDIT_ENDING(id, func):
  Respond to `wxEVT_PG_LABEL_EDIT_ENDING` event, generated when user is about to end editing of a property label. You can veto this event to prevent the action.
- EVT_PG_COL_BEGIN_DRAG(id, func):
  Respond to `wxEVT_PG_COL_BEGIN_DRAG` event, generated when user starts resizing a column - can be vetoed.
- EVT_PG_COL_DRAGGING, (id, func):
  Respond to `wxEVT_PG_COL_DRAGGING`, event, generated when a column resize by user is in progress. This event is also generated when user double-clicks the splitter in order to recenter it.
- EVT_PG_COL_END_DRAG(id, func):
  Respond to `wxEVT_PG_COL_END_DRAG` event, generated after column resize by user has finished.

Remarks
  Use Freeze() and Thaw() respectively to disable and enable drawing. This will also delay sorting etc. miscellaneous calculations to the last possible moment.

##

Library: wxPropertyGrid
Category: wxPropertyGrid

Appearance:

wxMSW Appearance | wxGTK Appearance | wxOSX Appearance

## Public Member Functions

| wxPropertyGrid ()
| Two step constructor. More...
| wxPropertyGrid (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxPG_DEFAULT_STYLE, const wxString &name=wxPropertyGridNameStr)
| Constructor. More...
virtual | ~wxPropertyGrid ()
| Destructor. More...
void | AddActionTrigger (int action, int keycode, int modifiers=0)
| Adds given key combination to trigger given action. More...
bool | AddToSelection (wxPGPropArg id)
| Adds given property into selection. More...
void | BeginLabelEdit (unsigned int colIndex=0)
| Creates label editor wxTextCtrl for given column, for property that is currently selected. More...
bool | ChangePropertyValue (wxPGPropArg id, wxVariant newValue)
| Changes value of a property, as if from an editor. More...
void | CenterSplitter (bool enableAutoResizing=false)
| Centers the splitter. More...
virtual void | Clear ()
| Deletes all properties. More...
void | ClearActionTriggers (int action)
| Clears action triggers for given action. More...
virtual bool | CommitChangesFromEditor (wxUint32 flags=0)
| Forces updating the value of property from the editor control. More...
bool | Create (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxPG_DEFAULT_STYLE, const wxString &name=wxPropertyGridNameStr)
| Two step creation. More...
void | DedicateKey (int keycode)
| Dedicates a specific keycode to wxPropertyGrid. More...
bool | EnableCategories (bool enable)
| Enables or disables (shows/hides) categories according to parameter enable. More...
void | EndLabelEdit (bool commit=true)
| Destroys label editor wxTextCtrl, if any. More...
bool | EnsureVisible (wxPGPropArg id)
| Scrolls and/or expands items to ensure that the given item is visible. More...
wxSize | FitColumns ()
| Reduces column sizes to minimum possible, while still retaining fully visible grid contents (labels, images). More...
wxTextCtrl * | GetLabelEditor () const
| Returns currently active label editor, NULL if none. More...
wxWindow * | GetPanel ()
| Returns wxWindow that the properties are painted on, and which should be used as the parent for editor controls. More...
wxColour | GetCaptionBackgroundColour () const
| Returns current category caption background colour. More...
wxFont & | GetCaptionFont ()
| Returns current category caption font. More...
wxColour | GetCaptionForegroundColour () const
| Returns current category caption text colour. More...
wxColour | GetCellBackgroundColour () const
| Returns current cell background colour. More...
wxColour | GetCellDisabledTextColour () const
| Returns current cell text colour when disabled. More...
wxColour | GetCellTextColour () const
| Returns current cell text colour. More...
unsigned int | GetColumnCount () const
| Returns number of columns currently on grid. More...
wxColour | GetEmptySpaceColour () const
| Returns colour of empty space below properties. More...
int | GetFontHeight () const
| Returns height of highest characters of used font. More...
wxPropertyGrid * | GetGrid ()
| Returns pointer to itself. More...
wxRect | GetImageRect (wxPGProperty *property, int item) const
| Returns rectangle of custom paint image. More...
wxSize | GetImageSize (wxPGProperty *property=NULL, int item=-1) const
| Returns size of the custom paint image in front of property. More...
wxPGProperty * | GetLastItem (int flags=wxPG_ITERATE_DEFAULT)
| Returns last item which could be iterated using given flags. More...
wxColour | GetLineColour () const
| Returns colour of lines between cells. More...
wxColour | GetMarginColour () const
| Returns background colour of margin. More...
wxPGProperty * | GetRoot () const
| Returns "root property". More...
int | GetRowHeight () const
| Returns height of a single grid row (in pixels). More...
wxPGProperty * | GetSelectedProperty () const
| Returns currently selected property. More...
wxPGProperty * | GetSelection () const
| Returns currently selected property. More...
wxColour | GetSelectionBackgroundColour () const
| Returns current selection background colour. More...
wxColour | GetSelectionForegroundColour () const
| Returns current selection text colour. More...
wxPGSortCallback | GetSortFunction () const
| Returns the property sort function (default is NULL). More...
int | GetSplitterPosition (unsigned int splitterIndex=0) const
| Returns current splitter x position. More...
wxTextCtrl * | GetEditorTextCtrl () const
| Returns wxTextCtrl active in currently selected property, if any. More...
const wxPGCell & | GetUnspecifiedValueAppearance () const
| Returns current appearance of unspecified value cells. More...
wxString | GetUnspecifiedValueText (int argFlags=0) const
| Returns (visual) text representation of the unspecified property value. More...
int | GetVerticalSpacing () const
| Returns current vertical spacing. More...
wxPropertyGridHitTestResult | HitTest (const wxPoint &pt) const
| Returns information about arbitrary position in the grid. More...
bool | IsAnyModified () const
| Returns true if any property has been modified by the user. More...
bool | IsEditorFocused () const
| Returns true if a property editor control has focus. More...
bool | IsFrozen () const
| Returns true if updating is frozen (ie. More...
void | MakeColumnEditable (unsigned int column, bool editable=true)
| Makes given column editable by user. More...
void | OnTLPChanging (wxWindow *newTLP)
| It is recommended that you call this function any time your code causes wxPropertyGrid's top-level parent to change. More...
void | RefreshEditor ()
| Refreshes any active editor control. More...
virtual void | RefreshProperty (wxPGProperty *p)
| Redraws given property. More...
void | ResetColours ()
| Resets all colours to the original system values. More...
void | ResetColumnSizes (bool enableAutoResizing=false)
| Resets column sizes and splitter positions, based on proportions. More...
bool | RemoveFromSelection (wxPGPropArg id)
| Removes given property from selection. More...
bool | SelectProperty (wxPGPropArg id, bool focus=false)
| Selects a property. More...
void | SetCaptionBackgroundColour (const wxColour &col)
| Sets category caption background colour. More...
void | SetCaptionTextColour (const wxColour &col)
| Sets category caption text colour. More...
void | SetCellBackgroundColour (const wxColour &col)
| Sets default cell background colour - applies to property cells. More...
void | SetCellDisabledTextColour (const wxColour &col)
| Sets cell text colour for disabled properties. More...
void | SetCellTextColour (const wxColour &col)
| Sets default cell text colour - applies to property name and value text. More...
void | SetColumnCount (int colCount)
| Set number of columns (2 or more). More...
void | SetCurrentCategory (wxPGPropArg id)
| Sets the 'current' category - Append will add non-category properties under it. More...
void | SetEmptySpaceColour (const wxColour &col)
| Sets colour of empty space below properties. More...
void | SetLineColour (const wxColour &col)
| Sets colour of lines between cells. More...
void | SetMarginColour (const wxColour &col)
| Sets background colour of margin. More...
void | SetSelection (const wxArrayPGProperty &newSelection)
| Set entire new selection from given list of properties. More...
void | SetSelectionBackgroundColour (const wxColour &col)
| Sets selection background colour - applies to selected property name background. More...
void | SetSelectionTextColour (const wxColour &col)
| Sets selection foreground colour - applies to selected property name text. More...
void | SetSortFunction (wxPGSortCallback sortFunction)
| Sets the property sorting function. More...
void | SetSplitterPosition (int newxpos, int col=0)
| Sets x coordinate of the splitter. More...
void | SetSplitterLeft (bool privateChildrenToo=false)
| Moves splitter as left as possible, while still allowing all labels to be shown in full. More...
void | SetUnspecifiedValueAppearance (const wxPGCell &cell)
| Sets appearance of value cells representing an unspecified property value. More...
void | SetVerticalSpacing (int vspacing)
| Sets vertical spacing. More...
wxPropertyGrid customization
Reimplement these member functions in derived class for better control over wxPropertyGrid behaviour.
virtual void | DoShowPropertyError (wxPGProperty *property, const wxString &msg)
| Override in derived class to display error messages in custom manner (these message usually only result from validation failure). More...
virtual void | DoHidePropertyError (wxPGProperty *property)
| Override in derived class to hide an error displayed by DoShowPropertyError(). More...
virtual wxStatusBar * | GetStatusBar ()
| Return wxStatusBar that is used by this wxPropertyGrid. More...
Property development functions
These member functions are usually only called when creating custom user properties.
void | EditorsValueWasModified ()
| Call when editor widget's contents is modified. More...
void | EditorsValueWasNotModified ()
| Reverse of EditorsValueWasModified(). More...
wxVariant | GetUncommittedPropertyValue ()
| Returns most up-to-date value of selected property. More...
bool | IsEditorsValueModified () const
| Returns true if editor's value was marked modified. More...
void | ShowPropertyError (wxPGPropArg id, const wxString &msg)
| Shows an brief error message that is related to a property. More...
bool | WasValueChangedInEvent () const
| You can use this member function, for instance, to detect in wxPGProperty::OnEvent() if wxPGProperty::SetValueInEvent() was already called in wxPGEditor::OnEvent(). More...
Public Member Functions inherited from wxControl
| wxControl (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxValidator &validator=wxDefaultValidator, const wxString &name=wxControlNameStr)
| Constructs a control. More...
| wxControl ()
| Default constructor to allow 2-phase creation. More...
bool | Create (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxValidator &validator=wxDefaultValidator, const wxString &name=wxControlNameStr)
virtual void | Command (wxCommandEvent &event)
| Simulates the effect of the user issuing a command to the item. More...
wxString | GetLabel () const
| Returns the control's label, as it was passed to SetLabel(). More...
wxString | GetLabelText () const
| Returns the control's label without mnemonics. More...
wxSize | GetSizeFromTextSize (int xlen, int ylen=-1) const
| Determine the size needed by the control to leave the given area for its text. More...
wxSize | GetSizeFromTextSize (const wxSize &tsize) const
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
void | SetLabel (const wxString &label)
| Sets the control's label. More...
void | SetLabelText (const wxString &text)
| Sets the control's label to exactly the given string. More...
bool | SetLabelMarkup (const wxString &markup)
| Sets the controls label to a string using markup. More...
Public Member Functions inherited from wxWindow
| wxWindow ()
| Default constructor. More...
| wxWindow (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxPanelNameStr)
| Constructs a window, which can be a child of a frame, dialog or any other non-control window. More...
virtual | ~wxWindow ()
| Destructor. More...
bool | Create (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxPanelNameStr)
virtual bool | AcceptsFocus () const
| This method may be overridden in the derived classes to return false to indicate that this control doesn't accept input at all (i.e. behaves like e.g. wxStaticText) and so doesn't need focus. More...
virtual bool | AcceptsFocusFromKeyboard () const
| This method may be overridden in the derived classes to return false to indicate that while this control can, in principle, have focus if the user clicks it with the mouse, it shouldn't be included in the TAB traversal chain when using the keyboard. More...
virtual bool | AcceptsFocusRecursively () const
| Overridden to indicate whether this window or one of its children accepts focus. More...
bool | IsFocusable () const
| Can this window itself have focus? More...
bool | CanAcceptFocus () const
| Can this window have focus right now? More...
bool | CanAcceptFocusFromKeyboard () const
| Can this window be assigned focus from keyboard right now? More...
virtual bool | HasFocus () const
| Returns true if the window (or in case of composite controls, its main child window) has focus. More...
virtual void | SetCanFocus (bool canFocus)
| This method is only implemented by ports which have support for native TAB traversal (such as GTK+ 2.0). More...
virtual void | SetFocus ()
| This sets the window to receive keyboard input. More...
virtual void | SetFocusFromKbd ()
| This function is called by wxWidgets keyboard navigation code when the user gives the focus to this window from keyboard (e.g. More...
virtual void | AddChild (wxWindow *child)
| Adds a child window. More...
bool | DestroyChildren ()
| Destroys all children of a window. More...
wxWindow * | FindWindow (long id) const
| Find a child of this window, by id. More...
wxWindow * | FindWindow (const wxString &name) const
| Find a child of this window, by name. More...
wxWindowList & | GetChildren ()
| Returns a reference to the list of the window's children. More...
const wxWindowList & | GetChildren () const
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
virtual void | RemoveChild (wxWindow *child)
| Removes a child window. More...
wxWindow * | GetGrandParent () const
| Returns the grandparent of a window, or NULL if there isn't one. More...
wxWindow * | GetNextSibling () const
| Returns the next window after this one among the parent's children or NULL if this window is the last child. More...
wxWindow * | GetParent () const
| Returns the parent of the window, or NULL if there is no parent. More...
wxWindow * | GetPrevSibling () const
| Returns the previous window before this one among the parent's children or `` NULL if this window is the first child. More...
bool | IsDescendant (wxWindowBase *win) const
| Check if the specified window is a descendant of this one. More...
virtual bool | Reparent (wxWindow *newParent)
| Reparents the window, i.e. the window will be removed from its current parent window (e.g. More...
virtual void | AlwaysShowScrollbars (bool hflag=true, bool vflag=true)
| Call this function to force one or both scrollbars to be always shown, even if the window is big enough to show its entire contents without scrolling. More...
virtual int | GetScrollPos (int orientation) const
| Returns the built-in scrollbar position. More...
virtual int | GetScrollRange (int orientation) const
| Returns the built-in scrollbar range. More...
virtual int | GetScrollThumb (int orientation) const
| Returns the built-in scrollbar thumb size. More...
bool | CanScroll (int orient) const
| Returns true if this window can have a scroll bar in this orientation. More...
bool | HasScrollbar (int orient) const
| Returns true if this window currently has a scroll bar for this orientation. More...
virtual bool | IsScrollbarAlwaysShown (int orient) const
| Return whether a scrollbar is always shown. More...
virtual bool | ScrollLines (int lines)
| Scrolls the window by the given number of lines down (if lines is positive) or up. More...
virtual bool | ScrollPages (int pages)
| Scrolls the window by the given number of pages down (if pages is positive) or up. More...
virtual void | ScrollWindow (int dx, int dy, const wxRect *rect=NULL)
| Physically scrolls the pixels in the window and move child windows accordingly. More...
bool | LineUp ()
| Same as ScrollLines (-1). More...
bool | LineDown ()
| Same as ScrollLines (1). More...
bool | PageUp ()
| Same as ScrollPages (-1). More...
bool | PageDown ()
| Same as ScrollPages (1). More...
virtual void | SetScrollPos (int orientation, int pos, bool refresh=true)
| Sets the position of one of the built-in scrollbars. More...
virtual void | SetScrollbar (int orientation, int position, int thumbSize, int range, bool refresh=true)
| Sets the scrollbar properties of a built-in scrollbar. More...
bool | BeginRepositioningChildren ()
| Prepare for changing positions of multiple child windows. More...
void | EndRepositioningChildren ()
| Fix child window positions after setting all of them at once. More...
void | CacheBestSize (const wxSize &size) const
| Sets the cached best size value. More...
virtual wxSize | ClientToWindowSize (const wxSize &size) const
| Converts client area size size to corresponding window size. More...
virtual wxSize | WindowToClientSize (const wxSize &size) const
| Converts window size size to corresponding client area size In other words, the returned value is what would GetClientSize() return if this window had given window size. More...
virtual void | Fit ()
| Sizes the window so that it fits around its subwindows. More...
virtual void | FitInside ()
| Similar to Fit(), but sizes the interior (virtual) size of a window. More...
wxSize | GetBestSize () const
| This functions returns the best acceptable minimal size for the window. More...
int | GetBestHeight (int width) const
| Returns the best height needed by this window if it had the given width. More...
int | GetBestWidth (int height) const
| Returns the best width needed by this window if it had the given height. More...
void | GetClientSize (int *width, int *height) const
| Returns the size of the window 'client area' in pixels. More...
wxSize | GetClientSize () const
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
virtual wxSize | GetEffectiveMinSize () const
| Merges the window's best size into the min size and returns the result. More...
virtual wxSize | GetMaxClientSize () const
| Returns the maximum size of window's client area. More...
virtual wxSize | GetMaxSize () const
| Returns the maximum size of the window. More...
virtual wxSize | GetMinClientSize () const
| Returns the minimum size of window's client area, an indication to the sizer layout mechanism that this is the minimum required size of its client area. More...
virtual wxSize | GetMinSize () const
| Returns the minimum size of the window, an indication to the sizer layout mechanism that this is the minimum required size. More...
int | GetMinWidth () const
| Returns the horizontal component of window minimal size. More...
int | GetMinHeight () const
| Returns the vertical component of window minimal size. More...
int | GetMaxWidth () const
| Returns the horizontal component of window maximal size. More...
int | GetMaxHeight () const
| Returns the vertical component of window maximal size. More...
void | GetSize (int *width, int *height) const
| Returns the size of the entire window in pixels, including title bar, border, scrollbars, etc. More...
wxSize | GetSize () const
| See the GetSize(int*,int*) overload for more info. More...
wxSize | GetVirtualSize () const
| This gets the virtual size of the window in pixels. More...
void | GetVirtualSize (int *width, int *height) const
| Like the other GetVirtualSize() overload but uses pointers instead. More...
virtual wxSize | GetBestVirtualSize () const
| Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means) More...
virtual double | GetContentScaleFactor () const
| Returns the magnification of the backing store of this window, eg 2.0 for a window on a retina screen. More...
virtual wxSize | GetWindowBorderSize () const
| Returns the size of the left/right and top/bottom borders of this window in x and y components of the result respectively. More...
virtual bool | InformFirstDirection (int direction, int size, int availableOtherDir)
| wxSizer and friends use this to give a chance to a component to recalc its min size once one of the final size components is known. More...
void | InvalidateBestSize ()
| Resets the cached best size value so it will be recalculated the next time it is needed. More...
void | PostSizeEvent ()
| Posts a size event to the window. More...
void | PostSizeEventToParent ()
| Posts a size event to the parent of this window. More...
virtual void | SendSizeEvent (int flags=0)
| This function sends a dummy size event to the window allowing it to re-layout its children positions. More...
void | SendSizeEventToParent (int flags=0)
| Safe wrapper for GetParent()->SendSizeEvent(). More...
void | SetClientSize (int width, int height)
| This sets the size of the window client area in pixels. More...
void | SetClientSize (const wxSize &size)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
void | SetClientSize (const wxRect &rect)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
void | SetContainingSizer (wxSizer *sizer)
| This normally does not need to be called by user code. More...
void | SetInitialSize (const wxSize &size=wxDefaultSize)
| A smart SetSize that will fill in default size components with the window's best size values. More...
virtual void | SetMaxClientSize (const wxSize &size)
| Sets the maximum client size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size of its client area. More...
virtual void | SetMaxSize (const wxSize &size)
| Sets the maximum size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size. More...
virtual void | SetMinClientSize (const wxSize &size)
| Sets the minimum client size of the window, to indicate to the sizer layout mechanism that this is the minimum required size of window's client area. More...
virtual void | SetMinSize (const wxSize &size)
| Sets the minimum size of the window, to indicate to the sizer layout mechanism that this is the minimum required size. More...
void | SetSize (int x, int y, int width, int height, int sizeFlags=wxSIZE_AUTO)
| Sets the size of the window in pixels. More...
void | SetSize (const wxRect &rect)
| Sets the size of the window in pixels. More...
void | SetSize (const wxSize &size)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
void | SetSize (int width, int height)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
virtual void | SetSizeHints (const wxSize &minSize, const wxSize &maxSize=wxDefaultSize, const wxSize &incSize=wxDefaultSize)
| Use of this function for windows which are not toplevel windows (such as wxDialog or wxFrame) is discouraged. More...
virtual void | SetSizeHints (int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
void | SetVirtualSize (int width, int height)
| Sets the virtual size of the window in pixels. More...
void | SetVirtualSize (const wxSize &size)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
void | Center (int dir=wxBOTH)
| A synonym for Centre(). More...
void | CenterOnParent (int dir=wxBOTH)
| A synonym for CentreOnParent(). More...
void | Centre (int direction=wxBOTH)
| Centres the window. More...
void | CentreOnParent (int direction=wxBOTH)
| Centres the window on its parent. More...
void | GetPosition (int *x, int *y) const
| This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows. More...
wxPoint | GetPosition () const
| This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows. More...
wxRect | GetRect () const
| Returns the position and size of the window as a wxRect object. More...
void | GetScreenPosition (int *x, int *y) const
| Returns the window position in screen coordinates, whether the window is a child window or a top level one. More...
wxPoint | GetScreenPosition () const
| Returns the window position in screen coordinates, whether the window is a child window or a top level one. More...
wxRect | GetScreenRect () const
| Returns the position and size of the window on the screen as a wxRect object. More...
virtual wxPoint | GetClientAreaOrigin () const
| Get the origin of the client area of the window relative to the window top left corner (the client area may be shifted because of the borders, scrollbars, other decorations...) More...
wxRect | GetClientRect () const
| Get the client rectangle in window (i.e. client) coordinates. More...
void | Move (int x, int y, int flags=wxSIZE_USE_EXISTING)
| Moves the window to the given position. More...
void | Move (const wxPoint &pt, int flags=wxSIZE_USE_EXISTING)
| Moves the window to the given position. More...
void | SetPosition (const wxPoint &pt)
| Moves the window to the specified position. More...
void | ClientToScreen (int *x, int *y) const
| Converts to screen coordinates from coordinates relative to this window. More...
wxPoint | ClientToScreen (const wxPoint &pt) const
| Converts to screen coordinates from coordinates relative to this window. More...
wxPoint | ConvertDialogToPixels (const wxPoint &pt) const
| Converts a point or size from dialog units to pixels. More...
wxSize | ConvertDialogToPixels (const wxSize &sz) const
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
wxPoint | ConvertPixelsToDialog (const wxPoint &pt) const
| Converts a point or size from pixels to dialog units. More...
wxSize | ConvertPixelsToDialog (const wxSize &sz) const
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
void | ScreenToClient (int *x, int *y) const
| Converts from screen to client window coordinates. More...
wxPoint | ScreenToClient (const wxPoint &pt) const
| Converts from screen to client window coordinates. More...
virtual void | ClearBackground ()
| Clears the window by filling it with the current background colour. More...
void | Freeze ()
| Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all. More...
void | Thaw ()
| Re-enables window updating after a previous call to Freeze(). More...
bool | IsFrozen () const
| Returns true if the window is currently frozen by a call to Freeze(). More...
wxColour | GetBackgroundColour () const
| Returns the background colour of the window. More...
virtual wxBackgroundStyle | GetBackgroundStyle () const
| Returns the background style of the window. More...
virtual int | GetCharHeight () const
| Returns the character height for this window. More...
virtual int | GetCharWidth () const
| Returns the average character width for this window. More...
virtual wxVisualAttributes | GetDefaultAttributes () const
| Currently this is the same as calling wxWindow::GetClassDefaultAttributes(wxWindow::GetWindowVariant()). More...
wxFont | GetFont () const
| Returns the font for this window. More...
wxColour | GetForegroundColour () const
| Returns the foreground colour of the window. More...
void | GetTextExtent (const wxString &string, int *w, int *h, int *descent=NULL, int *externalLeading=NULL, const wxFont *font=NULL) const
| Gets the dimensions of the string as it would be drawn on the window with the currently selected font. More...
wxSize | GetTextExtent (const wxString &string) const
| Gets the dimensions of the string as it would be drawn on the window with the currently selected font. More...
const wxRegion & | GetUpdateRegion () const
| Returns the region specifying which parts of the window have been damaged. More...
wxRect | GetUpdateClientRect () const
| Get the update rectangle bounding box in client coords. More...
virtual bool | HasTransparentBackground ()
| Returns true if this window background is transparent (as, for example, for wxStaticText) and should show the parent window background. More...
virtual void | Refresh (bool eraseBackground=true, const wxRect *rect=NULL)
| Causes this window, and all of its children recursively (except under wxGTK1 where this is not implemented), to be repainted. More...
void | RefreshRect (const wxRect &rect, bool eraseBackground=true)
| Redraws the contents of the given rectangle: only the area inside it will be repainted. More...
virtual void | Update ()
| Calling this method immediately repaints the invalidated area of the window and all of its children recursively (this normally only happens when the flow of control returns to the event loop). More...
virtual bool | SetBackgroundColour (const wxColour &colour)
| Sets the background colour of the window. More...
virtual bool | SetBackgroundStyle (wxBackgroundStyle style)
| Sets the background style of the window. More...
virtual bool | IsTransparentBackgroundSupported (wxString *reason=NULL) const
| Checks whether using transparent background might work. More...
virtual bool | SetFont (const wxFont &font)
| Sets the font for this window. More...
virtual bool | SetForegroundColour (const wxColour &colour)
| Sets the foreground colour of the window. More...
void | SetOwnBackgroundColour (const wxColour &colour)
| Sets the background colour of the window but prevents it from being inherited by the children of this window. More...
bool | InheritsBackgroundColour () const
| Return true if this window inherits the background colour from its parent. More...
bool | UseBgCol () const
| Return true if a background colour has been set for this window. More...
void | SetOwnFont (const wxFont &font)
| Sets the font of the window but prevents it from being inherited by the children of this window. More...
void | SetOwnForegroundColour (const wxColour &colour)
| Sets the foreground colour of the window but prevents it from being inherited by the children of this window. More...
void | SetPalette (const wxPalette &pal)
virtual bool | ShouldInheritColours () const
| Return true from here to allow the colours of this window to be changed by InheritAttributes(). More...
virtual void | SetThemeEnabled (bool enable)
| This function tells a window if it should use the system's "theme" code to draw the windows' background instead of its own background drawing code. More...
virtual bool | GetThemeEnabled () const
| Clears the window by filling it with the current background colour. More...
virtual bool | CanSetTransparent ()
| Returns true if the system supports transparent windows and calling SetTransparent() may succeed. More...
virtual bool | SetTransparent (wxByte alpha)
| Set the transparency of the window. More...
wxEvtHandler * | GetEventHandler () const
| Returns the event handler for this window. More...
bool | HandleAsNavigationKey (const wxKeyEvent &event)
| This function will generate the appropriate call to Navigate() if the key event is one normally used for keyboard navigation and return true in this case. More...
bool | HandleWindowEvent (wxEvent &event) const
| Shorthand for: More...
bool | ProcessWindowEvent (wxEvent &event)
| Convenient wrapper for ProcessEvent(). More...
bool | ProcessWindowEventLocally (wxEvent &event)
| Wrapper for wxEvtHandler::ProcessEventLocally(). More...
wxEvtHandler * | PopEventHandler (bool deleteHandler=false)
| Removes and returns the top-most event handler on the event handler stack. More...
void | PushEventHandler (wxEvtHandler *handler)
| Pushes this event handler onto the event stack for the window. More...
bool | RemoveEventHandler (wxEvtHandler *handler)
| Find the given handler in the windows event handler stack and removes (but does not delete) it from the stack. More...
void | SetEventHandler (wxEvtHandler *handler)
| Sets the event handler for this window. More...
virtual void | SetNextHandler (wxEvtHandler *handler)
| wxWindows cannot be used to form event handler chains; this function thus will assert when called. More...
virtual void | SetPreviousHandler (wxEvtHandler *handler)
| wxWindows cannot be used to form event handler chains; this function thus will assert when called. More...
long | GetExtraStyle () const
| Returns the extra style bits for the window. More...
virtual long | GetWindowStyleFlag () const
| Gets the window style that was passed to the constructor or Create() method. More...
long | GetWindowStyle () const
| See GetWindowStyleFlag() for more info. More...
bool | HasExtraStyle (int exFlag) const
| Returns true if the window has the given exFlag bit set in its extra styles. More...
bool | HasFlag (int flag) const
| Returns true if the window has the given flag bit set. More...
virtual void | SetExtraStyle (long exStyle)
| Sets the extra style bits for the window. More...
virtual void | SetWindowStyleFlag (long style)
| Sets the style of the window. More...
void | SetWindowStyle (long style)
| See SetWindowStyleFlag() for more info. More...
bool | ToggleWindowStyle (int flag)
| Turns the given flag on if it's currently turned off and vice versa. More...
void | MoveAfterInTabOrder (wxWindow *win)
| Moves this window in the tab navigation order after the specified win. More...
void | MoveBeforeInTabOrder (wxWindow *win)
| Same as MoveAfterInTabOrder() except that it inserts this window just before win instead of putting it right after it. More...
bool | Navigate (int flags=wxNavigationKeyEvent::IsForward)
| Performs a keyboard navigation action starting from this window. More...
bool | NavigateIn (int flags=wxNavigationKeyEvent::IsForward)
| Performs a keyboard navigation action inside this window. More...
virtual void | Lower ()
| Lowers the window to the bottom of the window hierarchy (Z-order). More...
virtual void | Raise ()
| Raises the window to the top of the window hierarchy (Z-order). More...
bool | Hide ()
| Equivalent to calling wxWindow::Show(false). More...
virtual bool | HideWithEffect (wxShowEffect effect, unsigned int timeout=0)
| This function hides a window, like Hide(), but using a special visual effect if possible. More...
bool | IsEnabled () const
| Returns true if the window is enabled, i.e. if it accepts user input, false otherwise. More...
bool | IsExposed (int x, int y) const
| Returns true if the given point or rectangle area has been exposed since the last repaint. More...
bool | IsExposed (wxPoint &pt) const
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
bool | IsExposed (int x, int y, int w, int h) const
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
bool | IsExposed (wxRect &rect) const
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
virtual bool | IsShown () const
| Returns true if the window is shown, false if it has been hidden. More...
virtual bool | IsShownOnScreen () const
| Returns true if the window is physically visible on the screen, i.e. it is shown and all its parents up to the toplevel window are shown as well. More...
bool | Disable ()
| Disables the window. More...
virtual bool | Enable (bool enable=true)
| Enable or disable the window for user input. More...
virtual bool | Show (bool show=true)
| Shows or hides the window. More...
virtual bool | ShowWithEffect (wxShowEffect effect, unsigned int timeout=0)
| This function shows a window, like Show(), but using a special visual effect if possible. More...
wxString | GetHelpText () const
| Gets the help text to be used as context-sensitive help for this window. More...
void | SetHelpText (const wxString &helpText)
| Sets the help text to be used as context-sensitive help for this window. More...
virtual wxString | GetHelpTextAtPoint (const wxPoint &point, wxHelpEvent::Origin origin) const
| Gets the help text to be used as context-sensitive help for this window. More...
wxToolTip * | GetToolTip () const
| Get the associated tooltip or NULL if none. More...
wxString | GetToolTipText () const
| Get the text of the associated tooltip or empty string if none. More...
void | SetToolTip (const wxString &tipString)
| Attach a tooltip to the window. More...
void | SetToolTip (wxToolTip *tip)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
void | UnsetToolTip ()
| Unset any existing tooltip. More...
int | GetPopupMenuSelectionFromUser (wxMenu &menu, const wxPoint &pos=wxDefaultPosition)
| This function shows a popup menu at the given position in this window and returns the selected id. More...
int | GetPopupMenuSelectionFromUser (wxMenu &menu, int x, int y)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
bool | PopupMenu (wxMenu *menu, const wxPoint &pos=wxDefaultPosition)
| Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu. More...
bool | PopupMenu (wxMenu *menu, int x, int y)
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
virtual wxValidator * | GetValidator ()
| Validator functions. More...
virtual void | SetValidator (const wxValidator &validator)
| Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to create a new validator of this type. More...
virtual bool | TransferDataFromWindow ()
| Transfers values from child controls to data areas specified by their validators. More...
virtual bool | TransferDataToWindow ()
| Transfers values to child controls from data areas specified by their validators. More...
virtual bool | Validate ()
| Validates the current values of the child controls using their validators. More...
wxWindowID | GetId () const
| Returns the identifier of the window. More...
virtual wxLayoutDirection | GetLayoutDirection () const
| Returns the layout direction for this window, Note that `wxLayout_Default` is returned if layout direction is not supported. More...
virtual wxCoord | AdjustForLayoutDirection (wxCoord x, wxCoord width, wxCoord widthTotal) const
| Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32. More...
virtual wxString | GetName () const
| Returns the window's name. More...
wxWindowVariant | GetWindowVariant () const
| Returns the value previously passed to SetWindowVariant(). More...
void | SetId (wxWindowID winid)
| Sets the identifier of the window. More...
virtual void | SetLayoutDirection (wxLayoutDirection dir)
| Sets the layout direction for this window. More...
virtual void | SetName (const wxString &name)
| Sets the window's name. More...
void | SetWindowVariant (wxWindowVariant variant)
| Chooses a different variant of the window display to use. More...
wxAcceleratorTable * | GetAcceleratorTable ()
| Gets the accelerator table for this window. More...
wxAccessible * | GetAccessible ()
| Returns the accessible object for this window, if any. More...
virtual void | SetAcceleratorTable (const wxAcceleratorTable &accel)
| Sets the accelerator table for this window. More...
void | SetAccessible (wxAccessible *accessible)
| Sets the accessible for this window. More...
bool | Close (bool force=false)
| This function simply generates a wxCloseEvent whose handler usually tries to close the window. More...
virtual bool | Destroy ()
| Destroys the window safely. More...
bool | IsBeingDeleted () const
| Returns true if this window is in process of being destroyed. More...
virtual wxDropTarget * | GetDropTarget () const
| Returns the associated drop target, which may be NULL. More...
virtual void | SetDropTarget (wxDropTarget *target)
| Associates a drop target with this window. More...
virtual void | DragAcceptFiles (bool accept)
| Enables or disables eligibility for drop file events (OnDropFiles). More...
wxSizer * | GetContainingSizer () const
| Returns the sizer of which this window is a member, if any, otherwise NULL. More...
wxSizer * | GetSizer () const
| Returns the sizer associated with the window by a previous call to SetSizer(), or NULL. More...
void | SetSizer (wxSizer *sizer, bool deleteOld=true)
| Sets the window to have the given layout sizer. More...
void | SetSizerAndFit (wxSizer *sizer, bool deleteOld=true)
| This method calls SetSizer() and then wxSizer::SetSizeHints which sets the initial window size to the size needed to accommodate all sizer elements and sets the size hints which, if this window is a top level one, prevent the user from resizing it to be less than this minimal size. More...
wxLayoutConstraints * | GetConstraints () const
| Returns a pointer to the window's layout constraints, or NULL if there are none. More...
void | SetConstraints (wxLayoutConstraints *constraints)
| Sets the window to have the given layout constraints. More...
virtual bool | Layout ()
| Invokes the constraint-based layout algorithm or the sizer-based algorithm for this window. More...
void | SetAutoLayout (bool autoLayout)
| Determines whether the Layout() function will be called automatically when the window is resized. More...
bool | GetAutoLayout () const
| Returns the sizer of which this window is a member, if any, otherwise NULL. More...
void | CaptureMouse ()
| Directs all mouse input to this window. More...
wxCaret * | GetCaret () const
| Returns the caret() associated with the window. More...
const wxCursor & | GetCursor () const
| Return the cursor associated with this window. More...
virtual bool | HasCapture () const
| Returns true if this window has the current mouse capture. More...
void | ReleaseMouse ()
| Releases mouse input captured with CaptureMouse(). More...
void | SetCaret (wxCaret *caret)
| Sets the caret() associated with the window. More...
virtual bool | SetCursor (const wxCursor &cursor)
| Sets the window's cursor. More...
virtual void | WarpPointer (int x, int y)
| Moves the pointer to the given position on the window. More...
wxHitTest | HitTest (wxCoord x, wxCoord y) const
| Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable. More...
wxHitTest | HitTest (const wxPoint &pt) const
| Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable. More...
wxBorder | GetBorder (long flags) const
| Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable. More...
wxBorder | GetBorder () const
| Get border for the flags of this window. More...
virtual void | DoUpdateWindowUI (wxUpdateUIEvent &event)
| Does the window-specific updating after processing the update event. More...
virtual WXWidget | GetHandle () const
| Returns the platform-specific handle of the physical window. More...
virtual bool | HasMultiplePages () const
| This method should be overridden to return true if this window has multiple pages. More...
virtual void | InheritAttributes ()
| This function is (or should be, in case of custom controls) called during window creation to intelligently set up the window visual attributes, that is the font and the foreground and background colours. More...
virtual void | InitDialog ()
| Sends an `wxEVT_INIT_DIALOG` event, whose handler usually transfers data to the dialog via validators. More...
virtual bool | IsDoubleBuffered () const
| Returns true if the window contents is double-buffered by the system, i.e. if any drawing done on the window is really done on a temporary backing surface and transferred to the screen all at once later. More...
void | SetDoubleBuffered (bool on)
| Turn on or off double buffering of the window if the system supports it. More...
virtual bool | IsRetained () const
| Returns true if the window is retained, false otherwise. More...
bool | IsThisEnabled () const
| Returns true if this window is intrinsically enabled, false otherwise, i.e. if Enable() Enable(false) had been called. More...
virtual bool | IsTopLevel () const
| Returns true if the given window is a top-level one. More...
virtual void | OnInternalIdle ()
| This virtual function is normally only used internally, but sometimes an application may need it to implement functionality that should not be disabled by an application defining an OnIdle handler in a derived class. More...
virtual bool | SendIdleEvents (wxIdleEvent &event)
| Send idle event to window and all subwindows. More...
virtual bool | RegisterHotKey (int hotkeyId, int modifiers, int virtualKeyCode)
| Registers a system wide hotkey. More...
virtual bool | UnregisterHotKey (int hotkeyId)
| Unregisters a system wide hotkey. More...
virtual void | UpdateWindowUI (long flags=wxUPDATE_UI_NONE)
| This function sends one or more wxUpdateUIEvent to the window. More...
Public Member Functions inherited from wxEvtHandler
| wxEvtHandler ()
| Constructor. More...
virtual | ~wxEvtHandler ()
| Destructor. More...
template<typename T , typename T1 , ... >
void | CallAfter (void(T::*method)(T1,...), T1 x1,...)
| Asynchronously call the given method. More...
template<typename T >
void | CallAfter (const T &functor)
| Asynchronously call the given functor. More...
bool | ProcessEventLocally (wxEvent &event)
| Try to process the event in this handler and all those chained to it. More...
bool | SafelyProcessEvent (wxEvent &event)
| Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process. More...
void | ProcessPendingEvents ()
| Processes the pending events previously queued using QueueEvent() or AddPendingEvent(); you must call this function only if you are sure there are pending events for this handler, otherwise a `wxCHECK` will fail. More...
void | DeletePendingEvents ()
| Deletes all events queued on this event handler using QueueEvent() or AddPendingEvent(). More...
virtual bool | SearchEventTable (wxEventTable &table, wxEvent &event)
| Searches the event table, executing an event handler function if an appropriate one is found. More...
void | Connect (int id, int lastId, wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
| Connects the given function dynamically with the event handler, id and event type. More...
void | Connect (int id, wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
| See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info. More...
void | Connect (wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
| See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info. More...
bool | Disconnect (wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
| Disconnects the given function dynamically from the event handler, using the specified parameters as search criteria and returning true if a matching function has been found and removed. More...
bool | Disconnect (int id=wxID_ANY, wxEventType eventType=wxEVT_NULL, wxObjectEventFunction function=NULL, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
| See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info. More...
bool | Disconnect (int id, int lastId, wxEventType eventType, wxObjectEventFunction function=NULL, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
| See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info. More...
template<typename EventTag , typename Functor >
void | Bind (const EventTag &eventType, Functor functor, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
| Binds the given function, functor or method dynamically with the event. More...
template<typename EventTag , typename Class , typename EventArg , typename EventHandler >
void | Bind (const EventTag &eventType, void(Class::*method)(EventArg &), EventHandler *handler, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
| See the Bind<>(const EventTag&, Functor, int, int, wxObject*) overload for more info. More...
template<typename EventTag , typename Functor >
bool | Unbind (const EventTag &eventType, Functor functor, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
| Unbinds the given function, functor or method dynamically from the event handler, using the specified parameters as search criteria and returning true if a matching function has been found and removed. More...
template<typename EventTag , typename Class , typename EventArg , typename EventHandler >
bool | Unbind (const EventTag &eventType, void(Class::*method)(EventArg &), EventHandler *handler, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
| See the Unbind<>(const EventTag&, Functor, int, int, wxObject*) overload for more info. More...
void * | GetClientData () const
| Returns user-supplied client data. More...
wxClientData * | GetClientObject () const
| Returns a pointer to the user-supplied client data object. More...
void | SetClientData (void *data)
| Sets user-supplied client data. More...
void | SetClientObject (wxClientData *data)
| Set the client data object. More...
bool | GetEvtHandlerEnabled () const
| Returns true if the event handler is enabled, false otherwise. More...
wxEvtHandler * | GetNextHandler () const
| Returns the pointer to the next handler in the chain. More...
wxEvtHandler * | GetPreviousHandler () const
| Returns the pointer to the previous handler in the chain. More...
void | SetEvtHandlerEnabled (bool enabled)
| Enables or disables the event handler. More...
void | Unlink ()
| Unlinks this event handler from the chain it's part of (if any); then links the "previous" event handler to the "next" one (so that the chain won't be interrupted). More...
bool | IsUnlinked () const
| Returns true if the next and the previous handler pointers of this event handler instance are NULL. More...
Public Member Functions inherited from wxObject
| wxObject ()
| Default ctor; initializes to NULL the internal reference data. More...
| wxObject (const wxObject &other)
| Copy ctor. More...
virtual | ~wxObject ()
| Destructor. More...
virtual wxClassInfo * | GetClassInfo () const
| This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
wxObjectRefData * | GetRefData () const
| Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
bool | IsKindOf (const wxClassInfo *info) const
| Determines whether this class is a subclass of (or the same class as) the given class. More...
bool | IsSameAs (const wxObject &obj) const
| Returns true if this object has the same data pointer as obj. More...
void | Ref (const wxObject &clone)
| Makes this object refer to the data in clone. More...
void | SetRefData (wxObjectRefData *data)
| Sets the wxObject::m_refData pointer. More...
void | UnRef ()
| Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
void | UnShare ()
| This is the same of AllocExclusive() but this method is public. More...
void | operator delete (void *buf)
| The delete operator is defined for debugging versions of the library only, when the identifier `WXDEBUG` is defined. More...
void * | operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
| The new operator is defined for debugging versions of the library only, when the identifier `WXDEBUG` is defined. More...
Public Member Functions inherited from wxPropertyGridInterface
virtual | ~wxPropertyGridInterface ()
| Destructor. More...
wxPGProperty * | Append (wxPGProperty *property)
| Appends property to the list. More...
wxPGProperty * | AppendIn (wxPGPropArg id, wxPGProperty *newProperty)
| Same as Append(), but appends under given parent property. More...
void | BeginAddChildren (wxPGPropArg id)
| In order to add new items into a property with private children (for instance, wxFlagsProperty), you need to call this method. More...
bool | ClearSelection (bool validation=false)
| Clears current selection, if any. More...
void | ClearModifiedStatus ()
| Resets modified status of all properties. More...
bool | Collapse (wxPGPropArg id)
| Collapses given category or property with children. More...
bool | CollapseAll ()
| Collapses all items that can be collapsed. More...
bool | ChangePropertyValue (wxPGPropArg id, wxVariant newValue)
| Changes value of a property, as if by user. More...
void | DeleteProperty (wxPGPropArg id)
| Removes and deletes a property and any children. More...
bool | DisableProperty (wxPGPropArg id)
| Disables a property. More...
bool | EditorValidate ()
| Returns true if all property grid data changes have been committed. More...
bool | EnableProperty (wxPGPropArg id, bool enable=true)
| Enables or disables property. More...
void | EndAddChildren (wxPGPropArg id)
| Called after population of property with fixed children has finished. More...
bool | Expand (wxPGPropArg id)
| Expands given category or property with children. More...
bool | ExpandAll (bool expand=true)
| Expands all items that can be expanded. More...
int | GetColumnProportion (unsigned int column) const
| Returns auto-resize proportion of the given column. More...
wxPGProperty * | GetFirstChild (wxPGPropArg id)
| Returns id of first child of given property. More...
wxPGProperty * | GetFirst (int flags=wxPG_ITERATE_ALL)
| Returns id of first item that matches given criteria. More...
wxPGProperty * | GetProperty (const wxString &name) const
| Returns pointer to a property with given name (case-sensitive). 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...
wxVariant | GetPropertyAttribute (wxPGPropArg id, const wxString &attrName) const
| Returns value of given attribute. More...
wxColour | GetPropertyBackgroundColour (wxPGPropArg id) const
| Returns background colour of first cell of a property. More...
wxPropertyCategory * | GetPropertyCategory (wxPGPropArg id) const
| Returns pointer of property's nearest parent category. More...
void * | GetPropertyClientData (wxPGPropArg id) const
| Returns client data (void*) of a property. More...
wxPGProperty * | GetPropertyByLabel (const wxString &label) const
| Returns first property which label matches given string. More...
wxPGProperty * | GetPropertyByName (const wxString &name) const
| Returns pointer to a property with given name (case-sensitive). More...
wxPGProperty * | GetPropertyByName (const wxString &name, const wxString &subname) const
| Returns child property 'subname' of property 'name'. More...
const wxPGEditor * | GetPropertyEditor (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...
const wxString & | GetPropertyLabel (wxPGPropArg id)
| Returns label of a property. More...
wxString | GetPropertyName (wxPGProperty *property)
| Returns property's name, by which it is globally accessible. More...
wxColour | GetPropertyTextColour (wxPGPropArg id) const
| Returns text colour of first cell of a property. More...
wxValidator * | GetPropertyValidator (wxPGPropArg id)
| Returns validator of a property as a reference, which you can pass to any number of SetPropertyValidator. More...
wxVariant | GetPropertyValue (wxPGPropArg id)
| Returns property's value as wxVariant. More...
wxArrayInt | GetPropertyValueAsArrayInt (wxPGPropArg id) const
| Return's property's value as wxArrayInt. More...
wxArrayString | GetPropertyValueAsArrayString (wxPGPropArg id) const
| Returns property's value as wxArrayString. More...
bool | GetPropertyValueAsBool (wxPGPropArg id) const
| Returns property's value as bool. More...
wxDateTime | GetPropertyValueAsDateTime (wxPGPropArg id) const
| Return's property's value as wxDateTime. More...
double | GetPropertyValueAsDouble (wxPGPropArg id) const
| Returns property's value as double-precision floating point number. More...
int | GetPropertyValueAsInt (wxPGPropArg id) const
| Returns property's value as integer. More...
long | GetPropertyValueAsLong (wxPGPropArg id) const
| Returns property's value as integer. More...
wxLongLong_t | GetPropertyValueAsLongLong (wxPGPropArg id) const
| Returns property's value as native signed 64-bit integer. More...
wxString | GetPropertyValueAsString (wxPGPropArg id) const
| Returns property's value as wxString. More...
unsigned long | GetPropertyValueAsULong (wxPGPropArg id) const
| Returns property's value as unsigned integer. More...
wxULongLong_t | GetPropertyValueAsULongLong (wxPGPropArg id) const
| Returns property's value as native unsigned 64-bit integer. More...
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...
const wxArrayPGProperty & | GetSelectedProperties () const
| Returns list of currently selected properties. More...
wxPGProperty * | GetSelection () const
| Returns currently selected property. More...
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. More...
bool | HideProperty (wxPGPropArg id, bool hide=true, int flags=wxPG_RECURSE)
| Hides or reveals a property. More...
wxPGProperty * | Insert (wxPGPropArg priorThis, wxPGProperty *newProperty)
| Inserts property to the property container. More...
wxPGProperty * | Insert (wxPGPropArg parent, int index, wxPGProperty *newProperty)
| Inserts property to the property container. 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 | IsPropertyModified (wxPGPropArg id) const
| Returns true if property has been modified after value set or modify flag clear by software. More...
bool | IsPropertySelected (wxPGPropArg id) const
| Returns true if property is selected. More...
bool | IsPropertyShown (wxPGPropArg id) const
| Returns true if property is shown (ie. More...
bool | IsPropertyValueUnspecified (wxPGPropArg id) const
| Returns true if property value is set to unspecified. 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. More...
wxPGProperty * | RemoveProperty (wxPGPropArg id)
| Removes a property. More...
wxPGProperty * | ReplaceProperty (wxPGPropArg id, wxPGProperty *property)
| Replaces property with id with newly created one. 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 | SetPropertyAttribute (wxPGPropArg id, const wxString &attrName, wxVariant value, long argFlags=0)
| Sets an attribute for this property. More...
void | SetPropertyAttributeAll (const wxString &attrName, wxVariant value)
| Sets property attribute for all applicapple properties. More...
void | SetPropertyBackgroundColour (wxPGPropArg id, const wxColour &colour, int flags=wxPG_RECURSE)
| Sets background colour of a property. More...
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 | SetPropertyClientData (wxPGPropArg id, void *clientData)
| Sets client data (void*) of a property. More...
void | SetPropertyColoursToDefault (wxPGPropArg id)
| Resets text and background colours of given property. More...
void | SetPropertyEditor (wxPGPropArg id, const wxPGEditor *editor)
| Sets editor for a property. More...
void | SetPropertyEditor (wxPGPropArg id, const wxString &editorName)
| Sets editor control of a property. More...
void | SetPropertyLabel (wxPGPropArg id, const wxString &newproplabel)
| Sets label of a property. More...
void | SetPropertyName (wxPGPropArg id, const wxString &newName)
| Sets name of a property. More...
void | SetPropertyReadOnly (wxPGPropArg id, bool set=true, int flags=wxPG_RECURSE)
| Sets property (and, recursively, its children) to have read-only value. More...
void | SetPropertyValueUnspecified (wxPGPropArg id)
| Sets property's value to unspecified. More...
void | SetPropertyValues (const wxVariantList &list, wxPGPropArg defaultCategory=wxNullProperty)
| Sets property values from a list of wxVariants. More...
void | SetPropertyValues (const wxVariant &list, wxPGPropArg defaultCategory=wxNullProperty)
| Sets property values from a list of wxVariants. 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...
bool | SetPropertyMaxLength (wxPGPropArg id, int maxLen)
| Sets max length of property's text. More...
void | SetPropertyTextColour (wxPGPropArg id, const wxColour &colour, int flags=wxPG_RECURSE)
| Sets text colour of a property. More...
void | SetPropertyValidator (wxPGPropArg id, const wxValidator &validator)
| Sets validator of a property. More...
void | SetPropertyValue (wxPGPropArg id, long value)
| Sets value (integer) of a property. More...
void | SetPropertyValue (wxPGPropArg id, int value)
| Sets value (integer) of a property. More...
void | SetPropertyValue (wxPGPropArg id, double value)
| Sets value (floating point) of a property. More...
void | SetPropertyValue (wxPGPropArg id, bool value)
| Sets value (bool) of a property. More...
void | SetPropertyValue (wxPGPropArg id, const wxString &value)
| Sets value (string) of a property. More...
void | SetPropertyValue (wxPGPropArg id, const wxArrayString &value)
| Sets value (wxArrayString) of a property. More...
void | SetPropertyValue (wxPGPropArg id, const wxDateTime &value)
| Sets value (wxDateTime) of a property. More...
void | SetPropertyValue (wxPGPropArg id, wxObject *value)
| Sets value (wxObject*) of a property. More...
void | SetPropertyValue (wxPGPropArg id, wxObject &value)
| Sets value (wxObject&) of a property. More...
void | SetPropertyValue (wxPGPropArg id, wxLongLong_t value)
| Sets value (native 64-bit int) of a property. More...
void | SetPropertyValue (wxPGPropArg id, wxULongLong_t value)
| Sets value (native 64-bit unsigned int) of a property. More...
void | SetPropertyValue (wxPGPropArg id, const wxArrayInt &value)
| Sets value (wxArrayInt&) of a property. More...
void | SetPropertyValueString (wxPGPropArg id, const wxString &value)
| Sets value (wxString) of a property. More...
void | SetPropertyValue (wxPGPropArg id, wxVariant value)
| Sets value (wxVariant&) of a property. More...
void | SetValidationFailureBehavior (int vfbFlags)
| Adjusts how wxPropertyGrid behaves when invalid value is entered in a property. More...
void | Sort (int flags=0)
| Sorts all properties recursively. More...
void | SortChildren (wxPGPropArg id, int flags=0)
| Sorts children of a 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
| Returns iterator class instance. More...
wxPropertyGridIterator | GetIterator (int flags, int startPos)
| Returns iterator class instance. More...
wxPropertyGridConstIterator | GetIterator (int flags, int startPos) const
| Returns iterator class instance. More...

## Static Public Member Functions

static void | AutoGetTranslation (bool enable)
| This static function enables or disables automatic use of wxGetTranslation() for following strings: wxEnumProperty list labels, wxFlagsProperty child property labels. More...
static wxPGEditor * | RegisterEditorClass (wxPGEditor *editor, bool noDefCheck=false)
| Forwards to DoRegisterEditorClass with empty name. More...
static wxPGEditor * | DoRegisterEditorClass (wxPGEditor *editor, const wxString &name, bool noDefCheck=false)
| Registers a new editor class. More...
Static Public Member Functions inherited from wxControl
static wxString | GetLabelText (const wxString &label)
| Returns the given label string without mnemonics ("&" characters). More...
static wxString | RemoveMnemonics (const wxString &str)
| Returns the given str string without mnemonics ("&" characters). More...
static wxString | EscapeMnemonics (const wxString &text)
| Escapes the special mnemonics characters ("&") in the given string. More...
static wxString | Ellipsize (const wxString &label, const wxDC &dc, wxEllipsizeMode mode, int maxWidth, int flags=wxELLIPSIZE_FLAGS_DEFAULT)
| Replaces parts of the label string with ellipsis, if needed, so that it fits into maxWidth pixels if possible. More...
Static Public Member Functions inherited from wxWindow
static wxVisualAttributes | GetClassDefaultAttributes (wxWindowVariant variant=wxWINDOW_VARIANT_NORMAL)
| Returns the default font and colours which are used by the control. More...
static wxWindow * | FindFocus ()
| Finds the window or control which currently has the keyboard focus. More...
static wxWindow * | FindWindowById (long id, const wxWindow *parent=0)
| Find the first window with the given id. More...
static wxWindow * | FindWindowByLabel (const wxString &label, const wxWindow *parent=0)
| Find a window by its label. More...
static wxWindow * | FindWindowByName (const wxString &name, const wxWindow *parent=0)
| Find a window by its name (as given in a window constructor or Create() function call). More...
static wxWindow * | GetCapture ()
| Returns the currently captured window. More...
static wxWindowID | NewControlId (int count=1)
| Create a new ID or range of IDs that are not currently in use. More...
static void | UnreserveControlId (wxWindowID id, int count=1)
| Unreserve an ID or range of IDs that was reserved by NewControlId(). More...
Static Public Member Functions inherited from wxEvtHandler
static void | AddFilter (wxEventFilter *filter)
| Add an event filter whose FilterEvent() method will be called for each and every event processed by wxWidgets. More...
static void | RemoveFilter (wxEventFilter *filter)
| Remove a filter previously installed with AddFilter(). More...
Static Public Member Functions inherited from wxPropertyGridInterface
static void | InitAllTypeHandlers ()
| Initializes all property types. More...
static void | RegisterAdditionalEditors ()
| Initializes additional property editors (SpinCtrl etc.). More...
static void | SetBoolChoices (const wxString &trueChoice, const wxString &falseChoice)
| Sets strings listed in the choice dropdown of a wxBoolProperty. More...
static wxPGEditor * | GetEditorByName (const wxString &editorName)
| Returns editor pointer of editor with given name;. More...

## Additional Inherited Members

Public Types inherited from wxPropertyGridInterface
enum | EditableStateFlags { SelectionState = 0x01, ExpandedState = 0x02, ScrollPosState = 0x04, PageState = 0x08, SplitterPosState = 0x10, DescBoxState = 0x20, AllStates }
Protected Member Functions inherited from wxWindow
virtual void | DoCentre (int direction)
| Centres the window. More...
virtual wxSize | DoGetBestSize () const
| Implementation of GetBestSize() that can be overridden. More...
virtual wxSize | DoGetBestClientSize () const
| Override this method to return the best size for a custom control. More...
virtual int | DoGetBestClientHeight (int width) const
| Override this method to implement height-for-width best size calculation. More...
virtual int | DoGetBestClientWidth (int height) const
| Override this method to implement width-for-height best size calculation. More...
virtual void | SetInitialBestSize (const wxSize &size)
| Sets the initial window size if none is given (i.e. at least one of the components of the size passed to ctor/Create() is wxDefaultCoord). More...
void | SendDestroyEvent ()
| Generate wxWindowDestroyEvent for this window. More...
virtual bool | ProcessEvent (wxEvent &event)
| This function is public in wxEvtHandler but protected in wxWindow because for wxWindows you should always call ProcessEvent() on the pointer returned by GetEventHandler() and not on the wxWindow object itself. More...
bool | SafelyProcessEvent (wxEvent &event)
| See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow. More...
virtual void | QueueEvent (wxEvent *event)
| See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow. More...
virtual void | AddPendingEvent (const wxEvent &event)
| See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow. More...
void | ProcessPendingEvents ()
| See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow. More...
bool | ProcessThreadEvent (const wxEvent &event)
| See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow. More...
Protected Member Functions inherited from wxEvtHandler
virtual bool | TryBefore (wxEvent &event)
| Method called by ProcessEvent() before examining this object event tables. More...
virtual bool | TryAfter (wxEvent &event)
| Method called by ProcessEvent() as last resort. More...
Protected Member Functions inherited from wxObject
void | AllocExclusive ()
| Ensure that this object's data is not shared with any other object. More...
virtual wxObjectRefData * | CreateRefData () const
| Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More...
virtual wxObjectRefData * | CloneRefData (const wxObjectRefData *data) const
| Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More...
Protected Attributes inherited from wxObject
wxObjectRefData * | m_refData
| Pointer to an object which is the object's reference-counted data. More...

## Constructor & Destructor Documentation

wxPropertyGrid::wxPropertyGrid | ( |  | ) |

Two step constructor.

Call Create() when this constructor is called to build up the wxPropertyGrid

wxPropertyGrid::wxPropertyGrid | ( | wxWindow * | parent,
|  | wxWindowID | id = `wxID_ANY`,
|  | const wxPoint & | pos = `wxDefaultPosition`,
|  | const wxSize & | size = `wxDefaultSize`,
|  | long | style = `wxPG_DEFAULT_STYLE`,
|  | const wxString & | name = `wxPropertyGridNameStr`
| ) |  |

Constructor.

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

See also
  wxPropertyGrid Window Styles.

virtual wxPropertyGrid::~wxPropertyGrid | ( |  | ) |

virtual

Destructor.

## Member Function Documentation

void wxPropertyGrid::AddActionTrigger | ( | int | action,
|  | int | keycode,
|  | int | modifiers = `0`
| ) |  |

Adds given key combination to trigger given action.

Here is a sample code to make Enter key press move focus to the next property.

propGrid->AddActionTrigger(wxPG_ACTION_NEXT_PROPERTY,
WXK_RETURN);
propGrid->DedicateKey(WXK_RETURN);

Parameters

  action | Which action to trigger. See wxPropertyGrid Action Identifiers.
  keycode | Which keycode triggers the action.
  modifiers | Which key event modifiers, in addition to keycode, are needed to trigger the action.

bool wxPropertyGrid::AddToSelection | ( | wxPGPropArg | id | ) |

Adds given property into selection.

If wxPG_EX_MULTIPLE_SELECTION extra style is not used, then this has same effect as calling SelectProperty().

Remarks
  Multiple selection is not supported for categories. This means that if you have properties selected, you cannot add category to selection, and also if you have category selected, you cannot add other properties to selection. This member function will fail silently in these cases, even returning true.

static void wxPropertyGrid::AutoGetTranslation | ( | bool | enable | ) |

static

This static function enables or disables automatic use of wxGetTranslation() for following strings: wxEnumProperty list labels, wxFlagsProperty child property labels.

Default is false.

void wxPropertyGrid::BeginLabelEdit | ( | unsigned int | colIndex = `0` | ) |

Creates label editor wxTextCtrl for given column, for property that is currently selected.

When multiple selection is enabled, this applies to whatever property GetSelection() returns.

Parameters

  colIndex | Which column's label to edit. Note that you should not use value 1, which is reserved for property value column.

See also
  EndLabelEdit(), MakeColumnEditable()

void wxPropertyGrid::CenterSplitter | ( | bool | enableAutoResizing = `false` | ) |

Centers the splitter.

Parameters

  enableAutoResizing | If true, automatic column resizing is enabled (only applicapple if window style wxPG_SPLITTER_AUTO_CENTER is used).

bool wxPropertyGrid::ChangePropertyValue | ( | wxPGPropArg | id,
|  | wxVariant | newValue
| ) |  |

Changes value of a property, as if from an editor.

Use this instead of SetPropertyValue() if you need the value to run through validation process, and also send the property change event.

Returns
  Returns true if value was successfully changed.

virtual void wxPropertyGrid::Clear | ( |  | ) |

virtual

Deletes all properties.

Implements wxPropertyGridInterface.

void wxPropertyGrid::ClearActionTriggers | ( | int | action | ) |

Clears action triggers for given action.

Parameters

  action | Which action to trigger. wxPropertyGrid Action Identifiers.

virtual bool wxPropertyGrid::CommitChangesFromEditor | ( | wxUint32 | flags = `0` | ) |

virtual

Forces updating the value of property from the editor control.

Note that `wxEVT_PG_CHANGING` and `wxEVT_PG_CHANGED` are dispatched using ProcessEvent, meaning your event handlers will be called immediately.

Returns
  Returns true if anything was changed.

bool wxPropertyGrid::Create | ( | wxWindow * | parent,
|  | wxWindowID | id = `wxID_ANY`,
|  | const wxPoint & | pos = `wxDefaultPosition`,
|  | const wxSize & | size = `wxDefaultSize`,
|  | long | style = `wxPG_DEFAULT_STYLE`,
|  | const wxString & | name = `wxPropertyGridNameStr`
| ) |  |

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
  wxPropertyGrid Window Styles.

void wxPropertyGrid::DedicateKey | ( | int | keycode | ) |

Dedicates a specific keycode to wxPropertyGrid.

This means that such key presses will not be redirected to editor controls.

Using this function allows, for example, navigation between properties using arrow keys even when the focus is in the editor control.

virtual void wxPropertyGrid::DoHidePropertyError | ( | wxPGProperty * | property | ) |

virtual

Override in derived class to hide an error displayed by DoShowPropertyError().

See also
  DoShowPropertyError()

static wxPGEditor* wxPropertyGrid::DoRegisterEditorClass | ( | wxPGEditor * | editor,
|  | const wxString & | name,
|  | bool | noDefCheck = `false`
| ) |  |

static

Registers a new editor class.

Returns
  Returns pointer to the editor class instance that should be used.

virtual void wxPropertyGrid::DoShowPropertyError | ( | wxPGProperty * | property,
|  | const wxString & | msg
| ) |  |

virtual

Override in derived class to display error messages in custom manner (these message usually only result from validation failure).

Remarks
  If you implement this, then you also need to implement DoHidePropertyError() - possibly to do nothing, if error does not need hiding (e.g. it was logged or shown in a message box).

See also
  DoHidePropertyError()

void wxPropertyGrid::EditorsValueWasModified | ( |  | ) |

Call when editor widget's contents is modified.

For example, this is called when changes text in wxTextCtrl (used in wxStringProperty and wxIntProperty).

Remarks
  This function should only be called by custom properties.

See also
  wxPGProperty::OnEvent()

void wxPropertyGrid::EditorsValueWasNotModified | ( |  | ) |

Reverse of EditorsValueWasModified().

Remarks
  This function should only be called by custom properties.

bool wxPropertyGrid::EnableCategories | ( | bool | enable | ) |

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

Remarks
  This functions deselects selected property, if any. Validation failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, ie. selection is cleared even if editor had invalid value.

void wxPropertyGrid::EndLabelEdit | ( | bool | commit = `true` | ) |

Destroys label editor wxTextCtrl, if any.

Parameters

  commit | Use true (default) to store edited label text in property cell data.

See also
  BeginLabelEdit(), MakeColumnEditable()

bool wxPropertyGrid::EnsureVisible | ( | wxPGPropArg | id | ) |

Scrolls and/or expands items to ensure that the given item is visible.

Returns
  Returns true if something was actually done.

wxSize wxPropertyGrid::FitColumns | ( |  | ) |

Reduces column sizes to minimum possible, while still retaining fully visible grid contents (labels, images).

Returns
  Minimum size for the grid to still display everything.

Remarks
  Does not work well with wxPG_SPLITTER_AUTO_CENTER window style.

          This function only works properly if grid size prior to call was
          already fairly large.

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

wxColour wxPropertyGrid::GetCaptionBackgroundColour | ( |  | ) | const

Returns current category caption background colour.

wxFont& wxPropertyGrid::GetCaptionFont | ( |  | ) |

Returns current category caption font.

wxColour wxPropertyGrid::GetCaptionForegroundColour | ( |  | ) | const

Returns current category caption text colour.

wxColour wxPropertyGrid::GetCellBackgroundColour | ( |  | ) | const

Returns current cell background colour.

wxColour wxPropertyGrid::GetCellDisabledTextColour | ( |  | ) | const

Returns current cell text colour when disabled.

wxColour wxPropertyGrid::GetCellTextColour | ( |  | ) | const

Returns current cell text colour.

unsigned int wxPropertyGrid::GetColumnCount | ( |  | ) | const

Returns number of columns currently on grid.

wxTextCtrl* wxPropertyGrid::GetEditorTextCtrl | ( |  | ) | const

Returns wxTextCtrl active in currently selected property, if any.

Takes wxOwnerDrawnComboBox into account.

wxColour wxPropertyGrid::GetEmptySpaceColour | ( |  | ) | const

Returns colour of empty space below properties.

int wxPropertyGrid::GetFontHeight | ( |  | ) | const

Returns height of highest characters of used font.

wxPropertyGrid* wxPropertyGrid::GetGrid | ( |  | ) |

Returns pointer to itself.

Dummy function that enables same kind of code to use wxPropertyGrid and wxPropertyGridManager.

wxRect wxPropertyGrid::GetImageRect | ( | wxPGProperty * | property,
|  | int | item
| ) |  | const

Returns rectangle of custom paint image.

Parameters

  property | Return image rectangle for this property.
  item | Which choice of property to use (each choice may have different image).

wxSize wxPropertyGrid::GetImageSize | ( | wxPGProperty * | property = `NULL`,
|  | int | item = `-1`
| ) |  | const

Returns size of the custom paint image in front of property.

Parameters

  property | Return image rectangle for this property. If this argument is NULL, then preferred size is returned.
  item | Which choice of property to use (each choice may have different image).

wxTextCtrl* wxPropertyGrid::GetLabelEditor | ( |  | ) | const

Returns currently active label editor, NULL if none.

wxPGProperty* wxPropertyGrid::GetLastItem | ( | int | flags = `wxPG_ITERATE_DEFAULT` | ) |

Returns last item which could be iterated using given flags.

Parameters

  flags | See wxPropertyGridIterator Flags.

wxColour wxPropertyGrid::GetLineColour | ( |  | ) | const

Returns colour of lines between cells.

wxColour wxPropertyGrid::GetMarginColour | ( |  | ) | const

Returns background colour of margin.

wxWindow* wxPropertyGrid::GetPanel | ( |  | ) |

Returns wxWindow that the properties are painted on, and which should be used as the parent for editor controls.

wxPGProperty* wxPropertyGrid::GetRoot | ( |  | ) | const

Returns "root property".

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

int wxPropertyGrid::GetRowHeight | ( |  | ) | const

Returns height of a single grid row (in pixels).

wxPGProperty* wxPropertyGrid::GetSelectedProperty | ( |  | ) | const

Returns currently selected property.

wxPGProperty* wxPropertyGrid::GetSelection | ( |  | ) | const

Returns currently selected property.

wxColour wxPropertyGrid::GetSelectionBackgroundColour | ( |  | ) | const

Returns current selection background colour.

wxColour wxPropertyGrid::GetSelectionForegroundColour | ( |  | ) | const

Returns current selection text colour.

wxPGSortCallback wxPropertyGrid::GetSortFunction | ( |  | ) | const

Returns the property sort function (default is NULL).

See also
  SetSortFunction

int wxPropertyGrid::GetSplitterPosition | ( | unsigned int | splitterIndex = `0` | ) | const

Returns current splitter x position.

virtual wxStatusBar* wxPropertyGrid::GetStatusBar | ( |  | ) |

virtual

Return wxStatusBar that is used by this wxPropertyGrid.

You can reimplement this member function in derived class to override the default behaviour of using the top-level wxFrame's status bar, if any.

wxVariant wxPropertyGrid::GetUncommittedPropertyValue | ( |  | ) |

Returns most up-to-date value of selected property.

This will return value different from GetSelectedProperty()->GetValue() only when text editor is activate and string edited by user represents valid, uncommitted property value.

const wxPGCell& wxPropertyGrid::GetUnspecifiedValueAppearance | ( |  | ) | const

Returns current appearance of unspecified value cells.

See also
  SetUnspecifiedValueAppearance()

wxString wxPropertyGrid::GetUnspecifiedValueText | ( | int | argFlags = `0` | ) | const

Returns (visual) text representation of the unspecified property value.

Parameters

  argFlags | For internal use only.

int wxPropertyGrid::GetVerticalSpacing | ( |  | ) | const

Returns current vertical spacing.

wxPropertyGridHitTestResult wxPropertyGrid::HitTest | ( | const wxPoint & | pt | ) | const

Returns information about arbitrary position in the grid.

Parameters

  pt | Coordinates in the virtual grid space. You may need to use wxScrolled<T>::CalcScrolledPosition() for translating wxPropertyGrid client coordinates into something this member function can use.

bool wxPropertyGrid::IsAnyModified | ( |  | ) | const

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

bool wxPropertyGrid::IsEditorFocused | ( |  | ) | const

Returns true if a property editor control has focus.

bool wxPropertyGrid::IsEditorsValueModified | ( |  | ) | const

Returns true if editor's value was marked modified.

bool wxPropertyGrid::IsFrozen | ( |  | ) | const

Returns true if updating is frozen (ie.

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

void wxPropertyGrid::MakeColumnEditable | ( | unsigned int | column,
|  | bool | editable = `true`
| ) |  |

Makes given column editable by user.

Parameters

  column | The index of the column to make editable.
  editable | Using false here will disable column from being editable.

Note that column must not be equal to 1, as the second column is always editable and can be made read-only only on cell-by-cell basis using

wxPGProperty::ChangeFlag(wxPG_PROP_READONLY, true)

See also
  BeginLabelEdit(), EndLabelEdit()

void wxPropertyGrid::OnTLPChanging | ( | wxWindow * | newTLP | ) |

It is recommended that you call this function any time your code causes wxPropertyGrid's top-level parent to change.

wxPropertyGrid's OnIdle() handler should be able to detect most changes, but it is not perfect.

Parameters

  newTLP | New top-level parent that is about to be set. Old top-level parent window should still exist as the current one.

Remarks
  This function is automatically called from wxPropertyGrid:: Reparent() and wxPropertyGridManager::Reparent(). You only need to use it if you reparent wxPropertyGrid indirectly.

void wxPropertyGrid::RefreshEditor | ( |  | ) |

Refreshes any active editor control.

virtual void wxPropertyGrid::RefreshProperty | ( | wxPGProperty * | p | ) |

virtual

Redraws given property.

static wxPGEditor* wxPropertyGrid::RegisterEditorClass | ( | wxPGEditor * | editor,
|  | bool | noDefCheck = `false`
| ) |  |

static

Forwards to DoRegisterEditorClass with empty name.

bool wxPropertyGrid::RemoveFromSelection | ( | wxPGPropArg | id | ) |

Removes given property from selection.

If property is not selected, an assertion failure will occur.

void wxPropertyGrid::ResetColours | ( |  | ) |

Resets all colours to the original system values.

void wxPropertyGrid::ResetColumnSizes | ( | bool | enableAutoResizing = `false` | ) |

Resets column sizes and splitter positions, based on proportions.

Parameters

  enableAutoResizing | If true, automatic column resizing is enabled (only applicapple if window style wxPG_SPLITTER_AUTO_CENTER is used).

See also
  wxPropertyGridInterface::SetColumnProportion()

bool wxPropertyGrid::SelectProperty | ( | wxPGPropArg | id,
|  | bool | focus = `false`
| ) |  |

Selects a property.

Editor widget is automatically created, but not focused unless focus is true.

Parameters

  id | Property to select (name or pointer).
  focus | If true, move keyboard focus to the created editor right away.

Returns
  returns true if selection finished successfully. Usually only fails if current value in editor is not valid.

Remarks
  In wxPropertyGrid 1.4, this member function used to generate `wxEVT_PG_SELECTED`. In wxWidgets 2.9 and later, it no longer does that.
  This clears any previous selection.

See also
  wxPropertyGridInterface::ClearSelection()

void wxPropertyGrid::SetCaptionBackgroundColour | ( | const wxColour & | col | ) |

Sets category caption background colour.

void wxPropertyGrid::SetCaptionTextColour | ( | const wxColour & | col | ) |

Sets category caption text colour.

void wxPropertyGrid::SetCellBackgroundColour | ( | const wxColour & | col | ) |

Sets default cell background colour - applies to property cells.

Note that appearance of editor widgets may not be affected.

void wxPropertyGrid::SetCellDisabledTextColour | ( | const wxColour & | col | ) |

Sets cell text colour for disabled properties.

void wxPropertyGrid::SetCellTextColour | ( | const wxColour & | col | ) |

Sets default cell text colour - applies to property name and value text.

Note that appearance of editor widgets may not be affected.

void wxPropertyGrid::SetColumnCount | ( | int | colCount | ) |

Set number of columns (2 or more).

void wxPropertyGrid::SetCurrentCategory | ( | wxPGPropArg | id | ) |

Sets the 'current' category - Append will add non-category properties under it.

void wxPropertyGrid::SetEmptySpaceColour | ( | const wxColour & | col | ) |

Sets colour of empty space below properties.

void wxPropertyGrid::SetLineColour | ( | const wxColour & | col | ) |

Sets colour of lines between cells.

void wxPropertyGrid::SetMarginColour | ( | const wxColour & | col | ) |

Sets background colour of margin.

void wxPropertyGrid::SetSelection | ( | const wxArrayPGProperty & | newSelection | ) |

Set entire new selection from given list of properties.

void wxPropertyGrid::SetSelectionBackgroundColour | ( | const wxColour & | col | ) |

Sets selection background colour - applies to selected property name background.

void wxPropertyGrid::SetSelectionTextColour | ( | const wxColour & | col | ) |

Sets selection foreground colour - applies to selected property name text.

void wxPropertyGrid::SetSortFunction | ( | wxPGSortCallback | sortFunction | ) |

Sets the property sorting function.

Parameters

  sortFunction | The sorting function to be used. It should return a value greater than 0 if position of p1 is after p2. So, for instance, when comparing property names, you can use following implementation:

int MyPropertySortFunction(wxPropertyGrid* propGrid,
wxPGProperty* p1,
wxPGProperty* p2)
{
return p1->GetBaseName().compare( p2->GetBaseName() );
}

Remarks
  Default property sort function sorts properties by their labels (case-insensitively).

See also
  GetSortFunction, wxPropertyGridInterface::Sort, wxPropertyGridInterface::SortChildren

void wxPropertyGrid::SetSplitterLeft | ( | bool | privateChildrenToo = `false` | ) |

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

Parameters

  privateChildrenToo | If false, will still allow private children to be cropped.

void wxPropertyGrid::SetSplitterPosition | ( | int | newxpos,
|  | int | col = `0`
| ) |  |

Sets x coordinate of the splitter.

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.

void wxPropertyGrid::SetUnspecifiedValueAppearance | ( | const wxPGCell & | cell | ) |

Sets appearance of value cells representing an unspecified property value.

Default appearance is blank.

Remarks
  If you set the unspecified value to have any textual representation, then that will override "InlineHelp" attribute.

See also
  wxPGProperty::SetValueToUnspecified(), wxPGProperty::IsValueUnspecified()

void wxPropertyGrid::SetVerticalSpacing | ( | int | vspacing | ) |

Sets vertical spacing.

Can be 1, 2, or 3 - a value relative to font height. Value of 2 should be default on most platforms.

void wxPropertyGrid::ShowPropertyError | ( | wxPGPropArg | id,
|  | const wxString & | msg
| ) |  |

Shows an brief error message that is related to a property.

bool wxPropertyGrid::WasValueChangedInEvent | ( |  | ) | const

You can use this member function, for instance, to detect in wxPGProperty::OnEvent() if wxPGProperty::SetValueInEvent() was already called in wxPGEditor::OnEvent().

It really only detects if was value was changed using wxPGProperty::SetValueInEvent(), which is usually used when a 'picker' dialog is displayed. If value was written by "normal means" in wxPGProperty::StringToValue() or IntToValue(), then this function will return false (on the other hand, wxPGProperty::OnEvent() is not even called in those cases).