| | 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 | @headerfile helpdlg.h wx/html/helpdlg.h |
| | 12 | |
| | 13 | This class is used by wxHtmlHelpController |
| | 14 | to display help. |
| | 15 | It is an internal class and should not be used directly - except for the case |
| | 16 | when you're writing your own HTML help controller. |
| | 17 | |
| | 18 | @library{wxhtml} |
| | 19 | @category{FIXME} |
| | 20 | */ |
| | 21 | class wxHtmlHelpDialog : public wxFrame |
| | 22 | { |
| | 23 | public: |
| | 24 | //@{ |
| | 25 | /** |
| | 26 | Constructor. For the values of @e style, please see the documentation for |
| | 27 | wxHtmlHelpController. |
| | 28 | */ |
| | 29 | wxHtmlHelpDialog(wxHtmlHelpData* data = NULL); |
| | 30 | wxHtmlHelpDialog(wxWindow* parent, int wxWindowID, |
| | 31 | const wxString& title = wxEmptyString, |
| | 32 | int style = wxHF_DEFAULT_STYLE, |
| | 33 | wxHtmlHelpData* data = NULL); |
| | 34 | //@} |
| | 35 | |
| | 36 | /** |
| | 37 | You may override this virtual method to add more buttons to the help window's |
| | 38 | toolbar. @a toolBar is a pointer to the toolbar and @a style is the style |
| | 39 | flag as passed to the Create method. |
| | 40 | wxToolBar::Realize is called immediately after returning from this function. |
| | 41 | */ |
| | 42 | virtual void AddToolbarButtons(wxToolBar* toolBar, int style); |
| | 43 | |
| | 44 | /** |
| | 45 | Creates the dialog. See @ref wxhtmlhelpdialog() "the constructor" |
| | 46 | for a description of the parameters. |
| | 47 | */ |
| | 48 | bool Create(wxWindow* parent, wxWindowID id, |
| | 49 | const wxString& title = wxEmptyString, |
| | 50 | int style = wxHF_DEFAULT_STYLE); |
| | 51 | |
| | 52 | /** |
| | 53 | Returns the help controller associated with the dialog. |
| | 54 | */ |
| | 55 | wxHtmlHelpController* GetController() const; |
| | 56 | |
| | 57 | /** |
| | 58 | Reads the user's settings for this dialog see |
| | 59 | wxHtmlHelpController::ReadCustomization) |
| | 60 | */ |
| | 61 | void ReadCustomization(wxConfigBase* cfg, |
| | 62 | const wxString& path = wxEmptyString); |
| | 63 | |
| | 64 | /** |
| | 65 | Sets the help controller associated with the dialog. |
| | 66 | */ |
| | 67 | void SetController(wxHtmlHelpController* contoller); |
| | 68 | |
| | 69 | /** |
| | 70 | Sets the dialog's title format. @a format must contain exactly one "%s" |
| | 71 | (it will be replaced by the page title). |
| | 72 | */ |
| | 73 | void SetTitleFormat(const wxString& format); |
| | 74 | |
| | 75 | /** |
| | 76 | Saves the user's settings for this dialog (see |
| | 77 | wxHtmlHelpController::WriteCustomization). |
| | 78 | */ |
| | 79 | void WriteCustomization(wxConfigBase* cfg, |
| | 80 | const wxString& path = wxEmptyString); |
| | 81 | }; |
| | 82 | |
projects / wxWidgets.git / blame_incremental