added (and documented) trivial but useful IsSingleLine() and IsMultiLine() text contr...

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

diff --git a/include/wx/html/helpctrl.h b/include/wx/html/helpctrl.h
index 8251c044f4d155539e2ef349702396654c36912d..cd1efd1aee248ea98ea33139ae1c8f37792471e8 100644 (file)
--- a/include/wx/html/helpctrl.h
+++ b/include/wx/html/helpctrl.h
@@ -18,42 +18,31 @@
 #pragma interface "helpctrl.h"
 #endif
 
-#if wxUSE_HTML
+#if wxUSE_WXHTML_HELP
 
 #include "wx/html/helpfrm.h"
 #include "wx/helpbase.h"
 
+#define wxID_HTML_HELPFRAME   (wxID_HIGHEST + 1)
+
 class WXDLLEXPORT 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 Display(const wxString& x);
+    bool Display(int id);
+    bool DisplayContents();
+    bool DisplayIndex();
+    bool KeywordSearch(const wxString& keyword);
+
     wxHtmlHelpFrame* GetFrame() { return m_helpFrame; }
     void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString);
 
@@ -84,14 +73,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);
 
@@ -107,6 +100,6 @@ protected:
     // DECLARE_EVENT_TABLE()
 };
 
-#endif
+#endif // wxUSE_WXHTML_HELP
 
 #endif // _WX_HELPCTRL_H_