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 _core.sip
8//
9//---------------------------------------------------------------------------
10
11//---------------------------------------------------------------------------
12
13class wxPreferencesEditor
14{
15    %Docstring
16        PreferencesEditor(title="")
17
18        Manage preferences dialog.
19    %End
20    %TypeHeaderCode
21        #include <wx/preferences.h>
22    %End
23
24public:
25    wxPreferencesEditor(
26        const wxString & title = wxString()
27    );
28
29    ~wxPreferencesEditor();
30
31    void AddPage(
32        wxPreferencesPage * page   /Transfer/
33    );
34    %Docstring
35        AddPage(page)
36
37        Add a new page to the editor.
38    %End
39
40    virtual
41    void Show(
42        wxWindow * parent
43    );
44    %Docstring
45        Show(parent)
46
47        Show the preferences dialog or bring it to the top if it's already
48        shown.
49    %End
50
51    void Dismiss();
52    %Docstring
53        Dismiss()
54
55        Hide the currently shown dialog, if any.
56    %End
57
58    static
59    bool ShouldApplyChangesImmediately();
60    %Docstring
61        ShouldApplyChangesImmediately() -> bool
62
63        Returns whether changes to values in preferences pages should be
64        applied immediately or only when the user clicks the OK button.
65    %End
66
67    private:
68        wxPreferencesEditor(const wxPreferencesEditor&);
69
70
71};  // end of class wxPreferencesEditor
72
73
74class wxPreferencesPage
75{
76    %Docstring
77        PreferencesPage()
78
79        One page of preferences dialog.
80    %End
81    %TypeHeaderCode
82        #include <wx/preferences.h>
83    %End
84
85public:
86    wxPreferencesPage();
87
88    virtual
89    ~wxPreferencesPage();
90
91    virtual
92    wxString GetName() const = 0;
93    %Docstring
94        GetName() -> String
95
96        Return name of the page.
97    %End
98
99    virtual
100    wxBitmap GetLargeIcon() const = 0;
101    %Docstring
102        GetLargeIcon() -> Bitmap
103
104        Return 32x32 icon used for the page on some platforms.
105    %End
106
107    virtual
108    wxWindow * CreateWindow(
109        wxWindow * parent
110    ) = 0;
111    %Docstring
112        CreateWindow(parent) -> Window
113
114        Create a window for this page.
115    %End
116
117    private:
118        wxPreferencesPage(const wxPreferencesPage&);
119
120
121    public:
122
123
124    %Property(name=LargeIcon, get=GetLargeIcon)
125    %Property(name=Name, get=GetName)
126};  // end of class wxPreferencesPage
127
128
129class wxStockPreferencesPage : wxPreferencesPage
130{
131    %Docstring
132        StockPreferencesPage(kind)
133
134        Specialization of wxPreferencesPage useful for certain commonly used
135        preferences page.
136    %End
137    %TypeHeaderCode
138        #include <wx/preferences.h>
139    %End
140
141public:
142    enum Kind
143    {
144        Kind_General,
145        Kind_Advanced
146    };
147
148    wxStockPreferencesPage(
149        Kind kind
150    );
151
152    Kind GetKind() const;
153    %Docstring
154        GetKind() -> Kind
155
156        Returns the page's kind.
157    %End
158
159    virtual
160    wxString GetName() const;
161    %Docstring
162        GetName() -> String
163
164        Reimplemented to return suitable name for the page's kind.
165    %End
166
167    virtual
168    wxBitmap GetLargeIcon() const;
169    %Docstring
170        GetLargeIcon() -> Bitmap
171
172        Reimplemented to return stock icon on OS X.
173    %End
174
175    public:
176
177
178    %Property(name=LargeIcon, get=GetLargeIcon)
179    %Property(name=Name, get=GetName)
180};  // end of class wxStockPreferencesPage
181
182
183
184//---------------------------------------------------------------------------
185
186