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
  34     /**
  35         You may override this virtual method to add more buttons to the help window's
  36         toolbar. @a toolBar is a pointer to the toolbar and @a style is the style
  37         flag as passed to the Create() method.
  38
  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 frame. See @ref wxHtmlHelpFrame() "the constructor"
  45         for a description of the parameters.
  46     */
  47     bool Create(wxWindow* parent, wxWindowID id,
  48                 const wxString& title = wxEmptyString, int style = wxHF_DEFAULT_STYLE,
  49                 wxConfigBase* config = NULL,
  50                 const wxString& rootpath = wxEmptyString);
  51
  52     /**
  53         Returns the help controller associated with the frame.
  54     */
  55     wxHtmlHelpController* GetController() const;
  56
  57     /**
  58         Reads the user's settings for this frame.
  59
  60         @see wxHtmlHelpController::ReadCustomization
  61     */
  62     void ReadCustomization(wxConfigBase* cfg,
  63                            const wxString& path = wxEmptyString);
  64
  65     /**
  66         Sets the help controller associated with the frame.
  67     */
  68     void SetController(wxHtmlHelpController* contoller);
  69
  70     /**
  71         Sets the frame's title format.
  72
  73         @a format must contain exactly one "%s" (it will be replaced by the page title).
  74     */
  75     void SetTitleFormat(const wxString& format);
  76
  77     /**
  78         Saves the user's settings for this frame.
  79
  80         @see wxHtmlHelpController::WriteCustomization
  81     */
  82     void WriteCustomization(wxConfigBase* cfg,
  83                             const wxString& path = wxEmptyString);
  84 };
  85