File: wx.adv.WizardPageSimple.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 (298 lines) | stat: -rw-r--r-- 7,706 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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
.. 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.adv.WizardPageSimple:

==========================================================================================================================================
|phoenix_title|  **wx.adv.WizardPageSimple**
==========================================================================================================================================

:ref:`wx.adv.WizardPageSimple`  is the simplest possible :ref:`wx.adv.WizardPage`  implementation: it just returns the pointers given to its constructor from :meth:`wx.adv.WizardPage.GetNext`   and :meth:`wx.adv.WizardPage.GetPrev`   functions.          

This makes it very easy to use the objects of this class in the wizards where the pages order is known statically - on the other hand, if this is not the case you must derive your own class from :ref:`wx.adv.WizardPage`  instead. 







         



.. seealso:: :ref:`wx.adv.Wizard`, :ref:`Wizard Sample <wizard sample>`    







|

|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>WizardPageSimple</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.adv.WizardPageSimple_inheritance.png" alt="Inheritance diagram of WizardPageSimple" 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.Object.html" title="wx.Object" alt="" coords="5,5,87,35"/> <area shape="rect" id="node3" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="48,83,159,112"/> <area shape="rect" id="node2" href="wx.Window.html" title="wx.Window" alt="" coords="59,160,148,189"/> <area shape="rect" id="node5" href="wx.Panel.html" title="wx.Panel" alt="" coords="66,237,141,267"/> <area shape="rect" id="node4" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="112,5,213,35"/> <area shape="rect" id="node7" href="wx.adv.WizardPage.html" title="wx.adv.WizardPage" alt="" coords="33,315,173,344"/> <area shape="rect" id="node6" href="wx.adv.WizardPageSimple.html" title="wx.adv.WizardPageSimple" alt="" coords="11,392,196,421"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.adv.WizardPageSimple.__init__`                                        Default constructor.
:meth:`~wx.adv.WizardPageSimple.Chain`                                           A helper chaining this page with the next one.
:meth:`~wx.adv.WizardPageSimple.Create`                                          Creates the wizard page.
:meth:`~wx.adv.WizardPageSimple.SetNext`                                         Sets the next page.
:meth:`~wx.adv.WizardPageSimple.SetPrev`                                         Sets the previous page.
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.adv.WizardPageSimple(WizardPage)

   **Possible constructors**::

       WizardPageSimple()
       
       WizardPageSimple(parent, prev=None, next=None, bitmap=NullBitmap)
       
   
   WizardPageSimple is the simplest possible WizardPage
   implementation: it just returns the pointers given to its constructor
   from `WizardPage.GetNext()` and `WizardPage.GetPrev()` functions.



   .. method:: __init__(self, *args, **kw)



      |overload| Overloaded Implementations:

      **~~~**

      
      **__init__** `(self)`
      
      Default constructor.                   
      
      
      
      
      **~~~**

      
      **__init__** `(self, parent, prev=None, next=None, bitmap=NullBitmap)`
      
      Constructor takes the previous and next pages.                  
      
      They may be modified later by :meth:`SetPrev`   or :meth:`SetNext` .                  
      
      
      :param `parent`: 
      :type `parent`: wx.adv.Wizard
      :param `prev`: 
      :type `prev`: wx.adv.WizardPage
      :param `next`: 
      :type `next`: wx.adv.WizardPage
      :param `bitmap`: 
      :type `bitmap`: wx.Bitmap
      
      
      
      
      
      
      **~~~**






   .. method:: Chain(self, *args, **kw)



      |overload| Overloaded Implementations:

      **~~~**

      
      **Chain** `(self, next)`
      
      A helper chaining this page with the next one.                  
      
      Notice that this method returns a reference to the next page, so the calls to it can, in turn, be chained: 
      
      ::
      
                  page3 = wx.RadioboxPage(wizard)
                  page4 = wx.ValidationPage(wizard)
      
                  wx.adv.WizardPageSimple.Chain(page3, page4)
      
      
      
      This makes this method the simplest way to define the order of changes in fully static wizards, i.e. in those where the order doesn't depend on the choices made by the user in the wizard pages during run-time. 
      
      
      
      
      :param `next`: A non-NULL pointer to the next page.   
      :type `next`: wx.adv.WizardPageSimple
      
      
      
      
      
      
      :rtype: :ref:`wx.adv.WizardPageSimple`
      
      
      
                        
      
      
      
      :returns: 
      
         Reference to `next`  on which :meth:`Chain`   can be called again.  
      
      
      
      
      
      
      
      .. versionadded:: 2.9.5 
           
      
      
      
      
      
      
      
      **~~~**

      
      **Chain** `(first, second)`
      
      A convenience function to make the pages follow each other.                  
      
      Example: 
      
      ::
      
          # FirstPage is an instance of wx.adv.WizardPageSimple
          firstPage = FirstPage(self)
          firstPage.Chain(SecondPage).Chain(ThirdPage).Chain(LastPage)
      
                       
      
      
      :param `first`: 
      :type `first`: wx.adv.WizardPageSimple
      :param `second`: 
      :type `second`: wx.adv.WizardPageSimple
      
      
      
      
      
      
      **~~~**






   .. method:: Create(self, parent=None, prev=None, next=None, bitmap=NullBitmap)

      Creates the wizard page.                  

      Must be called if the default constructor had been used to create the object.                  


      :param `parent`: 
      :type `parent`: wx.adv.Wizard
      :param `prev`: 
      :type `prev`: wx.adv.WizardPage
      :param `next`: 
      :type `next`: wx.adv.WizardPage
      :param `bitmap`: 
      :type `bitmap`: wx.Bitmap




      :rtype: `bool`








   .. method:: SetNext(self, next)

      Sets the next page.                  


      :param `next`: 
      :type `next`: wx.adv.WizardPage







   .. method:: SetPrev(self, prev)

      Sets the previous page.                  


      :param `prev`: 
      :type `prev`: wx.adv.WizardPage