interface/wx/html/helpwnd.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        html/helpwnd.h
   3 // Purpose:     interface of wxHtmlHelpWindow
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxHtmlHelpWindow
  11
  12     This class is used by wxHtmlHelpController to display help within a frame or
  13     dialog, but you can use it yourself to create an embedded HTML help window.
  14
  15     For example:
  16     @code
  17         // m_embeddedHelpWindow is a wxHtmlHelpWindow
  18         // m_embeddedHtmlHelp is a wxHtmlHelpController
  19
  20         // Create embedded HTML Help window
  21         m_embeddedHelpWindow = new wxHtmlHelpWindow;
  22         m_embeddedHtmlHelp.UseConfig(config, rootPath); // Set your own config object here
  23         m_embeddedHtmlHelp.SetHelpWindow(m_embeddedHelpWindow);
  24         m_embeddedHelpWindow->Create(this, wxID_ANY, wxDefaultPosition, GetClientSize(),
  25                                      wxTAB_TRAVERSAL|wxBORDER_NONE, wxHF_DEFAULT_STYLE);
  26         m_embeddedHtmlHelp.AddBook(wxFileName(_T("doc.zip")));
  27     @endcode
  28
  29     You should pass the style wxHF_EMBEDDED to the style parameter of
  30     wxHtmlHelpController to allow the embedded window to be destroyed
  31     independently of the help controller.
  32
  33     @library{wxhtml}
  34     @category{help,html}
  35 */
  36 class wxHtmlHelpWindow : public wxWindow
  37 {
  38 public:
  39     wxHtmlHelpWindow(wxHtmlHelpData* data = NULL);
  40
  41     /**
  42         Constructor.
  43
  44         For the values of @a helpStyle, please see the documentation for
  45         wxHtmlHelpController.
  46     */
  47     wxHtmlHelpWindow(wxWindow* parent, int wxWindowID,
  48                      const wxPoint& pos = wxDefaultPosition,
  49                      const wxSize& pos = wxDefaultSize,
  50                      int style = wxTAB_TRAVERSAL|wxBORDER_NONE,
  51                      int helpStyle = wxHF_DEFAULT_STYLE,
  52                      wxHtmlHelpData* data = NULL);
  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         See @c samples/html/helpview for an example.
  61     */
  62     virtual void AddToolbarButtons(wxToolBar* toolBar, int style);
  63
  64     /**
  65         Creates the help window. See @ref wxHtmlHelpWindow() "the constructor"
  66         for a description of the parameters.
  67     */
  68     bool Create(wxWindow* parent, wxWindowID id,
  69                 const wxPoint& pos = wxDefaultPosition,
  70                 const wxSize& size = wxDefaultSize, int style = wxTAB_TRAVERSAL|wxBORDER_NONE,
  71                 int helpStyle = wxHF_DEFAULT_STYLE);
  72
  73     /**
  74         Creates search panel.
  75     */
  76     void CreateSearch();
  77
  78     /**
  79         Displays page x.
  80         If not found it will give the user the choice of searching books.
  81         Looking for the page runs in these steps:
  82         -# try to locate file named x (if x is for example "doc/howto.htm")
  83         -# try to open starting page of book x
  84         -# try to find x in contents (if x is for example "How To ...")
  85         -# try to find x in index (if x is for example "How To ...")
  86     */
  87     bool Display(const wxString& x);
  88
  89     /**
  90         @overload
  91
  92         This form takes numeric ID as the parameter (uses an extension to MS format,
  93         param name="ID" value=id).
  94     */
  95     bool Display(const int id);
  96
  97     /**
  98         Displays contents panel.
  99     */
 100     bool DisplayContents();
 101
 102     /**
 103         Displays index panel.
 104     */
 105     bool DisplayIndex();
 106
 107     /**
 108         Returns the wxHtmlHelpData object, which is usually a pointer to the
 109         controller's data.
 110     */
 111     wxHtmlHelpData* GetData();
 112
 113     /**
 114         Search for given keyword. Optionally it searches through the index
 115         (mode = @c wxHELP_SEARCH_INDEX), default the content (mode = @c wxHELP_SEARCH_ALL).
 116     */
 117     bool KeywordSearch(const wxString& keyword,
 118                        wxHelpSearchMode mode = wxHELP_SEARCH_ALL);
 119
 120     /**
 121         Reads the user's settings for this window.
 122
 123         @see wxHtmlHelpController::ReadCustomization
 124     */
 125     void ReadCustomization(wxConfigBase* cfg,
 126                            const wxString& path = wxEmptyString);
 127
 128     /**
 129         Sets the frame's title format.
 130
 131         @a format must contain exactly one "%s" (it will be replaced by the page title).
 132     */
 133     void SetTitleFormat(const wxString& format);
 134
 135     /**
 136         Associates a wxConfig object with the help window. It is recommended that you
 137         use wxHtmlHelpController::UseConfig instead.
 138     */
 139     void UseConfig(wxConfigBase* config,
 140                    const wxString& rootpath = wxEmptyString);
 141
 142     /**
 143         Saves the user's settings for this window.
 144
 145         @see wxHtmlHelpController::WriteCustomization
 146     */
 147     void WriteCustomization(wxConfigBase* cfg,
 148                             const wxString& path = wxEmptyString);
 149
 150 protected:
 151
 152     /**
 153         Creates contents panel. (May take some time.)
 154     */
 155     void CreateContents();
 156
 157     /**
 158         Creates index panel. (May take some time.)
 159     */
 160     void CreateIndex();
 161
 162     /**
 163         Refresh all panels. This is necessary if a new book was added.
 164     */
 165     void RefreshLists();
 166 };
 167