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 wxHelpProvider   /Abstract/
14{
15    %Docstring
16        wxHelpProvider is an abstract class used by a program implementing
17        context-sensitive help to show the help text for the given window.
18    %End
19    %TypeHeaderCode
20        #include <wx/cshelp.h>
21    %End
22
23public:
24    virtual
25    ~wxHelpProvider();
26
27    virtual
28    void AddHelp(
29        wxWindowBase * window,
30        const wxString & text
31    );
32    %Docstring
33        AddHelp(window, text)
34        AddHelp(id, text)
35
36        Associates the text with the given window.
37    %End
38
39    virtual
40    void AddHelp(
41        wxWindowID id,
42        const wxString & text
43    );
44
45    virtual
46    wxString GetHelp(
47        const wxWindowBase * window
48    ) = 0;
49    %Docstring
50        GetHelp(window) -> String
51
52        This version associates the given text with all windows with this id.
53    %End
54
55    virtual
56    void RemoveHelp(
57        wxWindowBase * window
58    );
59    %Docstring
60        RemoveHelp(window)
61
62        Removes the association between the window pointer and the help text.
63    %End
64
65    virtual
66    bool ShowHelp(
67        wxWindowBase * window
68    );
69    %Docstring
70        ShowHelp(window) -> bool
71
72        Shows help for the given window.
73    %End
74
75    virtual
76    bool ShowHelpAtPoint(
77        wxWindowBase * window,
78        const wxPoint & point,
79        wxHelpEvent::Origin origin
80    );
81    %Docstring
82        ShowHelpAtPoint(window, point, origin) -> bool
83
84        This function may be overridden to show help for the window when it
85        should depend on the position inside the window, By default this
86        method forwards to ShowHelp(), so it is enough to only implement the
87        latter if the help doesn't depend on the position.
88    %End
89
90    static
91    wxHelpProvider * Get();
92    %Docstring
93        Get() -> HelpProvider
94
95        Returns pointer to help provider instance.
96    %End
97
98    static
99    wxHelpProvider * Set(
100        wxHelpProvider * helpProvider   /Transfer/
101    )   /TransferBack/;
102    %Docstring
103        Set(helpProvider) -> HelpProvider
104
105        Set the current, application-wide help provider.
106    %End
107
108};  // end of class wxHelpProvider
109
110
111class wxSimpleHelpProvider : wxHelpProvider
112{
113    %Docstring
114        wxSimpleHelpProvider is an implementation of wxHelpProvider which
115        supports only plain text help strings, and shows the string associated
116        with the control (if any) in a tooltip.
117    %End
118    %TypeHeaderCode
119        #include <wx/cshelp.h>
120    %End
121
122public:
123    virtual wxString GetHelp(const wxWindowBase* window);
124
125
126};  // end of class wxSimpleHelpProvider
127
128
129class wxHelpControllerHelpProvider : wxSimpleHelpProvider
130{
131    %Docstring
132        HelpControllerHelpProvider(hc=None)
133
134        wxHelpControllerHelpProvider is an implementation of wxHelpProvider
135        which supports both context identifiers and plain text help strings.
136    %End
137    %TypeHeaderCode
138        #include <wx/cshelp.h>
139    %End
140
141public:
142    wxHelpControllerHelpProvider(
143        wxHelpControllerBase * hc = NULL
144    );
145    %PreMethodCode
146        if (!wxPyCheckForApp()) return NULL;
147    %End
148
149    wxHelpControllerBase * GetHelpController() const;
150    %Docstring
151        GetHelpController() -> HelpControllerBase
152
153        Returns the help controller associated with this help provider.
154    %End
155
156    void SetHelpController(
157        wxHelpControllerBase * hc
158    );
159    %Docstring
160        SetHelpController(hc)
161
162        Sets the help controller associated with this help provider.
163    %End
164
165    private:
166        wxHelpControllerHelpProvider(const wxHelpControllerHelpProvider&);
167
168
169    public:
170
171
172    %Property(name=HelpController, get=GetHelpController, set=SetHelpController)
173};  // end of class wxHelpControllerHelpProvider
174
175
176class wxContextHelp : wxObject
177{
178    %Docstring
179        ContextHelp(window=None, doNow=True)
180
181        This class changes the cursor to a query and puts the application into
182        a 'context-sensitive help mode'.
183    %End
184    %TypeHeaderCode
185        #include <wx/cshelp.h>
186    %End
187
188public:
189    wxContextHelp(
190        wxWindow * window = NULL,
191        bool doNow = true
192    );
193    %PreMethodCode
194        if (!wxPyCheckForApp()) return NULL;
195    %End
196
197    virtual
198    ~wxContextHelp();
199
200    bool BeginContextHelp(
201        wxWindow * window
202    );
203    %Docstring
204        BeginContextHelp(window) -> bool
205
206        Puts the application into context-sensitive help mode.
207    %End
208
209    bool EndContextHelp();
210    %Docstring
211        EndContextHelp() -> bool
212
213        Ends context-sensitive help mode.
214    %End
215
216};  // end of class wxContextHelp
217
218
219class wxContextHelpButton : wxBitmapButton
220{
221    %Docstring
222        ContextHelpButton(parent, id=ID_CONTEXT_HELP, pos=DefaultPosition, size=DefaultSize, style=BU_AUTODRAW)
223
224        Instances of this class may be used to add a question mark button that
225        when pressed, puts the application into context-help mode.
226    %End
227    %TypeHeaderCode
228        #include <wx/cshelp.h>
229    %End
230
231public:
232    wxContextHelpButton(
233        wxWindow * parent   /TransferThis/,
234        wxWindowID id = wxID_CONTEXT_HELP,
235        const wxPoint & pos = wxDefaultPosition,
236        const wxSize & size = wxDefaultSize,
237        long style = wxBU_AUTODRAW
238    );
239    %PreMethodCode
240        if (!wxPyCheckForApp()) return NULL;
241    %End
242
243    public:
244    virtual wxPoint GetClientAreaOrigin() const;
245    virtual bool Validate();
246    virtual bool TransferDataToWindow();
247    virtual bool TransferDataFromWindow();
248    virtual void InitDialog();
249    virtual bool AcceptsFocus() const;
250    virtual bool AcceptsFocusRecursively() const;
251    virtual bool AcceptsFocusFromKeyboard() const;
252    virtual void AddChild( wxWindowBase *child );
253    virtual void RemoveChild( wxWindowBase *child );
254    virtual void InheritAttributes();
255    virtual bool ShouldInheritColours() const;
256    virtual void OnInternalIdle();
257    virtual wxWindow *GetMainWindowOfCompositeControl();
258    virtual bool InformFirstDirection(int direction, int size, int availableOtherDir);
259    virtual void SetCanFocus(bool canFocus);
260    virtual bool Destroy();
261    virtual void SetValidator( const wxValidator &validator );
262    virtual wxValidator* GetValidator();
263
264
265    protected:
266    virtual bool ProcessEvent(wxEvent & event);
267    virtual void DoEnable(bool enable);
268    virtual void DoGetPosition(int *x, int *y) const;
269    virtual void DoGetSize(int *width, int *height) const;
270    virtual void DoGetClientSize(int *width, int *height) const;
271    virtual wxSize DoGetBestSize() const;
272    virtual wxSize DoGetBestClientSize() const;
273    virtual void DoSetSize(int x, int y, int width, int height, int sizeFlags);
274    virtual void DoSetClientSize(int width, int height);
275    virtual void DoSetSizeHints( int minW, int minH, int maxW, int maxH, int incW, int incH );
276    virtual wxSize DoGetBorderSize() const;
277    virtual void DoMoveWindow(int x, int y, int width, int height);
278    virtual void DoSetWindowVariant( wxWindowVariant variant);
279    virtual wxBorder GetDefaultBorder() const;
280    virtual wxBorder GetDefaultBorderForControl() const;
281    virtual void DoFreeze();
282    virtual void DoThaw();
283    virtual bool HasTransparentBackground();
284    virtual bool TryBefore(wxEvent& event);
285    virtual bool TryAfter(wxEvent& event);
286
287
288    public:
289
290
291    static
292    wxVisualAttributes GetClassDefaultAttributes(
293        wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL
294    );
295    %Docstring
296        GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
297    %End
298    %PreMethodCode
299        if (!wxPyCheckForApp()) return NULL;
300    %End
301
302};  // end of class wxContextHelpButton
303
304
305
306//---------------------------------------------------------------------------
307
308