added missing header to fix !USE_PCH compilation

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

diff --git a/include/wx/generic/helpext.h b/include/wx/generic/helpext.h
index 0b8c1dfccfd1b30f072107f60be40799bfb87e6f..ab455e7437cbe57a2d0c4885ad12d383c172098a 100644 (file)
--- a/include/wx/generic/helpext.h
+++ b/include/wx/generic/helpext.h
@@ -1,5 +1,5 @@
 /*-*- c++ -*-********************************************************
 /*-*- c++ -*-********************************************************

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

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


@@ -11,17 +11,28 @@
 
 #if wxUSE_HELP
 
 
 #if wxUSE_HELP
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

 #   pragma interface "wxexthlp.h"
 #endif
 
 #   pragma interface "wxexthlp.h"
 #endif
 

-#include "wx/generic/helphtml.h"
+#include "wx/helpbase.h"
+
+/// Path separator.
+#ifdef __WXMSW__
+#define WXEXTHELP_SEPARATOR _T('\\')
+#elif defined(__WXMAC__)
+#define WXEXTHELP_SEPARATOR _T(':')
+#else
+#define WXEXTHELP_SEPARATOR _T('/')
+#endif
+
+class WXDLLIMPEXP_ADV wxExtHelpMapList;

 
 #ifndef WXEXTHELP_DEFAULTBROWSER
 /// Default browser name.
 #   define WXEXTHELP_DEFAULTBROWSER _T("netscape")
 /// Is default browse a variant of netscape?
 
 #ifndef WXEXTHELP_DEFAULTBROWSER
 /// Default browser name.
 #   define WXEXTHELP_DEFAULTBROWSER _T("netscape")
 /// Is default browse a variant of netscape?

-#   define WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE TRUE
+#   define WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE true

 #endif
 
 /**
 #endif
 
 /**


@@ -43,34 +54,124 @@
    Lines starting with ';' will be ignored.
 */
 
    Lines starting with ';' will be ignored.
 */
 

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

 DECLARE_CLASS(wxExtHelpController)
    public:
 DECLARE_CLASS(wxExtHelpController)
    public:

-   wxExtHelpController(void);
+   wxExtHelpController();
+   ~wxExtHelpController();

 
    /** Tell it which browser to use.
        The Netscape support will check whether Netscape is already
        running (by looking at the .netscape/lock file in the user's
        home directory) and tell it to load the page into the existing
 
    /** Tell it which browser to use.
        The Netscape support will check whether Netscape is already
        running (by looking at the .netscape/lock file in the user's
        home directory) and tell it to load the page into the existing

-       window. 
+       window.

        @param browsername The command to call a browser/html viewer.
        @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 isNetscape Set this to true if the browser is some variant of Netscape.

    */
    // Obsolete form
    */
    // Obsolete form

-   void SetBrowser(wxString const & browsername = WXEXTHELP_DEFAULTBROWSER,
+   void SetBrowser(const wxString & 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);
 
                    bool isNetscape = WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE);
 
   // Set viewer: new name for SetBrowser
   virtual void SetViewer(const wxString& viewer = WXEXTHELP_DEFAULTBROWSER, long flags = wxHELP_NETSCAPE);
 

+   /** This must be called to tell the controller where to find the
+       documentation.
+       If a locale is set, look in file/localename, i.e.
+       If passed "/usr/local/myapp/help" and the current wxLocale is
+       set to be "de", then look in "/usr/local/myapp/help/de/"
+       first and fall back to "/usr/local/myapp/help" if that
+       doesn't exist.
+
+       @param file - NOT a filename, but a directory name.
+       @return true on success
+   */
+   virtual bool Initialize(const wxString& dir, int WXUNUSED(server))
+      { return Initialize(dir); }
+
+   /** This must be called to tell the controller where to find the
+       documentation.
+       If a locale is set, look in file/localename, i.e.
+       If passed "/usr/local/myapp/help" and the current wxLocale is
+       set to be "de", then look in "/usr/local/myapp/help/de/"
+       first and fall back to "/usr/local/myapp/help" if that
+       doesn't exist.
+       @param dir - directory name where to fine the help files
+       @return true on success
+   */
+   virtual bool Initialize(const wxString& dir);
+
+   /** If file is "", reloads file given in Initialize.
+       @file Name of help directory.
+       @return true on success
+   */
+   virtual bool LoadFile(const wxString& file = wxEmptyString);
+
+   /** 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 DisplaySection(const wxString& section);
+   /** Display help for URL (using DisplayHelp) or keyword (using KeywordSearch)
+       @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,
+                              wxHelpSearchMode mode = wxHELP_SEARCH_ALL);
+
+   /// does nothing
+   virtual bool Quit(void);
+   /// does nothing
+   virtual void OnQuit(void);
+
+   /// Call the browser using a relative URL.
+   virtual bool DisplayHelp(const wxString &) ;
+
+   /// Allows one to override the default settings for the help frame.
+   virtual void SetFrameParameters(const wxString& WXUNUSED(title),
+                                   const wxSize& WXUNUSED(size),
+                                   const wxPoint& WXUNUSED(pos) = wxDefaultPosition,
+                                   bool WXUNUSED(newFrameEachTime) = false)
+      {
+         // does nothing by default
+      }
+   /// Obtains the latest settings used by the help frame and the help
+   /// frame.
+   virtual wxFrame *GetFrameParameters(wxSize *WXUNUSED(size) = NULL,
+                                   wxPoint *WXUNUSED(pos) = NULL,
+                                   bool *WXUNUSED(newFrameEachTime) = NULL)
+      {
+         return (wxFrame*) NULL;// does nothing by default
+      }
+
+ protected:
+   /// 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.
+   wxList          *m_MapList;
+   /// Deletes the list and all objects.
+   void DeleteList(void);
+

  private:
    /// How to call the html viewer.
    wxString         m_BrowserName;
    /// Is the viewer a variant of netscape?
    bool             m_BrowserIsNetscape;
  private:
    /// 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.
-   virtual bool DisplayHelp(const wxString&);

 };
 
 #endif // wxUSE_HELP
 };
 
 #endif // wxUSE_HELP