additional types for carbon events

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

diff --git a/include/wx/generic/helpext.h b/include/wx/generic/helpext.h
index 58ef2bb7bcf242e9482e35b7ad31b9f78b976ed7..aaad7d3ff3abc9b76ae0052bbb69140c669da6be 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,10 +12,6 @@
 
 #if wxUSE_HELP
 
 
 #if wxUSE_HELP
 

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

 #include "wx/helpbase.h"
 
 /// Path separator.
 #include "wx/helpbase.h"
 
 /// Path separator.


@@ -32,7 +29,7 @@ class WXDLLIMPEXP_ADV wxExtHelpMapList;
 /// Default browser name.
 #   define WXEXTHELP_DEFAULTBROWSER _T("netscape")
 /// Is default browse a variant of netscape?
 /// 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
 
 /**


@@ -55,19 +52,19 @@ class WXDLLIMPEXP_ADV wxExtHelpMapList;
 */
 
 class WXDLLIMPEXP_ADV wxExtHelpController : public wxHelpControllerBase
 */
 
 class WXDLLIMPEXP_ADV wxExtHelpController : public wxHelpControllerBase

-{      
+{

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

-   wxExtHelpController();
+   wxExtHelpController(wxWindow* parentWindow = NULL);

    ~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
    ~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

-       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,
    */
    // Obsolete form
    void SetBrowser(const wxString & browsername = WXEXTHELP_DEFAULTBROWSER,


@@ -106,7 +103,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 +126,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 +141,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,