Mention Scrolled and wxScrolledWindow

[wxWidgets.git] / interface / html / helpwnd.h

diff --git a/interface/html/helpwnd.h b/interface/html/helpwnd.h
index d4b9855f9ae1897ba0d548cb8598882221915123..192661a0738a50b81743da81a5b1f536344b1d5f 100644 (file)
--- a/interface/html/helpwnd.h
+++ b/interface/html/helpwnd.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/helpwnd.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/helpwnd.h

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

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


@@ -9,32 +9,32 @@
 /**
     @class wxHtmlHelpWindow
     @headerfile helpwnd.h wx/html/helpwnd.h
 /**
     @class wxHtmlHelpWindow
     @headerfile helpwnd.h wx/html/helpwnd.h

-    
-    This class is used by wxHtmlHelpController 
+
+    This class is used by wxHtmlHelpController

     to display help within a frame or dialog, but you can use it yourself to create
     an embedded HTML help window.
     to display help within a frame or dialog, but you can use it yourself to create
     an embedded HTML help window.

-    
+

     For example:
     For example:

-    
+

     @code
     // m_embeddedHelpWindow is a wxHtmlHelpWindow
         // m_embeddedHtmlHelp is a wxHtmlHelpController
     @code
     // m_embeddedHelpWindow is a wxHtmlHelpWindow
         // m_embeddedHtmlHelp is a wxHtmlHelpController

-    
+

         // Create embedded HTML Help window
         m_embeddedHelpWindow = new wxHtmlHelpWindow;
         m_embeddedHtmlHelp.UseConfig(config, rootPath); // Set your own config
     object here
         // Create embedded HTML Help window
         m_embeddedHelpWindow = new wxHtmlHelpWindow;
         m_embeddedHtmlHelp.UseConfig(config, rootPath); // Set your own config
     object here

-        m_embeddedHtmlHelp.SetHelpWindow(m_embeddedHelpWindow);    
+        m_embeddedHtmlHelp.SetHelpWindow(m_embeddedHelpWindow);

         m_embeddedHelpWindow-Create(this,
             wxID_ANY, wxDefaultPosition, GetClientSize(),
         m_embeddedHelpWindow-Create(this,
             wxID_ANY, wxDefaultPosition, GetClientSize(),

-    wxTAB_TRAVERSAL|wxBORDER_NONE, wxHF_DEFAULT_STYLE);        
+    wxTAB_TRAVERSAL|wxBORDER_NONE, wxHF_DEFAULT_STYLE);

         m_embeddedHtmlHelp.AddBook(wxFileName(_T("doc.zip")));
     @endcode
         m_embeddedHtmlHelp.AddBook(wxFileName(_T("doc.zip")));
     @endcode

-    
+

     You should pass the style wxHF_EMBEDDED to the style parameter of
     wxHtmlHelpController to allow
     the embedded window to be destroyed independently of the help controller.
     You should pass the style wxHF_EMBEDDED to the style parameter of
     wxHtmlHelpController to allow
     the embedded window to be destroyed independently of the help controller.

-    
+

     @library{wxhtml}
     @category{FIXME}
 */
     @library{wxhtml}
     @category{FIXME}
 */


@@ -44,29 +44,26 @@ public:
     //@{
     /**
         Constructor.
     //@{
     /**
         Constructor.

-        

         Constructor. For the values of @e helpStyle, please see the documentation for
         wxHtmlHelpController.
     */
         Constructor. For the values of @e helpStyle, please see the documentation for
         wxHtmlHelpController.
     */

