added and documented wx_const/static_cast<>

[wxWidgets.git] / include / wx / html / helpctrl.h

diff --git a/include/wx/html/helpctrl.h b/include/wx/html/helpctrl.h
index 8251c044f4d155539e2ef349702396654c36912d..06e6bdc7ee8dee4e219f8cce28e8118856914213 100644 (file)
--- a/include/wx/html/helpctrl.h
+++ b/include/wx/html/helpctrl.h
@@ -14,46 +14,37 @@
 
 #include "wx/defs.h"
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
 #pragma interface "helpctrl.h"
 #endif
 
-#if wxUSE_HTML
+#if wxUSE_WXHTML_HELP
 
-#include "wx/html/helpfrm.h"
 #include "wx/helpbase.h"
+#include "wx/html/helpfrm.h"
 
-class WXDLLEXPORT wxHtmlHelpController : public wxHelpControllerBase // wxEvtHandler
+#define wxID_HTML_HELPFRAME   (wxID_HIGHEST + 1)
+
+class WXDLLIMPEXP_HTML wxHtmlHelpController : public wxHelpControllerBase // wxEvtHandler
 {
     DECLARE_DYNAMIC_CLASS(wxHtmlHelpController)
 
 public:
-    wxHtmlHelpController(int style = wxHF_DEFAULTSTYLE);
+    wxHtmlHelpController(int style = wxHF_DEFAULT_STYLE);
     virtual ~wxHtmlHelpController();
 
     void SetTitleFormat(const wxString& format);
     void SetTempDir(const wxString& path) { m_helpData.SetTempDir(path); }
-    bool AddBook(const wxString& book, bool show_wait_msg = FALSE);
-    bool Display(const wxString& x)
-    {
-        CreateHelpWindow(); return m_helpFrame->Display(x);
-    }
-    bool Display(int id)
-    {
-        CreateHelpWindow(); return m_helpFrame->Display(id);
-    }
-    bool DisplayContents()
-    {
-        CreateHelpWindow(); return m_helpFrame->DisplayContents();
-    }
-    bool DisplayIndex()
-    {
-        CreateHelpWindow(); return m_helpFrame->DisplayIndex();
-    }
-    bool KeywordSearch(const wxString& keyword)
-    {
-        CreateHelpWindow(); return m_helpFrame->KeywordSearch(keyword);
-    }
+    bool AddBook(const wxString& book_url, bool show_wait_msg = FALSE);
+    bool AddBook(const wxFileName& book_file, bool show_wait_msg = FALSE);
+
+    bool Display(const wxString& x);
+    bool Display(int id);
+    bool DisplayContents();
+    bool DisplayIndex();
+    bool KeywordSearch(const wxString& keyword,
+                       wxHelpSearchMode mode = wxHELP_SEARCH_ALL);
+
     wxHtmlHelpFrame* GetFrame() { return m_helpFrame; }
     void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString);
 
@@ -68,7 +59,7 @@ public:
     virtual bool Initialize(const wxString& file, int WXUNUSED(server) ) { return Initialize(file); }
     virtual bool Initialize(const wxString& file);
     virtual void SetViewer(const wxString& WXUNUSED(viewer), long WXUNUSED(flags) = 0) {}
-    virtual bool LoadFile(const wxString& file = "");
+    virtual bool LoadFile(const wxString& file = wxT(""));
     virtual bool DisplaySection(int sectionNo);
     virtual bool DisplaySection(const wxString& section) { return Display(section); }
     virtual bool DisplayBlock(long blockNo) { return DisplaySection(blockNo); }
@@ -84,14 +75,18 @@ public:
                                wxPoint *pos = NULL,
                                bool *newFrameEachTime = NULL);
 
-    // Sets the specified book or all books to have the given base path
-    virtual void SetBookBasePath(const wxString& basePath, int which = -1);
+    // Get direct access to help data:
+    wxHtmlHelpData *GetHelpData() { return &m_helpData; }
 
     virtual bool Quit() ;
     virtual void OnQuit() {};
 
     void OnCloseFrame(wxCloseEvent& evt);
 
+    // Make the help controller's frame 'modal' if
+    // needed
+    void AddGrabIfNeeded();
+
 protected:
     virtual wxHtmlHelpFrame* CreateHelpFrame(wxHtmlHelpData *data);
 
@@ -105,8 +100,10 @@ protected:
     wxString            m_titleFormat;
     int                 m_FrameStyle;
     // DECLARE_EVENT_TABLE()
+
+    DECLARE_NO_COPY_CLASS(wxHtmlHelpController)
 };
 
-#endif
+#endif // wxUSE_WXHTML_HELP
 
 #endif // _WX_HELPCTRL_H_