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 _html.sip
8//
9//---------------------------------------------------------------------------
10
11//---------------------------------------------------------------------------
12
13enum
14{
15    wxID_HTML_PANEL,
16    wxID_HTML_BACK,
17    wxID_HTML_FORWARD,
18    wxID_HTML_UPNODE,
19    wxID_HTML_UP,
20    wxID_HTML_DOWN,
21    wxID_HTML_PRINT,
22    wxID_HTML_OPENFILE,
23    wxID_HTML_OPTIONS,
24    wxID_HTML_BOOKMARKSLIST,
25    wxID_HTML_BOOKMARKSADD,
26    wxID_HTML_BOOKMARKSREMOVE,
27    wxID_HTML_TREECTRL,
28    wxID_HTML_INDEXPAGE,
29    wxID_HTML_INDEXLIST,
30    wxID_HTML_INDEXTEXT,
31    wxID_HTML_INDEXBUTTON,
32    wxID_HTML_INDEXBUTTONALL,
33    wxID_HTML_NOTEBOOK,
34    wxID_HTML_SEARCHPAGE,
35    wxID_HTML_SEARCHTEXT,
36    wxID_HTML_SEARCHLIST,
37    wxID_HTML_SEARCHBUTTON,
38    wxID_HTML_SEARCHCHOICE,
39    wxID_HTML_COUNTINFO
40};
41
42class wxHtmlHelpWindow : wxWindow
43{
44    %Docstring
45        HtmlHelpWindow(data=None)
46        HtmlHelpWindow(parent, WindowID, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.TAB_TRAVERSAL|wx.BORDER_NONE, helpStyle=HF_DEFAULT_STYLE, data=None)
47
48        This class is used by wxHtmlHelpController to display help within a
49        frame or dialog, but you can use it yourself to create an embedded
50        HTML help window.
51    %End
52    %TypeHeaderCode
53        #include <wx/html/helpwnd.h>
54    %End
55
56public:
57    wxHtmlHelpWindow(
58        wxHtmlHelpData * data = NULL
59    );
60    %PreMethodCode
61        if (!wxPyCheckForApp()) return NULL;
62    %End
63
64    wxHtmlHelpWindow(
65        wxWindow * parent   /TransferThis/,
66        int wxWindowID,
67        const wxPoint & pos = wxDefaultPosition,
68        const wxSize & size = wxDefaultSize,
69        int style = wxTAB_TRAVERSAL|wxBORDER_NONE,
70        int helpStyle = wxHF_DEFAULT_STYLE,
71        wxHtmlHelpData * data = NULL
72    );
73    %PreMethodCode
74        if (!wxPyCheckForApp()) return NULL;
75    %End
76
77    bool Create(
78        wxWindow * parent   /TransferThis/,
79        wxWindowID id = wxID_ANY,
80        const wxPoint & pos = wxDefaultPosition,
81        const wxSize & size = wxDefaultSize,
82        int style = wxTAB_TRAVERSAL|wxBORDER_NONE,
83        int helpStyle = wxHF_DEFAULT_STYLE
84    );
85    %Docstring
86        Create(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.TAB_TRAVERSAL|wx.BORDER_NONE, helpStyle=HF_DEFAULT_STYLE) -> bool
87
88        Creates the help window.
89    %End
90
91    bool Display(
92        const wxString & x
93    );
94    %Docstring
95        Display(x) -> bool
96        Display(id) -> bool
97
98        Displays page x.
99    %End
100
101    bool Display(
102        const int id
103    );
104
105    bool DisplayContents();
106    %Docstring
107        DisplayContents() -> bool
108
109        Displays contents panel.
110    %End
111
112    bool DisplayIndex();
113    %Docstring
114        DisplayIndex() -> bool
115
116        Displays index panel.
117    %End
118
119    wxHtmlHelpData * GetData();
120    %Docstring
121        GetData() -> HtmlHelpData
122
123        Returns the wxHtmlHelpData object, which is usually a pointer to the
124        controller's data.
125    %End
126
127    bool KeywordSearch(
128        const wxString & keyword,
129        wxHelpSearchMode mode = wxHELP_SEARCH_ALL
130    );
131    %Docstring
132        KeywordSearch(keyword, mode=wx.HELP_SEARCH_ALL) -> bool
133
134        Search for given keyword.
135    %End
136
137    void ReadCustomization(
138        wxConfigBase * cfg,
139        const wxString & path = wxEmptyString
140    );
141    %Docstring
142        ReadCustomization(cfg, path=wx.EmptyString)
143
144        Reads the user's settings for this window.
145    %End
146
147    void UseConfig(
148        wxConfigBase * config,
149        const wxString & rootpath = wxEmptyString
150    );
151    %Docstring
152        UseConfig(config, rootpath=wx.EmptyString)
153
154        Associates a wxConfig object with the help window.
155    %End
156
157    void WriteCustomization(
158        wxConfigBase * cfg,
159        const wxString & path = wxEmptyString
160    );
161    %Docstring
162        WriteCustomization(cfg, path=wx.EmptyString)
163
164        Saves the user's settings for this window.
165    %End
166
167    void RefreshLists();
168    %Docstring
169        RefreshLists()
170
171        Refresh all panels.
172    %End
173
174    wxHtmlHelpController * GetController() const;
175    %Docstring
176        GetController() -> HtmlHelpController
177    %End
178
179    void SetController(
180        wxHtmlHelpController * controller   /Transfer/
181    );
182    %Docstring
183        SetController(controller)
184    %End
185
186    public:
187    virtual wxPoint GetClientAreaOrigin() const;
188    virtual bool Validate();
189    virtual bool TransferDataToWindow();
190    virtual bool TransferDataFromWindow();
191    virtual void InitDialog();
192    virtual bool AcceptsFocus() const;
193    virtual bool AcceptsFocusRecursively() const;
194    virtual bool AcceptsFocusFromKeyboard() const;
195    virtual void AddChild( wxWindowBase *child );
196    virtual void RemoveChild( wxWindowBase *child );
197    virtual void InheritAttributes();
198    virtual bool ShouldInheritColours() const;
199    virtual void OnInternalIdle();
200    virtual wxWindow *GetMainWindowOfCompositeControl();
201    virtual bool InformFirstDirection(int direction, int size, int availableOtherDir);
202    virtual void SetCanFocus(bool canFocus);
203    virtual bool Destroy();
204    virtual void SetValidator( const wxValidator &validator );
205    virtual wxValidator* GetValidator();
206
207
208    protected:
209    virtual bool ProcessEvent(wxEvent & event);
210    virtual void DoEnable(bool enable);
211    virtual void DoGetPosition(int *x, int *y) const;
212    virtual void DoGetSize(int *width, int *height) const;
213    virtual void DoGetClientSize(int *width, int *height) const;
214    virtual wxSize DoGetBestSize() const;
215    virtual wxSize DoGetBestClientSize() const;
216    virtual void DoSetSize(int x, int y, int width, int height, int sizeFlags);
217    virtual void DoSetClientSize(int width, int height);
218    virtual void DoSetSizeHints( int minW, int minH, int maxW, int maxH, int incW, int incH );
219    virtual wxSize DoGetBorderSize() const;
220    virtual void DoMoveWindow(int x, int y, int width, int height);
221    virtual void DoSetWindowVariant( wxWindowVariant variant);
222    virtual wxBorder GetDefaultBorder() const;
223    virtual wxBorder GetDefaultBorderForControl() const;
224    virtual void DoFreeze();
225    virtual void DoThaw();
226    virtual bool HasTransparentBackground();
227    virtual bool TryBefore(wxEvent& event);
228    virtual bool TryAfter(wxEvent& event);
229
230
231    public:
232
233
234    static
235    wxVisualAttributes GetClassDefaultAttributes(
236        wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL
237    );
238    %Docstring
239        GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes
240    %End
241    %PreMethodCode
242        if (!wxPyCheckForApp()) return NULL;
243    %End
244
245    public:
246
247
248    %Property(name=Controller, get=GetController, set=SetController)
249    %Property(name=Data, get=GetData)
250
251protected:
252    void CreateSearch();
253    %Docstring
254        CreateSearch()
255
256        Creates search panel.
257    %End
258
259    void AddToolbarButtons(
260        wxToolBar * toolBar,
261        int style
262    );
263    %Docstring
264        AddToolbarButtons(toolBar, style)
265
266        You may override this virtual method to add more buttons to the help
267        window's toolbar.
268    %End
269
270    void CreateContents();
271    %Docstring
272        CreateContents()
273
274        Creates contents panel.
275    %End
276
277    void CreateIndex();
278    %Docstring
279        CreateIndex()
280
281        Creates index panel.
282    %End
283
284};  // end of class wxHtmlHelpWindow
285
286
287
288//---------------------------------------------------------------------------
289
290