added wxEncodingToCodepage() and implemented it properly (using in32 API instead...

[wxWidgets.git] / include / wx / helpbase.h

diff --git a/include/wx/helpbase.h b/include/wx/helpbase.h
index 5cfe17c0b23ffc7e91a0863202493ed70389d9eb..0fd1148aa32c89191ccf5af1936d5abfed2cb242 100644 (file)
--- a/include/wx/helpbase.h
+++ b/include/wx/helpbase.h
@@ -17,13 +17,14 @@
 #endif
 
 #include "wx/defs.h"
+
+#if wxUSE_HELP
+
 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/gdicmn.h"
 #include "wx/frame.h"
 
-#if wxUSE_HELP
-
 // Flags for SetViewer
 #define wxHELP_NETSCAPE     1
 
@@ -31,25 +32,35 @@
 class WXDLLEXPORT wxHelpControllerBase: public wxObject
 {
     DECLARE_CLASS(wxHelpControllerBase)
-        
+
 public:
     inline wxHelpControllerBase() {}
     inline ~wxHelpControllerBase() {};
-    
+
     // Must call this to set the filename and server name.
     // server is only required when implementing TCP/IP-based
     // help controllers.
     virtual bool Initialize(const wxString& WXUNUSED(file), int WXUNUSED(server) ) { return FALSE; }
     virtual bool Initialize(const wxString& WXUNUSED(file)) { return FALSE; }
-    
+
     // Set viewer: only relevant to some kinds of controller
     virtual void SetViewer(const wxString& WXUNUSED(viewer), long WXUNUSED(flags) = 0) {}
-    
+
     // If file is "", reloads file given  in Initialize
     virtual bool LoadFile(const wxString& file = "") = 0;
+
+    // Displays the contents
     virtual bool DisplayContents(void) = 0;
+
+    // Display the given section
     virtual bool DisplaySection(int sectionNo) = 0;
 
+    // Display the section using a context id
+    virtual bool DisplayContextPopup(int WXUNUSED(contextId)) { return FALSE; };
+
+    // Display the text in a popup, if possible
+    virtual bool DisplayTextPopup(const wxString& WXUNUSED(text), const wxPoint& WXUNUSED(pos)) { return FALSE; };
+
     // By default, uses KeywordSection to display a topic. Implementations
     // may override this for more specific behaviour.
     virtual bool DisplaySection(const wxString& section) { return KeywordSearch(section); };
@@ -63,7 +74,7 @@ public:
     {
         // does nothing by default
     }
-    /// Obtains the latest settings used by the help frame and the help 
+    /// Obtains the latest settings used by the help frame and the help
     /// frame.
     virtual wxFrame *GetFrameParameters(wxSize *WXUNUSED(size) = NULL,
         wxPoint *WXUNUSED(pos) = NULL,
@@ -71,49 +82,12 @@ public:
     {
         return (wxFrame*) NULL;// does nothing by default
     }
-    
+
     virtual bool Quit(void) = 0;
     virtual void OnQuit(void) {};
 };
 
-/*
- * wxContextHelp
- * Invokes context-sensitive help. When the user
- * clicks on a window, a wxEVT_HELP event will be sent to that
- * window for the application to display help for.
- */
-
-class WXDLLEXPORT wxContextHelp: public wxObject
-{
-    DECLARE_DYNAMIC_CLASS(wxContextHelp)
-public:
-    wxContextHelp(wxWindow* win = NULL, bool beginHelp = TRUE);
-    ~wxContextHelp();
-
-    bool BeginContextHelp(wxWindow* win);
-    bool EndContextHelp();
-
-    bool EventLoop(const wxCursor& cursor, wxWindow* win);
-    bool DispatchEvent(wxWindow* win, const wxPoint& pt);
-
-#ifdef __WXMSW__
-    bool ProcessHelpMessage(WXMSG* wxmsg, const wxCursor& cursor, wxWindow* win);
-#endif
-
-#ifdef __WXGTK__
-    void SetStatus(bool status, const wxPoint& pt) { m_status = status; m_mousePos = pt; }
-#endif
-
-protected:
-
-    bool    m_inHelp;
-
-#ifdef __WXGTK__
-    bool    m_status; // The user left-clicked
-    wxPoint m_mousePos;
-#endif
-};
-
 #endif // wxUSE_HELP
+
 #endif
 // _WX_HELPBASEH__