mac paths updated

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

diff --git a/interface/html/htmlwin.h b/interface/html/htmlwin.h
index e25de195249bd08abea531232561e4aadf07dbd5..3b6ccc2912010cc8733cced982ee0de09414c1ed 100644 (file)
--- a/interface/html/htmlwin.h
+++ b/interface/html/htmlwin.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        html/htmlwin.h
-// Purpose:     documentation for wxHtmlWindow class
+// Purpose:     interface of wxHtmlWindow
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -24,27 +24,26 @@
     wxHtmlWindow::LoadFile.
 
     @beginStyleTable
-    @style{wxHW_SCROLLBAR_NEVER}:
+    @style{wxHW_SCROLLBAR_NEVER}
            Never display scrollbars, not even when the page is larger than the
            window.
-    @style{wxHW_SCROLLBAR_AUTO}:
+    @style{wxHW_SCROLLBAR_AUTO}
            Display scrollbars only if page's size exceeds window's size.
-    @style{wxHW_NO_SELECTION}:
+    @style{wxHW_NO_SELECTION}
            Don't allow the user to select text.
     @endStyleTable
 
     @library{wxhtml}
     @category{html}
 
-    @seealso
-    wxHtmlLinkEvent, wxHtmlCellEvent
+    @see wxHtmlLinkEvent, wxHtmlCellEvent
 */
 class wxHtmlWindow : public wxScrolledWindow
 {
 public:
     //@{
     /**
-        Constructor. The parameters are the same as for the wxScrolledWindow
+        Constructor. The parameters are the same as wxScrolled::wxScrolled()
         constructor.
         
         @param style
@@ -73,7 +72,7 @@ public:
         @param source
             HTML code fragment
         
-        @returns @false if an error occurred, @true otherwise.
+        @return @false if an error occurred, @true otherwise.
     */
     bool AppendToPage(const wxString& source);
 
@@ -82,7 +81,7 @@ public:
         See also: @ref overview_cells "Cells Overview",
         @ref overview_printing
     */
-    wxHtmlContainerCell* GetInternalRepresentation();
+    wxHtmlContainerCell* GetInternalRepresentation() const;
 
     /**
         Returns anchor within currently opened page
@@ -108,7 +107,7 @@ public:
     /**
         Returns the related frame.
     */
-    wxFrame* GetRelatedFrame();
+    wxFrame* GetRelatedFrame() const;
 
     /**
         Moves back to the previous page. (each page displayed using
@@ -141,7 +140,7 @@ public:
     /**
         Loads HTML page from file and displays it.
         
-        @returns @false if an error occurred, @true otherwise
+        @return @false if an error occurred, @true otherwise
         
         @see LoadPage()
     */
@@ -155,7 +154,7 @@ public:
             The address of document. See wxFileSystem for details on address format and
         behaviour of "opener".
         
-        @returns @false if an error occurred, @true otherwise
+        @return @false if an error occurred, @true otherwise
         
         @see LoadFile()
     */
@@ -177,7 +176,7 @@ public:
         @param event
             The mouse event containing other information about the click
         
-        @returns @true if a link was clicked, @false otherwise.
+        @return @true if a link was clicked, @false otherwise.
     */
     virtual bool OnCellClicked(wxHtmlCell cell, wxCoord x, wxCoord y,
                                const wxMouseEvent& event);
@@ -290,7 +289,7 @@ public:
     /**
         Selects the line of text that @a pos points at. Note that @e pos
         is relative to the top of displayed page, not to window's origin, use
-        wxScrolledWindow::CalcUnscrolledPosition
+        wxScrolled::CalcUnscrolledPosition()
         to convert physical coordinate.
         
         @see SelectAll(), SelectWord()
@@ -300,7 +299,7 @@ public:
     /**
         Selects the word at position @e pos. Note that @e pos
         is relative to the top of displayed page, not to window's origin, use
-        wxScrolledWindow::CalcUnscrolledPosition
+        wxScrolled::CalcUnscrolledPosition()
         to convert physical coordinate.
         
         @see SelectAll(), SelectLine()
@@ -352,7 +351,7 @@ public:
         @param source
             The HTML document source to be displayed.
         
-        @returns @false if an error occurred, @true otherwise.
+        @return @false if an error occurred, @true otherwise.
     */
     bool SetPage(const wxString& source);
 
@@ -367,11 +366,25 @@ public:
         @b After calling SetRelatedFrame(),
         this sets statusbar slot where messages will be displayed.
         (Default is -1 = no messages.)
-        
-        @param bar
-            statusbar slot number (0..n)
+
+        @param index
+            Statusbar slot number (0..n)
+    */
+    void SetRelatedStatusBar(int index);
+
+    /**
+        @b Sets the associated statusbar where messages will be displayed.
+        Call this instead of SetRelatedFrame() if you want statusbar updates only,
+        no changing of the frame title.
+
+        @param statusbar
+            Statusbar pointer
+        @param index
+            Statusbar slot number (0..n)
+
+        @since 2.9.0
     */
-    void SetRelatedStatusBar(int bar);
+    void SetRelatedStatusBar(wxStatusBar* statusbar, int index = 0);
 
     /**
         Returns content of currently displayed page as plain text.
@@ -395,6 +408,7 @@ public:
 };
 
 
+
 /**
     @class wxHtmlLinkEvent
     @headerfile htmlwin.h wx/html/htmlwin.h
@@ -416,10 +430,11 @@ public:
         Returns the wxHtmlLinkInfo which contains info about the cell clicked and the
         hyperlink it contains.
     */
-    const wxHtmlLinkInfo GetLinkInfo();
+    const wxHtmlLinkInfo GetLinkInfo() const;
 };
 
 
+
 /**
     @class wxHtmlCellEvent
     @headerfile htmlwin.h wx/html/htmlwin.h
@@ -442,19 +457,19 @@ public:
     /**
         Returns the wxHtmlCellEvent associated with the event.
     */
-    wxHtmlCell* GetCell();
+    wxHtmlCell* GetCell() const;
 
     /**
         Returns @true if @ref setlinkclicked() SetLinkClicked(@true) has previously
         been called;
         @false otherwise.
     */
-    bool GetLinkClicked();
+    bool GetLinkClicked() const;
 
     /**
         Returns the wxPoint associated with the event.
     */
-    wxPoint GetPoint();
+    wxPoint GetPoint() const;
 
     /**
         Call this function with @c linkclicked set to @true if the cell which has
@@ -465,3 +480,4 @@ public:
     */
     bool SetLinkClicked(bool linkclicked);
 };
+