1//---------------------------------------------------------------------------
2// This file is generated by wxPython's SIP generator.  Do not edit by hand.
3//
4// Copyright: (c) 2018 by Total Control Software
5// License:   wxWindows License
6//
7// This file will be included by _adv.sip
8//
9//---------------------------------------------------------------------------
10
11//---------------------------------------------------------------------------
12
13const int wxWIZARD_EX_HELPBUTTON;
14const int wxWIZARD_VALIGN_TOP;
15const int wxWIZARD_VALIGN_CENTRE;
16const int wxWIZARD_VALIGN_BOTTOM;
17const int wxWIZARD_HALIGN_LEFT;
18const int wxWIZARD_HALIGN_CENTRE;
19const int wxWIZARD_HALIGN_RIGHT;
20const int wxWIZARD_TILE;
21wxEventType wxEVT_WIZARD_PAGE_CHANGED   /PyName=wxEVT_WIZARD_PAGE_CHANGED/;
22
23wxEventType wxEVT_WIZARD_PAGE_CHANGING   /PyName=wxEVT_WIZARD_PAGE_CHANGING/;
24
25wxEventType wxEVT_WIZARD_CANCEL   /PyName=wxEVT_WIZARD_CANCEL/;
26
27wxEventType wxEVT_WIZARD_HELP   /PyName=wxEVT_WIZARD_HELP/;
28
29wxEventType wxEVT_WIZARD_FINISHED   /PyName=wxEVT_WIZARD_FINISHED/;
30
31wxEventType wxEVT_WIZARD_PAGE_SHOWN   /PyName=wxEVT_WIZARD_PAGE_SHOWN/;
32
33wxEventType wxEVT_WIZARD_BEFORE_PAGE_CHANGED   /PyName=wxEVT_WIZARD_BEFORE_PAGE_CHANGED/;
34
35class wxWizardPage : wxPanel
36{
37    %Docstring
38        WizardPage()
39        WizardPage(parent, bitmap=wx.NullBitmap)
40
41        wxWizardPage is one of the screens in wxWizard: it must know what are
42        the following and preceding pages (which may be NULL for the
43        first/last page).
44    %End
45    %TypeHeaderCode
46        #include <wx/wizard.h>
47    %End
48
49public:
50    wxWizardPage();
51    %PreMethodCode
52        if (!wxPyCheckForApp()) return NULL;
53    %End
54
55    wxWizardPage(
56        wxWizard * parent   /TransferThis/,
57        const wxBitmap & bitmap = wxNullBitmap
58    );
59    %PreMethodCode
60        if (!wxPyCheckForApp()) return NULL;
61    %End
62
63    bool Create(
64        wxWizard * parent   /TransferThis/,
65        const wxBitmap & bitmap = wxNullBitmap
66    );
67    %Docstring
68        Create(parent, bitmap=wx.NullBitmap) -> bool
69
70        Creates the wizard page.
71    %End
72
73    virtual
74    wxBitmap GetBitmap() const;
75    %Docstring
76        GetBitmap() -> wx.Bitmap
77
78        This method is called by wxWizard to get the bitmap to display
79        alongside the page.
80    %End
81
82    virtual
83    wxWizardPage * GetNext() const = 0;
84    %Docstring
85        GetNext() -> WizardPage
86
87        Get the page which should be shown when the user chooses the "Next"
88        button: if NULL is returned, this button will be disabled.
89    %End
90
91    virtual
92    wxWizardPage * GetPrev() const = 0;
93    %Docstring
94        GetPrev() -> WizardPage
95
96        Get the page which should be shown when the user chooses the "Back"
97        button: if NULL is returned, this button will be disabled.
98    %End
99
100    static
101    wxVisualAttributes GetClassDefaultAttributes(
102        wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL
103    );
104    %Docstring
105        GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes
106    %End
107    %PreMethodCode
108        if (!wxPyCheckForApp()) return NULL;
109    %End
110
111    public:
112
113
114    %Property(name=Bitmap, get=GetBitmap)
115    %Property(name=Next, get=GetNext)
116    %Property(name=Prev, get=GetPrev)
117};  // end of class wxWizardPage
118
119
120class wxWizardPageSimple : wxWizardPage
121{
122    %Docstring
123        WizardPageSimple()
124        WizardPageSimple(parent, prev=None, next=None, bitmap=wx.NullBitmap)
125
126        wxWizardPageSimple is the simplest possible wxWizardPage
127        implementation: it just returns the pointers given to its constructor
128        from wxWizardPage::GetNext() and wxWizardPage::GetPrev() functions.
129    %End
130    %TypeHeaderCode
131        #include <wx/wizard.h>
132    %End
133
134public:
135    wxWizardPageSimple();
136    %PreMethodCode
137        if (!wxPyCheckForApp()) return NULL;
138    %End
139
140    wxWizardPageSimple(
141        wxWizard * parent   /TransferThis/,
142        wxWizardPage * prev = NULL,
143        wxWizardPage * next = NULL,
144        const wxBitmap & bitmap = wxNullBitmap
145    );
146    %PreMethodCode
147        if (!wxPyCheckForApp()) return NULL;
148    %End
149
150    bool Create(
151        wxWizard * parent   /TransferThis/ = NULL,
152        wxWizardPage * prev = NULL,
153        wxWizardPage * next = NULL,
154        const wxBitmap & bitmap = wxNullBitmap
155    );
156    %Docstring
157        Create(parent=None, prev=None, next=None, bitmap=wx.NullBitmap) -> bool
158
159        Creates the wizard page.
160    %End
161
162    wxWizardPageSimple & Chain(
163        wxWizardPageSimple * next
164    );
165    %Docstring
166        Chain(next) -> WizardPageSimple
167        Chain(first, second)
168
169        A helper chaining this page with the next one.
170    %End
171
172    static
173    void Chain(
174        wxWizardPageSimple * first,
175        wxWizardPageSimple * second
176    );
177
178    void SetNext(
179        wxWizardPage * next
180    );
181    %Docstring
182        SetNext(next)
183
184        Sets the next page.
185    %End
186
187    void SetPrev(
188        wxWizardPage * prev
189    );
190    %Docstring
191        SetPrev(prev)
192
193        Sets the previous page.
194    %End
195
196    static
197    wxVisualAttributes GetClassDefaultAttributes(
198        wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL
199    );
200    %Docstring
201        GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes
202    %End
203    %PreMethodCode
204        if (!wxPyCheckForApp()) return NULL;
205    %End
206
207            virtual wxWizardPage* GetNext() const;
208            virtual wxWizardPage* GetPrev() const;
209
210
211    public:
212
213
214};  // end of class wxWizardPageSimple
215
216
217class wxWizard : wxDialog
218{
219    %Docstring
220        Wizard()
221        Wizard(parent, id=wx.ID_ANY, title=wx.EmptyString, bitmap=wx.NullBitmap, pos=wx.DefaultPosition, style=wx.DEFAULT_DIALOG_STYLE)
222
223        wxWizard is the central class for implementing 'wizard-like' dialogs.
224    %End
225    %TypeHeaderCode
226        #include <wx/wizard.h>
227    %End
228
229public:
230    wxWizard();
231    %PreMethodCode
232        if (!wxPyCheckForApp()) return NULL;
233    %End
234
235    wxWizard(
236        wxWindow * parent   /TransferThis/,
237        int id = wxID_ANY,
238        const wxString & title = wxEmptyString,
239        const wxBitmap & bitmap = wxNullBitmap,
240        const wxPoint & pos = wxDefaultPosition,
241        long style = wxDEFAULT_DIALOG_STYLE
242    );
243    %PreMethodCode
244        if (!wxPyCheckForApp()) return NULL;
245    %End
246
247    bool Create(
248        wxWindow * parent   /TransferThis/,
249        int id = wxID_ANY,
250        const wxString & title = wxEmptyString,
251        const wxBitmap & bitmap = wxNullBitmap,
252        const wxPoint & pos = wxDefaultPosition,
253        long style = wxDEFAULT_DIALOG_STYLE
254    );
255    %Docstring
256        Create(parent, id=wx.ID_ANY, title=wx.EmptyString, bitmap=wx.NullBitmap, pos=wx.DefaultPosition, style=wx.DEFAULT_DIALOG_STYLE) -> bool
257
258        Creates the wizard dialog.
259    %End
260
261    virtual
262    void FitToPage(
263        const wxWizardPage * firstPage
264    );
265    %Docstring
266        FitToPage(firstPage)
267
268        This method is obsolete, use GetPageAreaSizer() instead.
269    %End
270
271    const wxBitmap & GetBitmap() const;
272    %Docstring
273        GetBitmap() -> wx.Bitmap
274
275        Returns the bitmap used for the wizard.
276    %End
277
278    const wxColour & GetBitmapBackgroundColour() const;
279    %Docstring
280        GetBitmapBackgroundColour() -> wx.Colour
281
282        Returns the colour that should be used to fill the area not taken up
283        by the wizard or page bitmap, if a non-zero bitmap placement flag has
284        been set.
285    %End
286
287    int GetBitmapPlacement() const;
288    %Docstring
289        GetBitmapPlacement() -> int
290
291        Returns the flags indicating how the wizard or page bitmap should be
292        expanded and positioned to fit the page height.
293    %End
294
295    virtual
296    wxWizardPage * GetCurrentPage() const;
297    %Docstring
298        GetCurrentPage() -> WizardPage
299
300        Get the current page while the wizard is running.
301    %End
302
303    int GetMinimumBitmapWidth() const;
304    %Docstring
305        GetMinimumBitmapWidth() -> int
306
307        Returns the minimum width for the bitmap that will be constructed to
308        contain the actual wizard or page bitmap if a non-zero bitmap
309        placement flag has been set.
310    %End
311
312    virtual
313    wxSizer * GetPageAreaSizer() const;
314    %Docstring
315        GetPageAreaSizer() -> wx.Sizer
316
317        Returns pointer to page area sizer.
318    %End
319
320    virtual
321    wxSize GetPageSize() const;
322    %Docstring
323        GetPageSize() -> wx.Size
324
325        Returns the size available for the pages.
326    %End
327
328    virtual
329    bool HasNextPage(
330        wxWizardPage * page
331    );
332    %Docstring
333        HasNextPage(page) -> bool
334
335        Return true if this page is not the last one in the wizard.
336    %End
337
338    virtual
339    bool HasPrevPage(
340        wxWizardPage * page
341    );
342    %Docstring
343        HasPrevPage(page) -> bool
344
345        Returns true if this page is not the last one in the wizard.
346    %End
347
348    virtual
349    bool RunWizard(
350        wxWizardPage * firstPage
351    );
352    %Docstring
353        RunWizard(firstPage) -> bool
354
355        Executes the wizard starting from the given page, returning true if it
356        was successfully finished or false if user cancelled it.
357    %End
358
359    void SetBitmap(
360        const wxBitmap & bitmap
361    );
362    %Docstring
363        SetBitmap(bitmap)
364
365        Sets the bitmap used for the wizard.
366    %End
367
368    void SetBitmapBackgroundColour(
369        const wxColour & colour
370    );
371    %Docstring
372        SetBitmapBackgroundColour(colour)
373
374        Sets the colour that should be used to fill the area not taken up by
375        the wizard or page bitmap, if a non-zero bitmap placement flag has
376        been set.
377    %End
378
379    void SetBitmapPlacement(
380        int placement
381    );
382    %Docstring
383        SetBitmapPlacement(placement)
384
385        Sets the flags indicating how the wizard or page bitmap should be
386        expanded and positioned to fit the page height.
387    %End
388
389    virtual
390    void SetBorder(
391        int border
392    );
393    %Docstring
394        SetBorder(border)
395
396        Sets width of border around page area.
397    %End
398
399    void SetMinimumBitmapWidth(
400        int width
401    );
402    %Docstring
403        SetMinimumBitmapWidth(width)
404
405        Sets the minimum width for the bitmap that will be constructed to
406        contain the actual wizard or page bitmap if a non-zero bitmap
407        placement flag has been set.
408    %End
409
410    virtual
411    void SetPageSize(
412        const wxSize & sizePage
413    );
414    %Docstring
415        SetPageSize(sizePage)
416
417        Sets the minimal size to be made available for the wizard pages.
418    %End
419
420    static
421    wxVisualAttributes GetClassDefaultAttributes(
422        wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL
423    );
424    %Docstring
425        GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes
426    %End
427    %PreMethodCode
428        if (!wxPyCheckForApp()) return NULL;
429    %End
430
431    virtual
432    bool ShowPage(
433        wxWizardPage* page,
434        bool goingForward = true
435    );
436    %Docstring
437        ShowPage(page, goingForward=True) -> bool
438
439        Show the given wizard page.
440    %End
441
442    bool IsRunning() const;
443    %Docstring
444        IsRunning() -> bool
445    %End
446
447    public:
448
449
450    %Property(name=Bitmap, get=GetBitmap, set=SetBitmap)
451    %Property(name=BitmapBackgroundColour, get=GetBitmapBackgroundColour, set=SetBitmapBackgroundColour)
452    %Property(name=BitmapPlacement, get=GetBitmapPlacement, set=SetBitmapPlacement)
453    %Property(name=CurrentPage, get=GetCurrentPage)
454    %Property(name=MinimumBitmapWidth, get=GetMinimumBitmapWidth, set=SetMinimumBitmapWidth)
455    %Property(name=PageAreaSizer, get=GetPageAreaSizer)
456    %Property(name=PageSize, get=GetPageSize, set=SetPageSize)
457};  // end of class wxWizard
458
459
460class wxWizardEvent : wxNotifyEvent
461{
462    %Docstring
463        WizardEvent(type=wx.wxEVT_NULL, id=wx.ID_ANY, direction=True, page=0)
464
465        wxWizardEvent class represents an event generated by the wxWizard:
466        this event is first sent to the page itself and, if not processed
467        there, goes up the window hierarchy as usual.
468    %End
469    %TypeHeaderCode
470        #include <wx/wizard.h>
471    %End
472
473public:
474    wxWizardEvent(
475        wxEventType type = wxEVT_NULL,
476        int id = wxID_ANY,
477        bool direction = true,
478        wxWizardPage * page = 0
479    );
480
481    bool GetDirection() const;
482    %Docstring
483        GetDirection() -> bool
484
485        Return the direction in which the page is changing: for
486        EVT_WIZARD_PAGE_CHANGING, return true if we're going forward or false
487        otherwise and for EVT_WIZARD_PAGE_CHANGED return true if we came from
488        the previous page and false if we returned from the next one.
489    %End
490
491    wxWizardPage * GetPage() const;
492    %Docstring
493        GetPage() -> WizardPage
494
495        Returns the wxWizardPage which was active when this event was
496        generated.
497    %End
498
499    public:
500    virtual wxEvent* Clone() const /Factory/;
501
502
503    private:
504        wxWizardEvent& operator=(const wxWizardEvent&);
505
506
507    public:
508
509
510    %Property(name=Direction, get=GetDirection)
511    %Property(name=Page, get=GetPage)
512};  // end of class wxWizardEvent
513
514
515%Extract(id=pycode_adv)
516PyWizardPage = wx.deprecated(WizardPage, 'Use WizardPage instead.')
517
518%End
519
520%Extract(id=pycode_adv)
521EVT_WIZARD_BEFORE_PAGE_CHANGED  = wx.PyEventBinder( wxEVT_WIZARD_BEFORE_PAGE_CHANGED, 1)
522EVT_WIZARD_PAGE_CHANGED  = wx.PyEventBinder( wxEVT_WIZARD_PAGE_CHANGED, 1)
523EVT_WIZARD_PAGE_CHANGING = wx.PyEventBinder( wxEVT_WIZARD_PAGE_CHANGING, 1)
524EVT_WIZARD_CANCEL        = wx.PyEventBinder( wxEVT_WIZARD_CANCEL, 1)
525EVT_WIZARD_HELP          = wx.PyEventBinder( wxEVT_WIZARD_HELP, 1)
526EVT_WIZARD_FINISHED      = wx.PyEventBinder( wxEVT_WIZARD_FINISHED, 1)
527EVT_WIZARD_PAGE_SHOWN    = wx.PyEventBinder( wxEVT_WIZARD_PAGE_SHOWN, 1)
528
529%End
530
531
532//---------------------------------------------------------------------------
533
534