.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.propgrid.PGEditorDialogAdapter:
==========================================================================================================================================
|phoenix_title| **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.
You only need to derive class and implement :meth:`~wx.propgrid.PGEditorDialogAdapter.DoShowDialog` to create and show the dialog, and finally submit the value returned by the dialog via :meth:`~wx.propgrid.PGEditorDialogAdapter.SetValue`.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
PGEditorDialogAdapter:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.propgrid.PGEditorDialogAdapter.__init__`
:meth:`~wx.propgrid.PGEditorDialogAdapter.DoShowDialog`
:meth:`~wx.propgrid.PGEditorDialogAdapter.GetValue` This method is typically only used if deriving class from existing adapter with value conversion purposes.
:meth:`~wx.propgrid.PGEditorDialogAdapter.SetValue`
:meth:`~wx.propgrid.PGEditorDialogAdapter.ShowDialog`
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.propgrid.PGEditorDialogAdapter.Value` See :meth:`~wx.propgrid.PGEditorDialogAdapter.GetValue` and :meth:`~wx.propgrid.PGEditorDialogAdapter.SetValue`
:attr:`~wx.propgrid.PGEditorDialogAdapter.m_clientData` A public C++ attribute of type ````.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.propgrid.PGEditorDialogAdapter(Object)
**Possible constructors**::
PGEditorDialogAdapter() -> None
Derive a class from this to adapt an existing editor dialog or
function to be used when editor button of a property is pushed.
.. method:: __init__(self)
:rtype: `None`
.. method:: DoShowDialog(self, propGrid : PropertyGrid, property : PGProperty)
:param `propGrid`:
:type `propGrid`: wx.propgrid.PropertyGrid
:param `property`:
:type `property`: wx.propgrid.PGProperty
:rtype: `bool`
.. method:: GetValue(self)
This method is typically only used if deriving class from existing adapter with value conversion purposes.
:rtype: `PGVariant`
.. method:: SetValue(self, value : PGVariant)
:param `value`:
:type `value`: PGVariant
:rtype: `None`
.. method:: ShowDialog(self, propGrid : PropertyGrid, property : PGProperty)
:param `propGrid`:
:type `propGrid`: wx.propgrid.PropertyGrid
:param `property`:
:type `property`: wx.propgrid.PGProperty
:rtype: `bool`
.. attribute:: Value
See :meth:`~wx.propgrid.PGEditorDialogAdapter.GetValue` and :meth:`~wx.propgrid.PGEditorDialogAdapter.SetValue`
.. attribute:: m_clientData
A public C++ attribute of type ````.