-    wxHtmlHelpWindow(wxHtmlHelpData* data = @NULL);
-        wxHtmlHelpWindow(wxWindow* parent, int wxWindowID,
-                         const wxPoint& pos = wxDefaultPosition,
-                         const wxSize& pos = wxDefaultSize,
-                         int style = wxTAB_TRAVERSAL|wxBORDER_NONE,
-                         int helpStyle = wxHF_DEFAULT_STYLE,
-                         wxHtmlHelpData* data = @NULL);
+    wxHtmlHelpWindow(wxHtmlHelpData* data = NULL);
+    wxHtmlHelpWindow(wxWindow* parent, int wxWindowID,
+                     const wxPoint& pos = wxDefaultPosition,
+                     const wxSize& pos = wxDefaultSize,
+                     int style = wxTAB_TRAVERSAL|wxBORDER_NONE,
+                     int helpStyle = wxHF_DEFAULT_STYLE,
+                     wxHtmlHelpData* data = NULL);

     //@}
 
     /**
         You may override this virtual method to add more buttons to the help window's
     //@}
 
     /**
         You may override this virtual method to add more buttons to the help window's

-        toolbar. @e toolBar is a pointer to the toolbar and @e style is the style
+        toolbar. @a toolBar is a pointer to the toolbar and @a style is the style

         flag as passed to the Create method.
         flag as passed to the Create method.

-        

         wxToolBar::Realize is called immediately after returning from this function.
         wxToolBar::Realize is called immediately after returning from this function.

-        

         See @e samples/html/helpview for an example.
     */
         See @e samples/html/helpview for an example.
     */

-    virtual void AddToolbarButtons(wxToolBar * toolBar, int style);
+    virtual void AddToolbarButtons(wxToolBar* toolBar, int style);

 
     /**
         Creates the help window. See @ref wxhtmlhelpwindow() "the constructor"
 
     /**
         Creates the help window. See @ref wxhtmlhelpwindow() "the constructor"


@@ -77,18 +74,16 @@ public:
                 const wxSize& pos = wxDefaultSize,
                 int style = wxTAB_TRAVERSAL|wxBORDER_NONE,
                 int helpStyle = wxHF_DEFAULT_STYLE,
                 const wxSize& pos = wxDefaultSize,
                 int style = wxTAB_TRAVERSAL|wxBORDER_NONE,
                 int helpStyle = wxHF_DEFAULT_STYLE,

-                wxHtmlHelpData* data = @NULL);
+                wxHtmlHelpData* data = NULL);

 
     /**
         Creates contents panel. (May take some time.)
 
     /**
         Creates contents panel. (May take some time.)

-        

         Protected.
     */
     void CreateContents();
 
     /**
         Creates index panel. (May take some time.)
         Protected.
     */
     void CreateContents();
 
     /**
         Creates index panel. (May take some time.)

-        

         Protected.
     */
     void CreateIndex();
         Protected.
     */
     void CreateIndex();


@@ -103,17 +98,15 @@ public:
         Displays page x. If not found it will give the user the choice of
         searching books.
         Looking for the page runs in these steps:
         Displays page x. If not found it will give the user the choice of
         searching books.
         Looking for the page runs in these steps:

-        

          try to locate file named x (if x is for example "doc/howto.htm")
          try to open starting page of book x
          try to find x in contents (if x is for example "How To ...")
          try to find x in index (if x is for example "How To ...")
          try to locate file named x (if x is for example "doc/howto.htm")
          try to open starting page of book x
          try to find x in contents (if x is for example "How To ...")
          try to find x in index (if x is for example "How To ...")

-        

         The second form takes numeric ID as the parameter.
         (uses extension to MS format, param name="ID" value=id)
     */
     bool Display(const wxString& x);
         The second form takes numeric ID as the parameter.
         (uses extension to MS format, param name="ID" value=id)
     */
     bool Display(const wxString& x);

-        bool Display(const int id);
+    bool Display(const int id);

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


@@ -148,13 +141,12 @@ public:
 
     /**
         Refresh all panels. This is necessary if a new book was added.
 
     /**
         Refresh all panels. This is necessary if a new book was added.

-        

         Protected.
     */
     void RefreshLists();
 
     /**
         Protected.
     */
     void RefreshLists();
 
     /**

-        Sets the frame's title format. @e format must contain exactly one "%s"
+        Sets the frame's title format. @a format must contain exactly one "%s"

         (it will be replaced by the page title).
     */
     void SetTitleFormat(const wxString& format);
         (it will be replaced by the page title).
     */
     void SetTitleFormat(const wxString& format);


@@ -173,3 +165,4 @@ public:
     void WriteCustomization(wxConfigBase* cfg,
                             const wxString& path = wxEmptyString);
 };
     void WriteCustomization(wxConfigBase* cfg,
                             const wxString& path = wxEmptyString);
 };

+