[ 1713933 ] docs for wxEditableListBox

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

diff --git a/include/wx/generic/helpext.h b/include/wx/generic/helpext.h
index 58ef2bb7bcf242e9482e35b7ad31b9f78b976ed7..ec671668fe262c7ddb4f2aeae7a1d91365823020 100644 (file)
--- a/include/wx/generic/helpext.h
+++ b/include/wx/generic/helpext.h
@@ -1,7 +1,8 @@
 /*-*- 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)                 *

+ * License: wxWindows licence                                       *

  *                                                                  *
  * $Id$
  *******************************************************************/
  *                                                                  *
  * $Id$
  *******************************************************************/


@@ -11,30 +12,8 @@
 
 #if wxUSE_HELP
 
 
 #if wxUSE_HELP
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#   pragma interface "wxexthlp.h"
-#endif
-

 #include "wx/helpbase.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?
-#   define WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE TRUE
-#endif
-

 /**
    This class implements help via an external browser.
    It requires the name of a directory containing the documentation
 /**
    This class implements help via an external browser.
    It requires the name of a directory containing the documentation


@@ -55,26 +34,25 @@ class WXDLLIMPEXP_ADV wxExtHelpMapList;
 */
 
 class WXDLLIMPEXP_ADV wxExtHelpController : public wxHelpControllerBase
 */
 
 class WXDLLIMPEXP_ADV wxExtHelpController : public wxHelpControllerBase

-{      
-DECLARE_CLASS(wxExtHelpController)
-   public:
-   wxExtHelpController();
-   ~wxExtHelpController();
+{
+public:
+   wxExtHelpController(wxWindow* parentWindow = NULL);
+   virtual ~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
-   void SetBrowser(const wxString & browsername = WXEXTHELP_DEFAULTBROWSER,
-                   bool isNetscape = WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE);
+   void SetBrowser(const wxString& browsername = wxEmptyString,
+                   bool isNetscape = false);

 
   // Set viewer: new name for SetBrowser
 
   // Set viewer: new name for SetBrowser

-  virtual void SetViewer(const wxString& viewer = WXEXTHELP_DEFAULTBROWSER, long flags = wxHELP_NETSCAPE);
+  virtual void SetViewer(const wxString& viewer = wxEmptyString,
+                         long flags = wxHELP_NETSCAPE);

 
    /** This must be called to tell the controller where to find the
        documentation.
 
    /** This must be called to tell the controller where to find the
        documentation.


@@ -106,7 +84,7 @@ DECLARE_CLASS(wxExtHelpController)
        @file Name of help directory.
        @return true on success
    */
        @file Name of help directory.
        @return true on success
    */

-   virtual bool LoadFile(const wxString& file = wxT(""));
+   virtual bool LoadFile(const wxString& file = wxEmptyString);

 
    /** Display list of all help entries.
        @return true on success
 
    /** Display list of all help entries.
        @return true on success


@@ -129,7 +107,8 @@ DECLARE_CLASS(wxExtHelpController)
        @key k string to search for, empty string will list all entries
        @return true on success
    */
        @key k string to search for, empty string will list all entries
        @return true on success
    */

-   virtual bool KeywordSearch(const wxString& k);
+   virtual bool KeywordSearch(const wxString& k,
+                              wxHelpSearchMode mode = wxHELP_SEARCH_ALL);

 
    /// does nothing
    virtual bool Quit(void);
 
    /// does nothing
    virtual bool Quit(void);


@@ -143,11 +122,11 @@ DECLARE_CLASS(wxExtHelpController)
    virtual void SetFrameParameters(const wxString& WXUNUSED(title),
                                    const wxSize& WXUNUSED(size),
                                    const wxPoint& WXUNUSED(pos) = wxDefaultPosition,
    virtual void SetFrameParameters(const wxString& WXUNUSED(title),
                                    const wxSize& WXUNUSED(size),
                                    const wxPoint& WXUNUSED(pos) = wxDefaultPosition,

-                                   bool WXUNUSED(newFrameEachTime) = FALSE)
+                                   bool WXUNUSED(newFrameEachTime) = false)

       {
          // does nothing by default
       }
       {
          // 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,
    /// frame.
    virtual wxFrame *GetFrameParameters(wxSize *WXUNUSED(size) = NULL,
                                    wxPoint *WXUNUSED(pos) = NULL,


@@ -156,21 +135,30 @@ DECLARE_CLASS(wxExtHelpController)
          return (wxFrame*) NULL;// does nothing by default
       }
 
          return (wxFrame*) NULL;// does nothing by default
       }
 

- protected:
+protected:

    /// Filename of currently active map file.
    /// Filename of currently active map file.

-   wxString         m_MapFile;
+   wxString         m_helpDir;

    /// How many entries do we have in the map file?
    int              m_NumOfEntries;
    /// A list containing all id,url,documentation triples.
    wxList          *m_MapList;
    /// How many entries do we have in the map file?
    int              m_NumOfEntries;
    /// A list containing all id,url,documentation triples.
    wxList          *m_MapList;

+
+private:
+   // parse a single line of the map file (called by LoadFile())
+   //
+   // return true if the line was valid or false otherwise
+   bool ParseMapFileLine(const wxString& line);
+

    /// Deletes the list and all objects.
    void DeleteList(void);
 
    /// 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;
    /// How to call the html viewer.
    wxString         m_BrowserName;
    /// Is the viewer a variant of netscape?
    bool             m_BrowserIsNetscape;

+
+    DECLARE_CLASS(wxExtHelpController)

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