.. module:: wx.propgrid


.. include:: headings.inc

=========================================================================
**wx.propgrid**
=========================================================================



Class Summary
=============

================================================================================ ================================================================================
**Class**                                                                        **Short Description**
================================================================================ ================================================================================
`~wx.propgrid.ArrayStringProperty`                                               Property that manages a list of strings.
`~wx.propgrid.BoolProperty`                                                      Basic property with boolean value.
`~wx.propgrid.ColourProperty`                                                    Allows to select a colour from the list or with colour dialog.
`~wx.propgrid.ColourPropertyValue`                                               Because text, background and other colours tend to differ between platforms, :ref:`wx.propgrid.SystemColourProperty`  must be able to select between system colour and, when necessary, to pick a custom one.
`~wx.propgrid.CursorProperty`                                                    Property representing :ref:`wx.Cursor`.
`~wx.propgrid.DateProperty`                                                      Property representing :ref:`wx.DateTime`.
`~wx.propgrid.DirProperty`                                                       Like :ref:`wx.propgrid.LongStringProperty`, but the button triggers directory selector instead.
`~wx.propgrid.EditEnumProperty`                                                  :ref:`wx.propgrid.EnumProperty`  with `String`       value and writable combo box editor.
`~wx.propgrid.EditorDialogProperty`                                              This is an abstract class which serves as a base class for the properties having a button triggering an editor dialog, like e.g.
`~wx.propgrid.EnumProperty`                                                      You can derive custom properties with choices from this class.
`~wx.propgrid.FileProperty`                                                      Like :ref:`wx.propgrid.LongStringProperty`, but the button triggers file selector instead.
`~wx.propgrid.FlagsProperty`                                                     Represents a bit set that fits in a long integer.
`~wx.propgrid.FloatProperty`                                                     Basic property with double-precision floating point value.
`~wx.propgrid.FontProperty`                                                      Property representing :ref:`wx.Font`.
`~wx.propgrid.ImageFileProperty`                                                 Property representing image file(name).
`~wx.propgrid.IntProperty`                                                       Basic property with integer value.
`~wx.propgrid.LongStringProperty`                                                Like :ref:`wx.propgrid.StringProperty`, but has a button that triggers a small text editor dialog.
`~wx.propgrid.MultiChoiceProperty`                                               Property that manages a value resulting from :ref:`wx.MultiChoiceDialog`.
`~wx.propgrid.NumericProperty`                                                   This is an abstract class which serves as a base class for numeric properties, like :ref:`wx.propgrid.IntProperty`, :ref:`wx.propgrid.UIntProperty`, :ref:`wx.propgrid.FloatProperty`.
`~wx.propgrid.NumericPropertyValidator`                                          A more comprehensive numeric validator class.
`~wx.propgrid.PGArrayEditorDialog`                                               
`~wx.propgrid.PGArrayStringEditorDialog`                                         
`~wx.propgrid.PGAttributeStorage`                                                :ref:`wx.propgrid.PGAttributeStorage`  is somewhat optimized storage for key=variant pairs (i.e.
`~wx.propgrid.PGCell`                                                            Base class for :ref:`wx.propgrid.PropertyGrid`  cell information.
`~wx.propgrid.PGCellData`                                                        
`~wx.propgrid.PGCellRenderer`                                                    Base class for :ref:`wx.propgrid.PropertyGrid`  cell renderers.
`~wx.propgrid.PGCheckBoxEditor`                                                  
`~wx.propgrid.PGChoiceAndButtonEditor`                                           
`~wx.propgrid.PGChoiceEditor`                                                    
`~wx.propgrid.PGChoiceEntry`                                                     Data of a single :ref:`wx.propgrid.PGChoices`  choice.
`~wx.propgrid.PGChoices`                                                         Helper class for managing choices of :ref:`wx.propgrid.PropertyGrid`  properties.
`~wx.propgrid.PGChoicesData`                                                     
`~wx.propgrid.PGComboBoxEditor`                                                  
`~wx.propgrid.PGDefaultRenderer`                                                 Default cell renderer, that can handles the common scenarios.
`~wx.propgrid.PGEditor`                                                          Base class for custom :ref:`wx.propgrid.PropertyGrid`  editors.
`~wx.propgrid.PGEditorDialogAdapter`                                             Derive a class from this to adapt an existing editor dialog or function to be used when editor button of a property is pushed.
`~wx.propgrid.PGInDialogValidator`                                               Creates and manages a temporary :ref:`wx.TextCtrl`  for validation purposes.
`~wx.propgrid.PGMultiButton`                                                     This class can be used to have multiple buttons in a property editor.
`~wx.propgrid.PGPaintData`                                                       Contains information related to property's OnCustomPaint.
`~wx.propgrid.PGPropArgCls`                                                      
`~wx.propgrid.PGProperty`                                                        :ref:`wx.propgrid.PGProperty`  is base class for all :ref:`wx.propgrid.PropertyGrid`  properties and as such it is not intended to be instantiated directly.
`~wx.propgrid.PGSpinCtrlEditor`                                                  
`~wx.propgrid.PGTextCtrlAndButtonEditor`                                         
`~wx.propgrid.PGTextCtrlEditor`                                                  
`~wx.propgrid.PGValidationInfo`                                                  Used to convey validation information to and from functions that actually perform validation.
`~wx.propgrid.PGVIterator`                                                       
`~wx.propgrid.PGWindowList`                                                      Contains a list of editor windows returned by CreateControls.
`~wx.propgrid.PropertyCategory`                                                  Category (caption) property.
`~wx.propgrid.PropertyGrid`                                                      :ref:`wx.propgrid.PropertyGrid`  is a specialized grid for editing properties - in other words name = value pairs.
`~wx.propgrid.PropertyGridEvent`                                                 A property grid event holds information about events associated with :ref:`wx.propgrid.PropertyGrid`  objects.
`~wx.propgrid.PropertyGridHitTestResult`                                         
`~wx.propgrid.PropertyGridInterface`                                             Most of the shared property manipulation interface shared by :ref:`wx.propgrid.PropertyGrid`, :ref:`wx.propgrid.PropertyGridPage`, and :ref:`wx.propgrid.PropertyGridManager`  is defined in this class.
`~wx.propgrid.PropertyGridIterator`                                              
`~wx.propgrid.PropertyGridIteratorBase`                                          Base for :ref:`wx.propgrid.PropertyGridIterator`  classes.
`~wx.propgrid.PropertyGridManager`                                               :ref:`wx.propgrid.PropertyGridManager`  is an efficient multi-page version of :ref:`wx.propgrid.PropertyGrid`, which can optionally have toolbar for mode and page selection, a help text box, and a header.
`~wx.propgrid.PropertyGridPage`                                                  Holder of property grid page information.
`~wx.propgrid.PropertyGridPageState`                                             Contains low-level property page information (properties, column widths, etc.) of a single :ref:`wx.propgrid.PropertyGrid`  or single :ref:`wx.propgrid.PropertyGridPage`.
`~wx.propgrid.PropertyGridPopulator`                                             Allows populating :ref:`wx.propgrid.PropertyGrid`  from arbitrary text source.
`~wx.propgrid.StringProperty`                                                    Basic property with string value.
`~wx.propgrid.SystemColourProperty`                                              Has dropdown list of wxWidgets system colours.
`~wx.propgrid.UIntProperty`                                                      Basic property with  integer value.
================================================================================ ================================================================================


Functions Summary
=================

================================================================================ ================================================================================
**Function**                                                                     **Short Description**
================================================================================ ================================================================================
:func:`~wx.propgrid.PGGetDefaultImageWildcard`                                   :rtype: `str`
:func:`~wx.propgrid.RegisterEditor`                                              Use PropertyGrid.DoRegisterEditor instead
================================================================================ ================================================================================


.. toctree::
   :maxdepth: 1
   :hidden:

   wx.propgrid.ArrayStringProperty
   wx.propgrid.BoolProperty
   wx.propgrid.ColourProperty
   wx.propgrid.ColourPropertyValue
   wx.propgrid.CursorProperty
   wx.propgrid.DateProperty
   wx.propgrid.DirProperty
   wx.propgrid.EditEnumProperty
   wx.propgrid.EditorDialogProperty
   wx.propgrid.EnumProperty
   wx.propgrid.FileProperty
   wx.propgrid.FlagsProperty
   wx.propgrid.FloatProperty
   wx.propgrid.FontProperty
   wx.propgrid.ImageFileProperty
   wx.propgrid.IntProperty
   wx.propgrid.LongStringProperty
   wx.propgrid.MultiChoiceProperty
   wx.propgrid.NumericProperty
   wx.propgrid.NumericPropertyValidator
   wx.propgrid.PGArrayEditorDialog
   wx.propgrid.PGArrayStringEditorDialog
   wx.propgrid.PGAttributeStorage
   wx.propgrid.PGCell
   wx.propgrid.PGCellData
   wx.propgrid.PGCellRenderer
   wx.propgrid.PGCheckBoxEditor
   wx.propgrid.PGChoiceAndButtonEditor
   wx.propgrid.PGChoiceEditor
   wx.propgrid.PGChoiceEntry
   wx.propgrid.PGChoices
   wx.propgrid.PGChoicesData
   wx.propgrid.PGComboBoxEditor
   wx.propgrid.PGDefaultRenderer
   wx.propgrid.PGEditor
   wx.propgrid.PGEditorDialogAdapter
   wx.propgrid.PGInDialogValidator
   wx.propgrid.PGMultiButton
   wx.propgrid.PGNumericValidationConstants.enumeration
   wx.propgrid.PGPaintData
   wx.propgrid.PGPropArgCls
   wx.propgrid.PGProperty
   wx.propgrid.PGPropertyFlags.enumeration
   wx.propgrid.PGSpinCtrlEditor
   wx.propgrid.PGTextCtrlAndButtonEditor
   wx.propgrid.PGTextCtrlEditor
   wx.propgrid.PGVIterator
   wx.propgrid.PGValidationInfo
   wx.propgrid.PGWindowList
   wx.propgrid.PG_EX_WINDOW_STYLES.enumeration
   wx.propgrid.PG_GETPROPERTYVALUES_FLAGS.enumeration
   wx.propgrid.PG_ITERATOR_FLAGS.enumeration
   wx.propgrid.PG_KEYBOARD_ACTIONS.enumeration
   wx.propgrid.PG_MISC_ARG_FLAGS.enumeration
   wx.propgrid.PG_SETVALUE_FLAGS.enumeration
   wx.propgrid.PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS.enumeration
   wx.propgrid.PG_WINDOW_STYLES.enumeration
   wx.propgrid.PropertyCategory
   wx.propgrid.PropertyGrid
   wx.propgrid.PropertyGridEvent
   wx.propgrid.PropertyGridHitTestResult
   wx.propgrid.PropertyGridInterface
   wx.propgrid.PropertyGridIterator
   wx.propgrid.PropertyGridIteratorBase
   wx.propgrid.PropertyGridManager
   wx.propgrid.PropertyGridPage
   wx.propgrid.PropertyGridPageState
   wx.propgrid.PropertyGridPopulator
   wx.propgrid.StringProperty
   wx.propgrid.SystemColourProperty
   wx.propgrid.UIntProperty
   wx.propgrid.functions