File: wx.propgrid.PGEditorDialogAdapter.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (191 lines) | stat: -rw-r--r-- 5,239 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2018 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

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>PGEditorDialogAdapter</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.propgrid.PGEditorDialogAdapter_inheritance.png" alt="Inheritance diagram of PGEditorDialogAdapter" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.propgrid.PGEditorDialogAdapter.html" title="wx.propgrid.PGEditorDialogAdapter" alt="" coords="5,83,251,112"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="87,5,168,35"/> </map> 
   </p>

|


|sub_classes| Known Subclasses
==============================

:ref:`wx.propgrid.PGFileDialogAdapter`, :ref:`wx.propgrid.PGLongStringDialogAdapter`

|


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






   .. method:: DoShowDialog(self, propGrid, property)




      :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: :ref:`PGVariant`








   .. method:: SetValue(self, value)




      :param `value`: 
      :type `value`: PGVariant







   .. method:: ShowDialog(self, propGrid, property)




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