Document wxDataViewListModel as common abstract base class for

[wxWidgets.git] / interface / wx / help.h

diff --git a/interface/wx/help.h b/interface/wx/help.h
index c250878f82a3605a4ea9d59f4837d7e6faa2f6bb..ae7ac421fc94740c53e2eff70ae3646fe578795e 100644 (file)
--- a/interface/wx/help.h
+++ b/interface/wx/help.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxHelpController
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxHelpController
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -35,21 +35,21 @@
     The remaining help controller classes need to be named explicitly by an
     application that wishes to make use of them.
 
     The remaining help controller classes need to be named explicitly by an
     application that wishes to make use of them.
 

-    There are currently the following help controller classes defined:
+    The following help controller classes are defined:

     - wxWinHelpController, for controlling Windows Help.
     - wxCHMHelpController, for controlling MS HTML Help. To use this, you need to
     - wxWinHelpController, for controlling Windows Help.
     - wxCHMHelpController, for controlling MS HTML Help. To use this, you need to

-      set wxUSE_MS_HTML_HELP to 1 in setup.h and have htmlhelp.h header from
-      Microsoft's HTML Help kit (you don't need VC++ specific htmlhelp.lib
+      set wxUSE_MS_HTML_HELP to 1 in setup.h and have the htmlhelp.h header from
+      Microsoft's HTML Help kit. (You don't need the VC++-specific htmlhelp.lib

       because wxWidgets loads necessary DLL at runtime and so it works with all
       because wxWidgets loads necessary DLL at runtime and so it works with all

-      compilers).
+      compilers.)

     - wxBestHelpController, for controlling MS HTML Help or, if Microsoft's runtime
       is not available, wxHtmlHelpController. You need to provide @b both CHM and
     - wxBestHelpController, for controlling MS HTML Help or, if Microsoft's runtime
       is not available, wxHtmlHelpController. You need to provide @b both CHM and

-      HTB versions of the help file. For 32bit Windows only.
+      HTB versions of the help file. For wxMSW only.

     - wxExtHelpController, for controlling external browsers under Unix.
       The default browser is Netscape Navigator. The 'help' sample shows its use.
     - wxWinceHelpController, for controlling a simple @c .htm help controller for
       Windows CE applications.
     - wxExtHelpController, for controlling external browsers under Unix.
       The default browser is Netscape Navigator. The 'help' sample shows its use.
     - wxWinceHelpController, for controlling a simple @c .htm help controller for
       Windows CE applications.

-    - wxHtmlHelpController, a sophisticated help controller using wxHTML(), in a
+    - wxHtmlHelpController, a sophisticated help controller using wxHTML, in a

       similar style to the Microsoft HTML Help viewer and using some of the same
       files. Although it has an API compatible with other help controllers, it has
       more advanced features, so it is recommended that you use the specific API
       similar style to the Microsoft HTML Help viewer and using some of the same
       files. Although it has an API compatible with other help controllers, it has
       more advanced features, so it is recommended that you use the specific API


@@ -142,9 +142,16 @@ public:
                                   const wxPoint& pos);
 
     /**
                                   const wxPoint& pos);
 
     /**

-        wxHtmlHelpController returns the frame, size and position.
-        For all other help controllers, this function does nothing and just
-        returns @NULL.
+        For wxHtmlHelpController, returns the latest frame size and position
+        settings and whether a new frame is drawn with each invocation.
+        For all other help controllers, this function does nothing and just returns @NULL.
+
+        @param size
+            The most recent frame size.
+        @param pos
+            The most recent frame position.
+        @param newFrameEachTime
+            @true if a new frame is drawn with each invocation.

     */
     virtual wxFrame* GetFrameParameters(const wxSize* size = NULL,
                                         const wxPoint* pos = NULL,
     */
     virtual wxFrame* GetFrameParameters(const wxSize* size = NULL,
                                         const wxPoint* pos = NULL,


@@ -198,10 +205,10 @@ public:
 
         wxHtmlHelpController ignores this call.
     */
 
         wxHtmlHelpController ignores this call.
     */

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

 
     /**
 
     /**

-        Overridable member called when this application's viewer is quit by the user.
+        Overrideable member called when this application's viewer is quit by the user.

         This does not work for all help controllers.
     */
     virtual bool OnQuit();
         This does not work for all help controllers.
     */
     virtual bool OnQuit();


@@ -213,7 +220,7 @@ public:
     virtual bool Quit();
 
     /**
     virtual bool Quit();
 
     /**

-        For wxHtmlHelpController, the title is set (again with %s indicating the
+        For wxHtmlHelpController, the title is set (with %s indicating the

         page title) and also the size and position of the frame if the frame is
         already open. @a newFrameEachTime is ignored.
 
         page title) and also the size and position of the frame if the frame is
         already open. @a newFrameEachTime is ignored.