include wx/crt.h to get wxUSE_WXVSNPRINTF

[wxWidgets.git] / interface / help.h

diff --git a/interface/help.h b/interface/help.h
index 23b83bf7bc974a9795316de8ddbe3ebfc2a76c93..832d8f48a1937676ad800ba0bfb195a78e93801e 100644 (file)
--- a/interface/help.h
+++ b/interface/help.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        help.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        help.h

-// Purpose:     documentation for wxHelpController class
+// Purpose:     interface of wxHelpController

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -9,37 +9,37 @@
 /**
     @class wxHelpController
     @wxheader{help.h}
 /**
     @class wxHelpController
     @wxheader{help.h}

-    
+

     This is a family of classes by which
     applications may invoke a help viewer to provide on-line help.
     This is a family of classes by which
     applications may invoke a help viewer to provide on-line help.

-    
+

     A help controller allows an application to display help, at the contents
     or at a particular topic, and shut the help program down on termination.
     This avoids proliferation of many instances of the help viewer whenever the
     user requests a different topic via the application's menus or buttons.
     A help controller allows an application to display help, at the contents
     or at a particular topic, and shut the help program down on termination.
     This avoids proliferation of many instances of the help viewer whenever the
     user requests a different topic via the application's menus or buttons.

-    
+

     Typically, an application will create a help controller instance
     when it starts, and immediately call @b Initialize
     to associate a filename with it. The help viewer will only get run, however,
     just before the first call to display something.
     Typically, an application will create a help controller instance
     when it starts, and immediately call @b Initialize
     to associate a filename with it. The help viewer will only get run, however,
     just before the first call to display something.

-    
+

     Most help controller classes actually derive from wxHelpControllerBase and have
     names of the form wxXXXHelpController or wxHelpControllerXXX. An
     appropriate class is aliased to the name wxHelpController for each platform, as
     follows:
     Most help controller classes actually derive from wxHelpControllerBase and have
     names of the form wxXXXHelpController or wxHelpControllerXXX. An
     appropriate class is aliased to the name wxHelpController for each platform, as
     follows:

-    
+

      On desktop Windows, wxCHMHelpController is used (MS HTML Help).
      On Windows CE, wxWinceHelpController is used.
      On all other platforms, wxHtmlHelpController is used if wxHTML is
     compiled into wxWidgets; otherwise wxExtHelpController is used (for invoking an
     external
     browser).
      On desktop Windows, wxCHMHelpController is used (MS HTML Help).
      On Windows CE, wxWinceHelpController is used.
      On all other platforms, wxHtmlHelpController is used if wxHTML is
     compiled into wxWidgets; otherwise wxExtHelpController is used (for invoking an
     external
     browser).

-    
+

     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:
     There are currently the following help controller classes defined:

-    
+

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


@@ -56,7 +56,7 @@
     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.
     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
+     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
     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


@@ -67,28 +67,26 @@
     must add this line to your application initialization: @c
     wxFileSystem::AddHandler(new wxArchiveFSHandler);
     or nothing will be shown in your help window.
     must add this line to your application initialization: @c
     wxFileSystem::AddHandler(new wxArchiveFSHandler);
     or nothing will be shown in your help window.

-    
-    
+
+

     @library{wxbase}
     @category{help}
     @library{wxbase}
     @category{help}

-    
-    @seealso
-    wxHtmlHelpController, wxHTML
+
+    @see wxHtmlHelpController, wxHTML()

 */
 class wxHelpController : public wxObject
 {
 public:
     /**
         Constructs a help instance object, but does not invoke the help viewer.
 */
 class wxHelpController : public wxObject
 {
 public:
     /**
         Constructs a help instance object, but does not invoke the help viewer.

-        

         If you provide a window, it will be used by some help controller classes, such
         as
         wxCHMHelpController, wxWinHelpController and wxHtmlHelpController, as the
         parent for the help window instead of the value of wxApp::GetTopWindow. You can
         If you provide a window, it will be used by some help controller classes, such
         as
         wxCHMHelpController, wxWinHelpController and wxHtmlHelpController, as the
         parent for the help window instead of the value of wxApp::GetTopWindow. You can

-        also change the parent window later with 
+        also change the parent window later with

         SetParentWindow().
     */
         SetParentWindow().
     */

-    wxHelpController(wxWindow* parentWindow = @NULL);
+    wxHelpController(wxWindow* parentWindow = NULL);

 
     /**
         Destroys the help instance, closing down the viewer if it is running.
 
     /**
         Destroys the help instance, closing down the viewer if it is running.


@@ -98,16 +96,11 @@ public:
     /**
         If the help viewer is not running, runs it and displays the file at the given
         block number.
     /**
         If the help viewer is not running, runs it and displays the file at the given
         block number.

-        

         @e WinHelp: Refers to the context number.
         @e WinHelp: Refers to the context number.

-        

         @e MS HTML Help: Refers to the context number.
         @e MS HTML Help: Refers to the context number.

-        

         @e External HTML help: the same as for DisplaySection().
         @e External HTML help: the same as for DisplaySection().

-        

         @e wxHtmlHelpController: @e sectionNo is an identifier as specified in the @c
         .hhc file. See @ref overview_helpformat "Help files format".
         @e wxHtmlHelpController: @e sectionNo is an identifier as specified in the @c
         .hhc file. See @ref overview_helpformat "Help files format".

-        

         This function is for backward compatibility only, and applications should use
         @ref displaysection() wxHelpController instead.
     */
         This function is for backward compatibility only, and applications should use
         @ref displaysection() wxHelpController instead.
     */


@@ -121,7 +114,6 @@ public:
 
     /**
         Displays the section as a popup window using a context id.
 
     /**
         Displays the section as a popup window using a context id.

-        

         Returns @false if unsuccessful or not implemented.
     */
     virtual bool DisplayContextPopup(int contextId);
         Returns @false if unsuccessful or not implemented.
     */
     virtual bool DisplayContextPopup(int contextId);


@@ -129,24 +121,21 @@ public:
     //@{
     /**
         If the help viewer is not running, runs it and displays the given section.
     //@{
     /**
         If the help viewer is not running, runs it and displays the given section.

-        
-        @e WinHelp, MS HTML Help @e sectionNo is a context id.
-        
-        @e External HTML help: wxExtHelpController implements @e sectionNo as an id in
+        @e WinHelp, MS HTML Help @a sectionNo is a context id.
+        @e External HTML help: wxExtHelpController implements @a sectionNo as an id in

         a map file, which is of the form:
         a map file, which is of the form:

-        @e wxHtmlHelpController: @e sectionNo is an identifier as specified in the @c
+
+        @e wxHtmlHelpController: @a sectionNo is an identifier as specified in the @c

         .hhc file. See @ref overview_helpformat "Help files format".
         .hhc file. See @ref overview_helpformat "Help files format".

-        

         See also the help sample for notes on how to specify section numbers for
         various help file formats.
     */
     virtual bool DisplaySection(const wxString& section);
         See also the help sample for notes on how to specify section numbers for
         various help file formats.
     */
     virtual bool DisplaySection(const wxString& section);

-        virtual bool DisplaySection(int sectionNo);
+    virtual bool DisplaySection(int sectionNo);

     //@}
 
     /**
         Displays the text in a popup window, if possible.
     //@}
 
     /**
         Displays the text in a popup window, if possible.

-        

         Returns @false if unsuccessful or not implemented.
     */
     virtual bool DisplayTextPopup(const wxString& text,
         Returns @false if unsuccessful or not implemented.
     */
     virtual bool DisplayTextPopup(const wxString& text,


@@ -154,27 +143,25 @@ public:
 
     /**
         wxHtmlHelpController returns the frame, size and position.
 
     /**
         wxHtmlHelpController returns the frame, size and position.

-        

         For all other help controllers, this function does nothing
         and just returns @NULL.
         For all other help controllers, this function does nothing
         and just returns @NULL.

-        
-        @param viewer 
-        This defaults to "netscape" for wxExtHelpController.
-        
-        @param flags 
-        This defaults to wxHELP_NETSCAPE for wxExtHelpController, indicating
-        that the viewer is a variant of Netscape Navigator.
+
+        @param viewer
+            This defaults to "netscape" for wxExtHelpController.
+        @param flags
+            This defaults to wxHELP_NETSCAPE for wxExtHelpController, indicating
+            that the viewer is a variant of Netscape Navigator.

     */
     */

-    virtual wxFrame * GetFrameParameters(const wxSize * size = @NULL,
-                                         const wxPoint * pos = @NULL,
-                                         bool * newFrameEachTime = @NULL);
+    virtual wxFrame* GetFrameParameters(const wxSize* size = NULL,
+                                        const wxPoint* pos = NULL,
+                                        bool* newFrameEachTime = NULL);

 
     /**
         Returns the window to be used as the parent for the help window. This window is
         used
         by wxCHMHelpController, wxWinHelpController and wxHtmlHelpController.
     */
 
     /**
         Returns the window to be used as the parent for the help window. This window is
         used
         by wxCHMHelpController, wxWinHelpController and wxHtmlHelpController.
     */

-    virtual wxWindow* GetParentWindow();
+    virtual wxWindow* GetParentWindow() const;

 
     //@{
     /**
 
     //@{
     /**


@@ -184,14 +171,13 @@ public:
         This must be called directly after the help instance object is created and
         before
         any attempts to communicate with the viewer.
         This must be called directly after the help instance object is created and
         before
         any attempts to communicate with the viewer.

-        

         You may omit the file extension and a suitable one will be chosen. For
         wxHtmlHelpController, the extensions zip, htb and hhp will be appended while
         searching for
         a suitable file. For WinHelp, the hlp extension is appended.
     */
     virtual bool Initialize(const wxString& file);
         You may omit the file extension and a suitable one will be chosen. For
         wxHtmlHelpController, the extensions zip, htb and hhp will be appended while
         searching for
         a suitable file. For WinHelp, the hlp extension is appended.
     */
     virtual bool Initialize(const wxString& file);

-        virtual bool Initialize(const wxString& file, int server);
+    virtual bool Initialize(const wxString& file, int server);

     //@}
 
     /**
     //@}
 
     /**


@@ -200,13 +186,10 @@ public:
         section. The optional parameter allows the search the index
         (wxHELP_SEARCH_INDEX) but this currently only supported by the
         wxHtmlHelpController.
         section. The optional parameter allows the search the index
         (wxHELP_SEARCH_INDEX) but this currently only supported by the
         wxHtmlHelpController.

-        
-        @e WinHelp, MS HTML Help: If more than one match is found, 
+        @e WinHelp, MS HTML Help: If more than one match is found,

         the first topic is displayed.
         the first topic is displayed.

-        
-        @e External HTML help, simple wxHTML help: If more than one match is found, 
+        @e External HTML help, simple wxHTML help: If more than one match is found,

         a choice of topics is displayed.
         a choice of topics is displayed.

-        

         @e wxHtmlHelpController: see wxHtmlHelpController::KeywordSearch.
     */
     virtual bool KeywordSearch(const wxString& keyWord,
         @e wxHtmlHelpController: see wxHtmlHelpController::KeywordSearch.
     */
     virtual bool KeywordSearch(const wxString& keyWord,


@@ -219,21 +202,18 @@ public:
         already displaying the specified file, it will not be reloaded. This
         member function may be used before each display call in case the user
         has opened another file.
         already displaying the specified file, it will not be reloaded. This
         member function may be used before each display call in case the user
         has opened another file.

-        

         wxHtmlHelpController ignores this call.
     */
     virtual bool LoadFile(const wxString& file = "");
 
     /**
         Overridable member called when this application's viewer is quit by the user.
         wxHtmlHelpController ignores this call.
     */
     virtual bool LoadFile(const wxString& file = "");
 
     /**
         Overridable member called when this application's viewer is quit by the user.

-        

         This does not work for all help controllers.
     */
     virtual bool OnQuit();
 
     /**
         If the viewer is running, quits it by disconnecting.
         This does not work for all help controllers.
     */
     virtual bool OnQuit();
 
     /**
         If the viewer is running, quits it by disconnecting.

-        

         For Windows Help, the viewer will only close if no other application is using
         it.
     */
         For Windows Help, the viewer will only close if no other application is using
         it.
     */


@@ -242,14 +222,13 @@ public:
     /**
         For wxHtmlHelpController, the title is set (again with %s indicating the
         page title) and also the size and position of the frame if the frame is already
     /**
         For wxHtmlHelpController, the title is set (again with %s indicating the
         page title) and also the size and position of the frame if the frame is already

-        open. @e newFrameEachTime is ignored.
-        
+        open. @a newFrameEachTime is ignored.

         For all other help controllers this function has no effect.
     */
         For all other help controllers this function has no effect.
     */

-    virtual void SetFrameParameters(const wxString & title,
-                                    const wxSize & size,
-                                    const wxPoint & pos = wxDefaultPosition,
-                                    bool newFrameEachTime = @false);
+    virtual void SetFrameParameters(const wxString& title,
+                                    const wxSize& size,
+                                    const wxPoint& pos = wxDefaultPosition,
+                                    bool newFrameEachTime = false);

 
     /**
         Sets the window to be used as the parent for the help window. This is used
 
     /**
         Sets the window to be used as the parent for the help window. This is used


@@ -260,8 +239,8 @@ public:
     /**
         Sets detailed viewer information. So far this is only relevant to
         wxExtHelpController.
     /**
         Sets detailed viewer information. So far this is only relevant to
         wxExtHelpController.

-        

         Some examples of usage:
     */
     virtual void SetViewer(const wxString& viewer, long flags);
 };
         Some examples of usage:
     */
     virtual void SetViewer(const wxString& viewer, long flags);
 };

+