interface/wx/html/helpfrm.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        html/helpfrm.h
   3 // Purpose:     interface of wxHtmlHelpFrame
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxHtmlHelpFrame
  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 wxHtmlHelpFrame : public wxFrame
  20 {
  21 public:
  22     wxHtmlHelpFrame(wxHtmlHelpData* data = NULL);
  23
  24     /**
  25         Constructor.
  26
  27         For the possible values of @a style, please see wxHtmlHelpController.
  28     */
  29     wxHtmlHelpFrame(wxWindow* parent, int wxWindowID,
  30                     const wxString& title = wxEmptyString,
  31                     int style = wxHF_DEFAULT_STYLE,
  32                     wxHtmlHelpData* data = NULL,
  33                     wxConfigBase* config = NULL,
  34                     const wxString& rootpath = wxEmptyString);
  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
  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 frame. See @ref wxHtmlHelpFrame() "the constructor"
  47         for a description of the parameters.
  48     */
  49     bool Create(wxWindow* parent, wxWindowID id,
  50                 const wxString& title = wxEmptyString, int style = wxHF_DEFAULT_STYLE,
  51                 wxConfigBase* config = NULL,
  52                 const wxString& rootpath = wxEmptyString);
  53
  54     /**
  55         Returns the help controller associated with the frame.
  56     */
  57     wxHtmlHelpController* GetController() const;
  58
  59     /**
  60         Reads the user's settings for this frame.
  61
  62         @see wxHtmlHelpController::ReadCustomization
  63     */
  64     void ReadCustomization(wxConfigBase* cfg,
  65                            const wxString& path = wxEmptyString);
  66
  67     /**
  68         Sets the help controller associated with the frame.
  69     */
  70     void SetController(wxHtmlHelpController* contoller);
  71
  72     /**
  73         Sets the frame's title format.
  74
  75         @a format must contain exactly one "%s" (it will be replaced by the page title).
  76     */
  77     void SetTitleFormat(const wxString& format);
  78
  79     /**
  80         Saves the user's settings for this frame.
  81
  82         @see wxHtmlHelpController::WriteCustomization
  83     */
  84     void WriteCustomization(wxConfigBase* cfg,
  85                             const wxString& path = wxEmptyString);
  86 };
  87