wxMac: wxUniversal integration steps

[wxWidgets.git] / include / wx / generic / helpext.h

diff --git a/include/wx/generic/helpext.h b/include/wx/generic/helpext.h
index ba21f6a33850b0f0fdb15c303f503a317ee1ac76..8cdedc4d8970f186f643a539c2bf5f45fcaa4964 100644 (file)
--- a/include/wx/generic/helpext.h
+++ b/include/wx/generic/helpext.h
@@ -1,12 +1,13 @@
 /*-*- c++ -*-********************************************************
 /*-*- c++ -*-********************************************************

- * exthlp.h - an external help controller for wxWindows             *
+ * helpext.h - an external help controller for wxWindows             *

  *                                                                  *
  * (C) 1998 by Karsten Ballüder (Ballueder@usa.net)                 *
  *                                                                  *
  * $Id$
  *******************************************************************/
  *                                                                  *
  * (C) 1998 by Karsten Ballüder (Ballueder@usa.net)                 *
  *                                                                  *
  * $Id$
  *******************************************************************/

-#ifndef WXXHELP_H
-#define WXXHELP_H
+
+#ifndef __WX_HELPEXT_H_
+#define __WX_HELPEXT_H_

 
 #if wxUSE_HELP
 
 
 #if wxUSE_HELP
 


@@ -14,27 +15,18 @@
 #   pragma interface "wxexthlp.h"
 #endif
 
 #   pragma interface "wxexthlp.h"
 #endif
 

-/// Name for map file.
-#define WXEXTHELP_MAPFILE   "wxhelp.map"
-/// Path separator.
-#define WXEXTHELP_SEPARATOR '/'
+#include "wx/generic/helphtml.h"
+

 #ifndef WXEXTHELP_DEFAULTBROWSER
 /// Default browser name.
 #ifndef WXEXTHELP_DEFAULTBROWSER
 /// Default browser name.

-#   define WXEXTHELP_DEFAULTBROWSER "kdehelp"
+#   define WXEXTHELP_DEFAULTBROWSER "netscape"

 /// Is default browse a variant of netscape?
 /// Is default browse a variant of netscape?

-#   define WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE false
+#   define WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE TRUE

 #endif
 /// Name of environment variable to set help browser.
 #define   WXEXTHELP_ENVVAR_BROWSER   "WX_HELPBROWSER"
 /// Is browser a netscape browser?
 #define   WXEXTHELP_ENVVAR_BROWSERISNETSCAPE "WX_HELPBROWSER_NS"
 #endif
 /// Name of environment variable to set help browser.
 #define   WXEXTHELP_ENVVAR_BROWSER   "WX_HELPBROWSER"
 /// Is browser a netscape browser?
 #define   WXEXTHELP_ENVVAR_BROWSERISNETSCAPE "WX_HELPBROWSER_NS"

-/// Maximum line length in map file.
-#define WXEXTHELP_BUFLEN 512
-/// Character introducing comments/documentation field in map file.
-#define WXEXTHELP_COMMENTCHAR   ';'
-
-class wxExtHelpMapList;
-

 
 /**
    This class implements help via an external browser.
 
 /**
    This class implements help via an external browser.


@@ -55,57 +47,11 @@ class wxExtHelpMapList;
    Lines starting with ';' will be ignored.
 */
 
    Lines starting with ';' will be ignored.
 */
 

-class wxExtHelpController : public wxHelpControllerBase
+class WXDLLEXPORT wxExtHelpController : public wxHTMLHelpControllerBase

 {      
 DECLARE_CLASS(wxExtHelpController)
    public:
    wxExtHelpController(void);
 {      
 DECLARE_CLASS(wxExtHelpController)
    public:
    wxExtHelpController(void);

-   virtual ~wxExtHelpController(void);
-
-   /** This must be called to tell the controller where to find the
-       documentation.
-       @param file - NOT a filename, but a directory name.
-       @return true on success
-   */
-   virtual bool Initialize(const wxString& file, int WXUNUSED(server))
-      { return Initialize(file); }
-      
-   /** This must be called to tell the controller where to find the
-       documentation.
-       @param file - NOT a filename, but a directory name.
-       @return true on success
-   */
-   virtual bool Initialize(const wxString& file);
-  
-   /** If file is "", reloads file given in Initialize.
-       @file Name of help directory.
-       @return true on success
-   */
-   virtual bool LoadFile(const wxString& file = "");
-
-   /** Display list of all help entries.
-       @return true on success
-   */
-   virtual bool DisplayContents(void);
-   /** Display help for id sectionNo.
-       @return true on success
-   */
-   virtual bool DisplaySection(int sectionNo);
-   /** Display help for id sectionNo -- identical with DisplaySection().
-       @return true on success
-   */
-   virtual bool DisplayBlock(long blockNo);
-   /** Search comment/documentation fields in map file and present a
-       list to chose from.
-       @key k string to search for, empty string will list all entries
-       @return true on success
-   */
-   virtual bool KeywordSearch(const wxString& k);
-
-   /// does nothing
-   virtual bool Quit(void);
-   /// does nothing
-   virtual void OnQuit(void);

 
    /** Tell it which browser to use.
        The Netscape support will check whether Netscape is already
 
    /** Tell it which browser to use.
        The Netscape support will check whether Netscape is already


@@ -115,22 +61,22 @@ DECLARE_CLASS(wxExtHelpController)
        @param browsername The command to call a browser/html viewer.
        @param isNetscape Set this to TRUE if the browser is some variant of Netscape.
    */
        @param browsername The command to call a browser/html viewer.
        @param isNetscape Set this to TRUE if the browser is some variant of Netscape.
    */

+   // Obsolete form

    void SetBrowser(wxString const & browsername = WXEXTHELP_DEFAULTBROWSER,
                    bool isNetscape = WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE);
    void SetBrowser(wxString const & browsername = WXEXTHELP_DEFAULTBROWSER,
                    bool isNetscape = WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE);

+
+  // Set viewer: new name for SetBrowser
+  virtual void SetViewer(const wxString& viewer = WXEXTHELP_DEFAULTBROWSER, long flags = wxHELP_NETSCAPE);
+

  private:
  private:

-   /// Filename of currently active map file.
-   wxString         m_MapFile;
-   /// How many entries do we have in the map file?
-   int              m_NumOfEntries;
-   /// A list containing all id,url,documentation triples.
-   wxExtHelpMapList *m_MapList;

    /// How to call the html viewer.
    wxString         m_BrowserName;
    /// Is the viewer a variant of netscape?
    bool             m_BrowserIsNetscape;
    /// Call the browser using a relative URL.
    /// How to call the html viewer.
    wxString         m_BrowserName;
    /// Is the viewer a variant of netscape?
    bool             m_BrowserIsNetscape;
    /// Call the browser using a relative URL.

-   bool CallBrowser(wxString const &);
+   virtual bool DisplayHelp(const wxString&);

 };
 
 };
 

-#endif  
-#endif
+#endif // wxUSE_HELP
+
+#endif // __WX_HELPEXT_H_