]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/html/helpfrm.h
Committing in .
[wxWidgets.git] / include / wx / html / helpfrm.h
index 7912e48af9e9c55dbb88e2ddf9b7235571470106..255739841bd3a660296dc983b31637045f5033c0 100644 (file)
@@ -20,6 +20,7 @@
 
 #if wxUSE_WXHTML_HELP
 
+#include "wx/helpbase.h"
 #include "wx/html/helpdata.h"
 #include "wx/window.h"
 #include "wx/frame.h"
@@ -69,6 +70,8 @@ struct wxHtmlHelpFrameCfg
     bool navig_on;
 };
 
+struct wxHtmlHelpMergedIndexItem;
+class wxHtmlHelpMergedIndex;
 
 class WXDLLIMPEXP_CORE wxHelpControllerBase;
 
@@ -112,15 +115,16 @@ public:
     // Displays help window and focuses index.
     bool DisplayIndex();
 
-    // Searches for keyword. Returns TRUE and display page if found, return
-    // FALSE otherwise
+    // Searches for keyword. Returns true and display page if found, return
+    // false otherwise
     // Syntax of keyword is Altavista-like:
     // * words are separated by spaces
     //   (but "\"hello world\"" is only one world "hello world")
     // * word may be pretended by + or -
     //   (+ : page must contain the word ; - : page can't contain the word)
     // * if there is no + or - before the word, + is default
-    bool KeywordSearch(const wxString& keyword);
+    bool KeywordSearch(const wxString& keyword,
+                       wxHelpSearchMode mode = wxHELP_SEARCH_ALL);
 
     void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString)
         {
@@ -137,10 +141,10 @@ public:
 
     // call this to let wxHtmlHelpFrame know page changed
     void NotifyPageChanged();
-    
+
     // Refreshes Contents and Index tabs
     void RefreshLists();
-    
+
 protected:
     void Init(wxHtmlHelpData* data = NULL);
 
@@ -153,6 +157,10 @@ protected:
     // Add books to search choice panel
     void CreateSearch();
 
+    // Updates "merged index" structure that combines indexes of all books
+    // into better searchable structure
+    void UpdateMergedIndex();
+
     // Add custom buttons to toolbar
     virtual void AddToolbarButtons(wxToolBar *toolBar, int style);
 
@@ -232,6 +240,10 @@ protected:
 
     int m_hfStyle;
 
+private:
+    void DisplayIndexItem(const wxHtmlHelpMergedIndexItem *it);
+    wxHtmlHelpMergedIndex *m_mergedIndex;
+
     DECLARE_EVENT_TABLE()
     DECLARE_NO_COPY_CLASS(wxHtmlHelpFrame)
 };