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 licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /// style flags for the Help Frame
  10 #define wxHF_TOOLBAR                0x0001
  11 #define wxHF_CONTENTS               0x0002
  12 #define wxHF_INDEX                  0x0004
  13 #define wxHF_SEARCH                 0x0008
  14 #define wxHF_BOOKMARKS              0x0010
  15 #define wxHF_OPEN_FILES             0x0020
  16 #define wxHF_PRINT                  0x0040
  17 #define wxHF_FLAT_TOOLBAR           0x0080
  18 #define wxHF_MERGE_BOOKS            0x0100
  19 #define wxHF_ICONS_BOOK             0x0200
  20 #define wxHF_ICONS_BOOK_CHAPTER     0x0400
  21 #define wxHF_ICONS_FOLDER           0x0000 // this is 0 since it is default
  22 #define wxHF_DEFAULT_STYLE          (wxHF_TOOLBAR | wxHF_CONTENTS | \
  23                                      wxHF_INDEX | wxHF_SEARCH | \
  24                                      wxHF_BOOKMARKS | wxHF_PRINT)
  25
  26
  27 /**
  28     @class wxHtmlHelpFrame
  29
  30     This class is used by wxHtmlHelpController to display help.
  31     It is an internal class and should not be used directly - except for the case
  32     when you're writing your own HTML help controller.
  33
  34     @library{wxhtml}
  35     @category{help,html}
  36 */
  37 class wxHtmlHelpFrame : public wxFrame
  38 {
  39 public:
  40     wxHtmlHelpFrame(wxHtmlHelpData* data = NULL);
  41
  42     /**
  43         Constructor.
  44
  45         For the possible values of @a style, please see wxHtmlHelpController.
  46     */
  47     wxHtmlHelpFrame(wxWindow* parent, wxWindowID id,
  48                     const wxString& title = wxEmptyString,
  49                     int style = wxHF_DEFAULT_STYLE,
  50                     wxHtmlHelpData* data = NULL,
  51                     wxConfigBase* config = NULL,
  52                     const wxString& rootpath = wxEmptyString);
  53
  54     /**
  55         You may override this virtual method to add more buttons to the help window's
  56         toolbar. @a toolBar is a pointer to the toolbar and @a style is the style
  57         flag as passed to the Create() method.
  58
  59         wxToolBar::Realize is called immediately after returning from this function.
  60     */
  61     virtual void AddToolbarButtons(wxToolBar* toolBar, int style);
  62
  63     /**
  64         Creates the frame. See @ref wxHtmlHelpFrame() "the constructor"
  65         for a description of the parameters.
  66     */
  67     bool Create(wxWindow* parent, wxWindowID id,
  68                 const wxString& title = wxEmptyString, int style = wxHF_DEFAULT_STYLE,
  69                 wxConfigBase* config = NULL,
  70                 const wxString& rootpath = wxEmptyString);
  71
  72     /**
  73         Returns the help controller associated with the frame.
  74     */
  75     wxHtmlHelpController* GetController() const;
  76
  77     /**
  78         Sets the help controller associated with the frame.
  79     */
  80     void SetController(wxHtmlHelpController* controller);
  81
  82     /**
  83         Sets the frame's title format.
  84
  85         @a format must contain exactly one "%s" (it will be replaced by the page title).
  86     */
  87     void SetTitleFormat(const wxString& format);
  88 };
  89