Add support for wxSTB_ELLIPSIZE_* and for wxSTB_SHOW_TIPS flags under wxMSW

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

diff --git a/interface/wx/scrolwin.h b/interface/wx/scrolwin.h
index b3664bee2ef805e7cbd96d48507486aaaeb8f90d..f5762e7e5e77a099873a7101d60d9aac256f89a4 100644 (file)
--- a/interface/wx/scrolwin.h
+++ b/interface/wx/scrolwin.h
@@ -6,6 +6,16 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
+/**
+    Possible values for the second argument of wxScrolled::ShowScrollbars().
+ */
+enum wxScrollbarVisibility
+{
+    wxSHOW_SB_NEVER = -1,   ///< Never show the scrollbar at all.
+    wxSHOW_SB_DEFAULT,      ///< Show scrollbar only if it is needed.
+    wxSHOW_SB_ALWAYS        ///< Always show scrollbar, even if not needed.
+};
+
 /**
 
     The wxScrolled class manages scrolling for its client area, transforming
@@ -125,10 +135,10 @@ public:
         @param id
             Window identifier. The value @c wxID_ANY indicates a default value.
         @param pos
-            Window position. If a position of @c wxDefaultPosition is specified
+            Window position. If a position of ::wxDefaultPosition is specified
             then a default position is chosen.
         @param size
-            Window size. If a size of @c wxDefaultSize is specified then the
+            Window size. If a size of ::wxDefaultSize is specified then the
             window is sized appropriately.
         @param style
             Window style. See wxScrolled.
@@ -237,6 +247,32 @@ public:
     */
     void EnableScrolling(bool xScrolling, bool yScrolling);
 
+    /**
+        Set the scrollbar visibility.
+
+        By default the scrollbar in the corresponding direction is only shown
+        if it is needed, i.e. if the virtual size of the scrolled window in
+        this direction is greater than the current physical window size. Using
+        this function the scrollbar visibility can be changed to be:
+            - wxSHOW_SB_ALWAYS: To always show the scrollbar, even if it is
+                not needed currently (wxALWAYS_SHOW_SB style can be used during
+                the window creation to achieve the same effect but it applies
+                in both directions).
+            - wxSHOW_SB_NEVER: To never show the scrollbar at all. In this case
+                the program should presumably provide some other way for the
+                user to scroll the window.
+            - wxSHOW_SB_DEFAULT: To restore the default behaviour described
+                above.
+
+        @param horz
+            The desired visibility for the horizontal scrollbar.
+        @param vert
+            The desired visibility for the vertical scrollbar.
+
+        @since 2.9.0
+     */
+    void ShowScrollbars(wxScrollbarVisibility horz, wxScrollbarVisibility vert);
+
     /**
         Get the number of pixels per scroll unit (line), in each direction, as
         set by SetScrollbars(). A value of zero indicates no scrolling in that
@@ -251,7 +287,6 @@ public:
     */
     void GetScrollPixelsPerUnit(int* xUnit, int* yUnit) const;
 
-    //@{
     /**
         Get the position at which the visible portion of the window starts.
 
@@ -260,20 +295,24 @@ public:
         @param y
             Receives the first visible y position in scroll units.
 
-        @remarks If either of the scrollbars is not at the home position, x
-                 and/or y will be greater than zero.  Combined with
-                 wxWindow::GetClientSize(), the application can use this
-                 function to efficiently redraw only the visible portion
-                 of the window.  The positions are in logical scroll
-                 units, not pixels, so to convert to pixels you will
-                 have to multiply by the number of pixels per scroll
-                 increment.
+        @remarks
+            If either of the scrollbars is not at the home position, @a x
+            and/or @a y will be greater than zero.
+            Combined with wxWindow::GetClientSize(), the application can use this
+            function to efficiently redraw only the visible portion of the window.
+            The positions are in logical scroll units, not pixels, so to convert
+            to pixels you will have to multiply by the number of pixels per scroll
+            increment.
 
         @see SetScrollbars(), Scroll()
     */
     void GetViewStart(int* x, int* y) const;
+
+    /**
+        This is a simple overload of GetViewStart(int*,int*); see that function
+        for more info.
+    */
     wxPoint GetViewStart() const;
-    //@}
 
     /**
         Gets the size in device units of the scrollable window area (as
@@ -316,7 +355,6 @@ public:
     */
     void PrepareDC(wxDC& dc);
 
-    //@{
     /**
         Scrolls a window so the view start is at the given point.
 
@@ -328,14 +366,17 @@ public:
         @remarks The positions are in scroll units, not pixels, so to convert to
                  pixels you will have to multiply by the number of
                  pixels per scroll increment. If either parameter is
-                 wxDefaultCoord (-1), that position will be ignored (no change
+                 ::wxDefaultCoord (-1), that position will be ignored (no change
                  in that direction).
 
         @see SetScrollbars(), GetScrollPixelsPerUnit()
     */
     void Scroll(int x, int y);
+
+    /**
+        This is an overload of Scroll(int,int); see that function for more info.
+    */
     void Scroll(const wxPoint& pt);
-    //@}
 
     /**
         Set the horizontal and vertical scrolling increment only. See the