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
13const int wxHELP_NETSCAPE;
14enum wxHelpSearchMode
15{
16    wxHELP_SEARCH_INDEX,
17    wxHELP_SEARCH_ALL
18};
19
20class wxHelpControllerBase : wxObject   /Abstract/
21{
22    %Docstring
23        HelpControllerBase(parentWindow=None)
24
25        This is the abstract base class a family of classes by which
26        applications may invoke a help viewer to provide on-line help.
27    %End
28    %TypeHeaderCode
29        #include <wx/help.h>
30    %End
31
32public:
33    wxHelpControllerBase(
34        wxWindow * parentWindow = NULL
35    );
36
37    ~wxHelpControllerBase();
38
39    virtual
40    bool Initialize(
41        const wxString & file
42    );
43    %Docstring
44        Initialize(file) -> bool
45        Initialize(file, server) -> bool
46
47        Initializes the help instance with a help filename, and optionally a
48        server socket number if using wxHelp (now obsolete).
49    %End
50
51    virtual
52    bool Initialize(
53        const wxString & file,
54        int server
55    );
56
57    virtual
58    bool DisplayBlock(
59        long blockNo
60    ) = 0   /Deprecated/;
61    %Docstring
62        DisplayBlock(blockNo) -> bool
63
64        If the help viewer is not running, runs it and displays the file at
65        the given block number.
66    %End
67
68    virtual
69    bool DisplayContents() = 0;
70    %Docstring
71        DisplayContents() -> bool
72
73        If the help viewer is not running, runs it and displays the contents.
74    %End
75
76    virtual
77    bool DisplayContextPopup(
78        int contextId
79    );
80    %Docstring
81        DisplayContextPopup(contextId) -> bool
82
83        Displays the section as a popup window using a context id.
84    %End
85
86    virtual
87    bool DisplaySection(
88        const wxString & section
89    );
90    %Docstring
91        DisplaySection(section) -> bool
92        DisplaySection(sectionNo) -> bool
93
94        If the help viewer is not running, runs it and displays the given
95        section.
96    %End
97
98    virtual
99    bool DisplaySection(
100        int sectionNo
101    ) = 0;
102
103    virtual
104    bool DisplayTextPopup(
105        const wxString & text,
106        const wxPoint & pos
107    );
108    %Docstring
109        DisplayTextPopup(text, pos) -> bool
110
111        Displays the text in a popup window, if possible.
112    %End
113
114    virtual
115    wxFrame * GetFrameParameters(
116        wxSize * size   /Out/ = NULL,
117        wxPoint * pos   /Out/ = NULL,
118        bool * newFrameEachTime   /Out/ = NULL
119    );
120    %Docstring
121        GetFrameParameters() -> (Frame, size, pos, newFrameEachTime)
122
123        For wxHtmlHelpController, returns the latest frame size and position
124        settings and whether a new frame is drawn with each invocation.
125    %End
126
127    virtual
128    wxWindow * GetParentWindow() const;
129    %Docstring
130        GetParentWindow() -> Window
131
132        Returns the window to be used as the parent for the help window.
133    %End
134
135    virtual
136    bool KeywordSearch(
137        const wxString & keyWord,
138        wxHelpSearchMode mode = wxHELP_SEARCH_ALL
139    ) = 0;
140    %Docstring
141        KeywordSearch(keyWord, mode=HELP_SEARCH_ALL) -> bool
142
143        If the help viewer is not running, runs it, and searches for sections
144        matching the given keyword.
145    %End
146
147    virtual
148    bool LoadFile(
149        const wxString & file = wxEmptyString
150    ) = 0;
151    %Docstring
152        LoadFile(file=EmptyString) -> bool
153
154        If the help viewer is not running, runs it and loads the given file.
155    %End
156
157    virtual
158    void OnQuit();
159    %Docstring
160        OnQuit()
161
162        Overridable member called when this application's viewer is quit by
163        the user.
164    %End
165
166    virtual
167    bool Quit() = 0;
168    %Docstring
169        Quit() -> bool
170
171        If the viewer is running, quits it by disconnecting.
172    %End
173
174    virtual
175    void SetFrameParameters(
176        const wxString & titleFormat,
177        const wxSize & size,
178        const wxPoint & pos = wxDefaultPosition,
179        bool newFrameEachTime = false
180    );
181    %Docstring
182        SetFrameParameters(titleFormat, size, pos=DefaultPosition, newFrameEachTime=False)
183
184        Set the parameters of the frame window.
185    %End
186
187    virtual
188    void SetParentWindow(
189        wxWindow * parentWindow
190    );
191    %Docstring
192        SetParentWindow(parentWindow)
193
194        Sets the window to be used as the parent for the help window.
195    %End
196
197    virtual
198    void SetViewer(
199        const wxString & viewer,
200        long flags = wxHELP_NETSCAPE
201    );
202    %Docstring
203        SetViewer(viewer, flags=HELP_NETSCAPE)
204
205        Sets detailed viewer information.
206    %End
207
208    public:
209
210
211    %Property(name=FrameParameters, get=GetFrameParameters, set=SetFrameParameters)
212    %Property(name=ParentWindow, get=GetParentWindow, set=SetParentWindow)
213};  // end of class wxHelpControllerBase
214
215
216
217//---------------------------------------------------------------------------
218
219