]> git.saurik.com Git - wxWidgets.git/blob - interface/wx/html/helpdlg.h
misc fixes of ctor signatures
[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 license
7 /////////////////////////////////////////////////////////////////////////////
8
9 /**
10 @class wxHtmlHelpDialog
11
12 This class is used by wxHtmlHelpController
13 to display help.
14 It is an internal class and should not be used directly - except for the case
15 when you're writing your own HTML help controller.
16
17 @library{wxhtml}
18 @category{FIXME}
19 */
20 class wxHtmlHelpDialog : public wxFrame
21 {
22 public:
23 //@{
24 /**
25 Constructor. For the values of @e style, please see the documentation for
26 wxHtmlHelpController.
27 */
28 wxHtmlHelpDialog(wxHtmlHelpData* data = NULL);
29 wxHtmlHelpDialog(wxWindow* parent, int wxWindowID,
30 const wxString& title = wxEmptyString,
31 int style = wxHF_DEFAULT_STYLE,
32 wxHtmlHelpData* data = NULL);
33 //@}
34
35 /**
36 You may override this virtual method to add more buttons to the help window's
37 toolbar. @a toolBar is a pointer to the toolbar and @a style is the style
38 flag as passed to the Create method.
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 Reads the user's settings for this dialog see
58 wxHtmlHelpController::ReadCustomization)
59 */
60 void ReadCustomization(wxConfigBase* cfg,
61 const wxString& path = wxEmptyString);
62
63 /**
64 Sets the help controller associated with the dialog.
65 */
66 void SetController(wxHtmlHelpController* contoller);
67
68 /**
69 Sets the dialog's title format. @a format must contain exactly one "%s"
70 (it will be replaced by the page title).
71 */
72 void SetTitleFormat(const wxString& format);
73
74 /**
75 Saves the user's settings for this dialog (see
76 wxHtmlHelpController::WriteCustomization).
77 */
78 void WriteCustomization(wxConfigBase* cfg,
79 const wxString& path = wxEmptyString);
80 };
81