]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/generic/helpext.h
Add "inherit" to <font> XRC tag.
[wxWidgets.git] / interface / wx / generic / helpext.h
index 57c84afce95e8523e64f701418d286379c58cb0f..b44be1dd0fd4206621db491a6053d738d8d7fb31 100644 (file)
@@ -3,13 +3,12 @@
 // Purpose:     interface of wxExtHelpController
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 
 /**
     @class wxExtHelpController
-    @wxheader{help.h}
 
     This class implements help via an external browser.
     It requires the name of a directory containing the documentation
@@ -33,7 +32,7 @@
 
     @see wxHelpController
 */
-class wxExtHelpController : public wxHelpController
+class wxExtHelpController : public wxHelpControllerBase
 {
 public:
     wxExtHelpController(wxWindow* parentWindow = NULL);
@@ -53,22 +52,6 @@ public:
     virtual void SetViewer(const wxString& viewer = wxEmptyString,
                            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 server);
-
     /**
         This must be called to tell the controller where to find the
         documentation.
@@ -100,7 +83,7 @@ public:
 
         @return @true on success
     */
-    virtual bool DisplayContents(void);
+    virtual bool DisplayContents();
 
     /**
         Display help for id sectionNo.
@@ -129,6 +112,10 @@ public:
 
         @param k
             string to search for, empty string will list all entries
+        
+        @param mode    
+            optional parameter allows the search the index (wxHELP_SEARCH_INDEX) 
+            but this currently only supported by the wxHtmlHelpController.
 
         @return @true on success
     */
@@ -148,7 +135,7 @@ public:
     /**
         Call the browser using a relative URL.
     */
-    virtual bool DisplayHelp(const wxString &) ;
+    virtual bool DisplayHelp(const wxString& relativeURL) ;
 
     /**
         Allows one to override the default settings for the help frame.