interface/html/helpdlg.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        html/helpdlg.h
   3 // Purpose:     documentation for wxHtmlHelpDialog class
   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. @e toolBar is a pointer to the toolbar and @e style is the style
  39         flag as passed to the Create method.
  40
  41         wxToolBar::Realize is called immediately after returning from this function.
  42     */
  43     virtual void AddToolbarButtons(wxToolBar * toolBar, int style);
  44
  45     /**
  46         Creates the dialog. See @ref wxhtmlhelpdialog() "the constructor"
  47         for a description of the parameters.
  48     */
  49     bool Create(wxWindow* parent, wxWindowID id,
  50                 const wxString& title = wxEmptyString,
  51                 int style = wxHF_DEFAULT_STYLE);
  52
  53     /**
  54         Returns the help controller associated with the dialog.
  55     */
  56     wxHtmlHelpController* GetController();
  57
  58     /**
  59         Reads the user's settings for this dialog see
  60         wxHtmlHelpController::ReadCustomization)
  61     */
  62     void ReadCustomization(wxConfigBase* cfg,
  63                            const wxString& path = wxEmptyString);
  64
  65     /**
  66         Sets the help controller associated with the dialog.
  67     */
  68     void SetController(wxHtmlHelpController* contoller);
  69
  70     /**
  71         Sets the dialog's title format. @e format must contain exactly one "%s"
  72         (it will be replaced by the page title).
  73     */
  74     void SetTitleFormat(const wxString& format);
  75
  76     /**
  77         Saves the user's settings for this dialog (see
  78         wxHtmlHelpController::WriteCustomization).
  79     */
  80     void WriteCustomization(wxConfigBase* cfg,
  81                             const wxString& path = wxEmptyString);
  82 };