include/wx/html/helpfrm.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        helpfrm.h
   3 // Purpose:     wxHtmlHelpFrame
   4 // Notes:       Based on htmlhelp.cpp, implementing a monolithic
   5 //              HTML Help controller class,  by Vaclav Slavik
   6 // Author:      Harm van der Heijden and Vaclav Slavik
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Harm van der Heijden and Vaclav Slavik
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_HELPFRM_H_
  13 #define _WX_HELPFRM_H_
  14
  15 #ifdef __GNUG__
  16 #pragma interface
  17 #endif
  18
  19 #include "wx/defs.h"
  20
  21 #if wxUSE_HTML
  22
  23 #include "wx/html/helpdata.h"
  24 #include "wx/window.h"
  25 #include "wx/frame.h"
  26 #include "wx/config.h"
  27 #include "wx/splitter.h"
  28 #include "wx/notebook.h"
  29 #include "wx/listbox.h"
  30 #include "wx/choice.h"
  31 #include "wx/combobox.h"
  32 #include "wx/checkbox.h"
  33 #include "wx/stattext.h"
  34 #include "wx/html/htmlwin.h"
  35 #include "wx/html/htmprint.h"
  36
  37
  38 // style flags for the Help Frame
  39 #define wxHF_TOOLBAR      0x0001
  40 #define wxHF_CONTENTS     0x0002
  41 #define wxHF_INDEX        0x0004
  42 #define wxHF_SEARCH       0x0008
  43 #define wxHF_BOOKMARKS    0x0010
  44 #define wxHF_OPENFILES    0x0020
  45 #define wxHF_PRINT        0x0040
  46 #define wxHF_FLATTOOLBAR  0x0080
  47 #define wxHF_DEFAULTSTYLE (wxHF_TOOLBAR | wxHF_CONTENTS | wxHF_INDEX | \
  48                            wxHF_SEARCH | wxHF_BOOKMARKS | wxHF_PRINT)
  49
  50
  51 // Command IDs :
  52 enum
  53 {
  54     wxID_HTML_PANEL = wxID_HIGHEST + 1,
  55     wxID_HTML_BACK,
  56     wxID_HTML_FORWARD,
  57     wxID_HTML_UPNODE,
  58     wxID_HTML_UP,
  59     wxID_HTML_DOWN,
  60     wxID_HTML_PRINT,
  61     wxID_HTML_OPENFILE,
  62     wxID_HTML_OPTIONS,
  63     wxID_HTML_BOOKMARKSLIST,
  64     wxID_HTML_BOOKMARKSADD,
  65     wxID_HTML_BOOKMARKSREMOVE,
  66     wxID_HTML_TREECTRL,
  67     wxID_HTML_INDEXPAGE,
  68     wxID_HTML_INDEXLIST,
  69     wxID_HTML_INDEXTEXT,
  70     wxID_HTML_INDEXBUTTON,
  71     wxID_HTML_INDEXBUTTONALL,
  72     wxID_HTML_NOTEBOOK,
  73     wxID_HTML_SEARCHPAGE,
  74     wxID_HTML_SEARCHTEXT,
  75     wxID_HTML_SEARCHLIST,
  76     wxID_HTML_SEARCHBUTTON,
  77     wxID_HTML_SEARCHCHOICE,
  78     wxID_HTML_COUNTINFO,
  79     wxID_HTML_HELPFRAME // the id of wxHtmlHelpController's helpframe
  80 }
  81 ;
  82
  83
  84 typedef struct
  85 {
  86     int x, y, w, h;
  87     long sashpos;
  88     bool navig_on;
  89 }
  90 wxHtmlHelpFrameCfg;
  91
  92
  93 class WXDLLEXPORT wxHelpControllerBase;
  94
  95 class WXDLLEXPORT wxHtmlHelpFrame : public wxFrame
  96 {
  97         DECLARE_DYNAMIC_CLASS(wxHtmlHelpFrame)
  98
  99     public:
 100         wxHtmlHelpFrame(wxHtmlHelpData* data = NULL) { Init(data); }
 101         wxHtmlHelpFrame(wxWindow* parent, wxWindowID wxWindowID,
 102                         const wxString& title = wxEmptyString,
 103                         int style = wxHF_DEFAULTSTYLE, wxHtmlHelpData* data = NULL);
 104         bool Create(wxWindow* parent, wxWindowID id, const wxString& title = wxEmptyString,
 105                     int style = wxHF_DEFAULTSTYLE);
 106         ~wxHtmlHelpFrame();
 107
 108         wxHtmlHelpData* GetData() { return m_Data; }
 109         wxHelpControllerBase* GetController() const { return m_helpController; }
 110         void SetController(wxHelpControllerBase* controller) { m_helpController = controller; }
 111
 112         void SetTitleFormat(const wxString& format);
 113         // Sets format of title of the frame. Must contain exactly one "%s"
 114         // (for title of displayed HTML page)
 115
 116         bool Display(const wxString& x);
 117         // Displays page x. If not found it will offect the user a choice of
 118         // searching books.
 119         // Looking for the page runs in these steps:
 120         // 1. try to locate file named x (if x is for example "doc/howto.htm")
 121         // 2. try to open starting page of book x
 122         // 3. try to find x in contents (if x is for example "How To ...")
 123         // 4. try to find x in index (if x is for example "How To ...")
 124         bool Display(const int id);
 125         // Alternative version that works with numeric ID.
 126         // (uses extension to MS format, <param name="ID" value=id>, see docs)
 127
 128         bool DisplayContents();
 129         // Displays help window and focuses contents.
 130
 131         bool DisplayIndex();
 132         // Displays help window and focuses index.
 133
 134         bool KeywordSearch(const wxString& keyword);
 135         // Searches for keyword. Returns TRUE and display page if found, return
 136         // FALSE otherwise
 137         // Syntax of keyword is Altavista-like:
 138         // * words are separated by spaces
 139         //   (but "\"hello world\"" is only one world "hello world")
 140         // * word may be pretended by + or -
 141         //   (+ : page must contain the word ; - : page can't contain the word)
 142         // * if there is no + or - before the word, + is default
 143
 144         void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString)
 145             {
 146                 m_Config = config;
 147                 m_ConfigRoot = rootpath;
 148                 ReadCustomization(config, rootpath);
 149             }
 150
 151         void ReadCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString);
 152         // saves custom settings into cfg config. it will use the path 'path'
 153         // if given, otherwise it will save info into currently selected path.
 154         // saved values : things set by SetFonts, SetBorders.
 155         void WriteCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString);
 156         // ...
 157
 158         void NotifyPageChanged();
 159         // call this to let wxHtmlHelpFrame know page changed
 160
 161     protected:
 162         void Init(wxHtmlHelpData* data = NULL);
 163
 164         void RefreshLists();
 165         // Refreshes Contents and Index tabs
 166
 167         void CreateContents();
 168         // Adds items to m_Contents tree control
 169
 170         void CreateIndex();
 171         // Adds items to m_IndexList
 172
 173         void CreateSearch();
 174         // Add books to search choice panel
 175
 176         virtual void AddToolbarButtons(wxToolBar *toolBar, int style);
 177         // Add custom buttons to toolbar
 178
 179         virtual void OptionsDialog();
 180         // Displays options dialog (fonts etc.)
 181
 182         void OnToolbar(wxCommandEvent& event);
 183         void OnContentsSel(wxTreeEvent& event);
 184         void OnIndexSel(wxCommandEvent& event);
 185         void OnIndexFind(wxCommandEvent& event);
 186         void OnIndexAll(wxCommandEvent& event);
 187         void OnSearchSel(wxCommandEvent& event);
 188         void OnSearch(wxCommandEvent& event);
 189         void OnBookmarksSel(wxCommandEvent& event);
 190         void OnCloseWindow(wxCloseEvent& event);
 191
 192         // Images:
 193         enum {
 194             IMG_Book = 0,
 195             IMG_Folder,
 196             IMG_Page,
 197             IMG_RootFolder
 198         };
 199
 200     protected:
 201         wxHtmlHelpData* m_Data;
 202         bool m_DataCreated;  // m_Data created by frame, or supplied?
 203         wxString m_TitleFormat;  // title of the help frame
 204         // below are various pointers to GUI components
 205         wxHtmlWindow *m_HtmlWin;
 206         wxSplitterWindow *m_Splitter;
 207         wxNotebook *m_NavigPan;
 208         wxTreeCtrl *m_ContentsBox;
 209         wxTextCtrl *m_IndexText;
 210         wxButton *m_IndexButton;
 211         wxButton *m_IndexButtonAll;
 212         wxListBox *m_IndexList;
 213         wxTextCtrl *m_SearchText;
 214         wxButton *m_SearchButton;
 215         wxListBox *m_SearchList;
 216         wxChoice *m_SearchChoice;
 217         wxStaticText *m_IndexCountInfo;
 218         wxCheckBox *m_SearchCaseSensitive;
 219         wxCheckBox *m_SearchWholeWords;
 220
 221         wxComboBox *m_Bookmarks;
 222         wxArrayString m_BookmarksNames, m_BookmarksPages;
 223
 224         wxHtmlHelpFrameCfg m_Cfg;
 225
 226         wxConfigBase *m_Config;
 227         wxString m_ConfigRoot;
 228
 229         // pagenumbers of controls in notebook (usually 0,1,2)
 230         int m_ContentsPage;
 231         int m_IndexPage;
 232         int m_SearchPage;
 233
 234         // lists of available fonts (used in options dialog)
 235         wxArrayString *m_NormalFonts, *m_FixedFonts;
 236         int m_FontSize; // 0,1,2 = small,medium,big
 237         wxString m_NormalFace, m_FixedFace;
 238
 239         bool m_UpdateContents;
 240
 241 #if wxUSE_PRINTING_ARCHITECTURE
 242         wxHtmlEasyPrinting *m_Printer;
 243 #endif
 244         wxHashTable *m_PagesHash;
 245         wxHelpControllerBase* m_helpController;
 246
 247         DECLARE_EVENT_TABLE()
 248 };
 249
 250 #endif // wxUSE_HTML
 251
 252 #endif