interface/wx/html/helpdlg.h

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