]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/html/htmlwin.h
mac paths updated
[wxWidgets.git] / interface / html / htmlwin.h
index fd3e514d70987181340461b9df448e0947ff3128..3b6ccc2912010cc8733cced982ee0de09414c1ed 100644 (file)
@@ -43,7 +43,7 @@ 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
@@ -72,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);
 
@@ -140,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()
     */
@@ -154,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()
     */
@@ -176,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);
@@ -289,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()
@@ -299,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()
@@ -351,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);
 
@@ -366,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.