Resolve ambiguity between GetClientXXX() methods in wxOSX wxComboBox.
[wxWidgets.git] / interface / wx / html / helpdlg.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: html/helpdlg.h
3 // Purpose: interface of wxHtmlHelpDialog
4 // Author: wxWidgets team
5 // RCS-ID: $Id$
6 // Licence: wxWindows licence
7 /////////////////////////////////////////////////////////////////////////////
8
9 /**
10 @class wxHtmlHelpDialog
11
12 This class is used by wxHtmlHelpController to display help.
13 It is an internal class and should not be used directly - except for the case
14 when you're writing your own HTML help controller.
15
16 @library{wxhtml}
17 @category{help,html}
18 */
19 class wxHtmlHelpDialog : public wxFrame
20 {
21 public:
22 wxHtmlHelpDialog(wxHtmlHelpData* data = NULL);
23
24 /**
25 Constructor.
26
27 For the possible values of @a style, please see wxHtmlHelpController.
28 */
29 wxHtmlHelpDialog(wxWindow* parent, int wxWindowID,
30 const wxString& title = wxEmptyString,
31 int style = wxHF_DEFAULT_STYLE,
32 wxHtmlHelpData* data = NULL);
33
34 /**
35 You may override this virtual method to add more buttons to the help window's
36 toolbar. @a toolBar is a pointer to the toolbar and @a style is the style
37 flag as passed to the Create() method.
38
39 wxToolBar::Realize is called immediately after returning from this function.
40 */
41 virtual void AddToolbarButtons(wxToolBar* toolBar, int style);
42
43 /**
44 Creates the dialog. See @ref wxHtmlHelpDialog() "the constructor"
45 for a description of the parameters.
46 */
47 bool Create(wxWindow* parent, wxWindowID id,
48 const wxString& title = wxEmptyString,
49 int style = wxHF_DEFAULT_STYLE);
50
51 /**
52 Returns the help controller associated with the dialog.
53 */
54 wxHtmlHelpController* GetController() const;
55
56 /**
57 Sets the help controller associated with the dialog.
58 */
59 void SetController(wxHtmlHelpController* controller);
60
61 /**
62 Sets the dialog's title format.
63
64 @a format must contain exactly one "%s" (it will be replaced by the page title).
65 */
66 void SetTitleFormat(const wxString& format);
67 };
68