add @onlyfor tags to remove further ifacecheck warnings

[wxWidgets.git] / interface / scrolwin.h

diff --git a/interface/scrolwin.h b/interface/scrolwin.h
index 5f6196ef7ded4b4838923d0146f4e09b6583eb7a..eb01f8d60abb4133bf92732896d42d559eb0ee97 100644 (file)
--- a/interface/scrolwin.h
+++ b/interface/scrolwin.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        scrolwin.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        scrolwin.h

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

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


@@ -9,35 +9,35 @@
 /**
     @class wxScrolledWindow
     @wxheader{scrolwin.h}
 /**
     @class wxScrolledWindow
     @wxheader{scrolwin.h}

-    
+

     The wxScrolledWindow class manages scrolling for its client area, transforming
     the coordinates according to the scrollbar positions, and setting the
     scroll positions, thumb sizes and ranges according to the area in view.
     The wxScrolledWindow class manages scrolling for its client area, transforming
     the coordinates according to the scrollbar positions, and setting the
     scroll positions, thumb sizes and ranges according to the area in view.

-    
+

     Starting from version 2.4 of wxWidgets, there are several ways to use a
     wxScrolledWindow. In particular, there are now three ways to set the
     size of the scrolling area:
     Starting from version 2.4 of wxWidgets, there are several ways to use a
     wxScrolledWindow. In particular, there are now three ways to set the
     size of the scrolling area:

-    
+

     One way is to set the scrollbars directly using a call to
     wxScrolledWindow::SetScrollbars.
     This is the way it used to be in any previous version of wxWidgets
     and it will be kept for backwards compatibility.
     One way is to set the scrollbars directly using a call to
     wxScrolledWindow::SetScrollbars.
     This is the way it used to be in any previous version of wxWidgets
     and it will be kept for backwards compatibility.

-    
+

     An additional method of manual control, which requires a little less
     computation of your own, is to set the total size of the scrolling area by
     calling either wxWindow::SetVirtualSize,
     or wxWindow::FitInside, and setting the
     An additional method of manual control, which requires a little less
     computation of your own, is to set the total size of the scrolling area by
     calling either wxWindow::SetVirtualSize,
     or wxWindow::FitInside, and setting the

-    scrolling increments for it by calling 
+    scrolling increments for it by calling

     wxScrolledWindow::SetScrollRate.
     Scrolling in some orientation is enabled by setting a non-zero increment
     for it.
     wxScrolledWindow::SetScrollRate.
     Scrolling in some orientation is enabled by setting a non-zero increment
     for it.

-    
+

     The most automatic and newest way is to simply let sizers determine the
     scrolling area. This is now the default when you set an interior sizer
     into a wxScrolledWindow with wxWindow::SetSizer.
     The scrolling area will be set to the size requested by the sizer and
     the scrollbars will be assigned for each orientation according to the need
     The most automatic and newest way is to simply let sizers determine the
     scrolling area. This is now the default when you set an interior sizer
     into a wxScrolledWindow with wxWindow::SetSizer.
     The scrolling area will be set to the size requested by the sizer and
     the scrollbars will be assigned for each orientation according to the need

-    for them and the scrolling increment set by 
+    for them and the scrolling increment set by

     wxScrolledWindow::SetScrollRate.
     As above, scrolling is only enabled in orientations with a non-zero
     increment.  You can influence the minimum size of the scrolled area
     wxScrolledWindow::SetScrollRate.
     As above, scrolling is only enabled in orientations with a non-zero
     increment.  You can influence the minimum size of the scrolled area


@@ -46,27 +46,27 @@
     (calling wxScrolledWindow::SetScrollbars
      has analogous effects in wxWidgets 2.4 -- in later versions it may not continue
      to override the sizer)
     (calling wxScrolledWindow::SetScrollbars
      has analogous effects in wxWidgets 2.4 -- in later versions it may not continue
      to override the sizer)

-    
+

     Note:  if Maximum size hints are still supported by SetVirtualSizeHints, use
     them at your own dire risk.  They may or may not have been removed for 2.4,
     but it really only makes sense to set minimum size hints here.  We should
     probably replace SetVirtualSizeHints with SetMinVirtualSize or similar
     and remove it entirely in future.
     Note:  if Maximum size hints are still supported by SetVirtualSizeHints, use
     them at your own dire risk.  They may or may not have been removed for 2.4,
     but it really only makes sense to set minimum size hints here.  We should
     probably replace SetVirtualSizeHints with SetMinVirtualSize or similar
     and remove it entirely in future.

-    
+

     As with all windows, an application can draw onto a wxScrolledWindow using
     a @ref overview_dcoverview "device context".
     As with all windows, an application can draw onto a wxScrolledWindow using
     a @ref overview_dcoverview "device context".

-    
+

     You have the option of handling the OnPaint handler
     or overriding the wxScrolledWindow::OnDraw function, which is
     You have the option of handling the OnPaint handler
     or overriding the wxScrolledWindow::OnDraw function, which is

-    passed a pre-scrolled device context (prepared by 
+    passed a pre-scrolled device context (prepared by

     wxScrolledWindow::DoPrepareDC).
     wxScrolledWindow::DoPrepareDC).

-    
+

     If you don't wish to calculate your own scrolling, you must call DoPrepareDC
     when not drawing from
     within OnDraw, to set the device origin for the device context according to the
     current
     scroll position.
     If you don't wish to calculate your own scrolling, you must call DoPrepareDC
     when not drawing from
     within OnDraw, to set the device origin for the device context according to the
     current
     scroll position.

-    
+

     A wxScrolledWindow will normally scroll itself and therefore its child windows
     as well. It
     might however be desired to scroll a different window than itself: e.g. when
     A wxScrolledWindow will normally scroll itself and therefore its child windows
     as well. It
     might however be desired to scroll a different window than itself: e.g. when


@@ -77,7 +77,7 @@
     purpose, you can
     call wxScrolledWindow::SetTargetWindow which means that pressing
     the scrollbars will scroll a different window.
     purpose, you can
     call wxScrolledWindow::SetTargetWindow which means that pressing
     the scrollbars will scroll a different window.

-    
+

     Note that the underlying system knows nothing about scrolling coordinates, so
     that all system
     functions (mouse events, expose events, refresh calls etc) as well as the
     Note that the underlying system knows nothing about scrolling coordinates, so
     that all system
     functions (mouse events, expose events, refresh calls etc) as well as the


@@ -87,17 +87,16 @@
     position (10,10) and scrolls the window down 100 pixels (moving the child
     window out of the visible
     area), the child window will report a position of (10,-90).
     position (10,10) and scrolls the window down 100 pixels (moving the child
     window out of the visible
     area), the child window will report a position of (10,-90).

-    
+

     @beginStyleTable
     @style{wxRETAINED}:
            Uses a backing pixmap to speed refreshes. Motif only.
     @endStyleTable
     @beginStyleTable
     @style{wxRETAINED}:
            Uses a backing pixmap to speed refreshes. Motif only.
     @endStyleTable

-    
+

     @library{wxcore}
     @category{miscwnd}
     @library{wxcore}
     @category{miscwnd}

-    
-    @seealso
-    wxScrollBar, wxClientDC, wxPaintDC, wxVScrolledWindow
+
+    @see wxScrollBar, wxClientDC, wxPaintDC, wxVScrolledWindow

 */
 class wxScrolledWindow : public wxPanel
 {
 */
 class wxScrolledWindow : public wxPanel
 {


@@ -105,37 +104,33 @@ public:
     //@{
     /**
         Constructor.
     //@{
     /**
         Constructor.

-        
-        @param parent 
-        Parent window.
-        
-        @param id 
-        Window identifier. The value wxID_ANY indicates a default value.
-        
-        @param pos 
-        Window position. If a position of (-1, -1) is specified then a default position
-        is chosen.
-        
-        @param size 
-        Window size. If a size of (-1, -1) is specified then the window is sized
-        appropriately.
-        
-        @param style 
-        Window style. See wxScrolledWindow.
-        
-        @param name 
-        Window name.
-        
+
+        @param parent
+            Parent window.
+        @param id
+            Window identifier. The value wxID_ANY indicates a default value.
+        @param pos
+            Window position. If a position of (-1, -1) is specified then a default
+        position
+            is chosen.
+        @param size
+            Window size. If a size of (-1, -1) is specified then the window is sized
+            appropriately.
+        @param style
+            Window style. See wxScrolledWindow.
+        @param name
+            Window name.
+

         @remarks The window is initially created without visible scrollbars. Call
         @remarks The window is initially created without visible scrollbars. Call

-                   SetScrollbars() to specify how big
-                   the virtual window size should be.
+                 SetScrollbars() to specify how big the
+                 virtual window size should be.

     */
     wxScrolledWindow();
     */
     wxScrolledWindow();

-        wxScrolledWindow(wxWindow* parent, wxWindowID id = -1,
-                         const wxPoint& pos = wxDefaultPosition,
-                         const wxSize& size = wxDefaultSize,
-                         long style = wxHSCROLL |  wxVSCROLL,
-                         const wxString& name = "scrolledWindow");
+    wxScrolledWindow(wxWindow* parent, wxWindowID id = -1,
+                     const wxPoint& pos = wxDefaultPosition,
+                     const wxSize& size = wxDefaultSize,
+                     long style = wxHSCROLL | wxVSCROLL,
+                     const wxString& name = "scrolledWindow");

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


@@ -150,10 +145,10 @@ public:
         0)
         (as always), but the logical coordinates are (0, 10) and so the call to
         CalcScrolledPosition(0, 10, xx, yy) will return 0 in yy.
         0)
         (as always), but the logical coordinates are (0, 10) and so the call to
         CalcScrolledPosition(0, 10, xx, yy) will return 0 in yy.

-        
-        @sa CalcUnscrolledPosition()
+
+        @see CalcUnscrolledPosition()

     */
     */

-    void CalcScrolledPosition(int x, int y, int * xx, int * yy);
+    void CalcScrolledPosition(int x, int y, int* xx, int* yy) const;

 
     /**
         Translates the device coordinates to the logical ones. For example, if a window
 
     /**
         Translates the device coordinates to the logical ones. For example, if a window


@@ -162,10 +157,10 @@ public:
         0)
         (as always), but the logical coordinates are (0, 10) and so the call to
         CalcUnscrolledPosition(0, 0, xx, yy) will return 10 in yy.
         0)
         (as always), but the logical coordinates are (0, 10) and so the call to
         CalcUnscrolledPosition(0, 0, xx, yy) will return 10 in yy.

-        
-        @sa CalcScrolledPosition()
+
+        @see CalcScrolledPosition()

     */
     */

-    void CalcUnscrolledPosition(int x, int y, int * xx, int * yy);
+    void CalcUnscrolledPosition(int x, int y, int* xx, int* yy) const;

 
     /**
         Creates the window for two-step construction. Derived classes
 
     /**
         Creates the window for two-step construction. Derived classes


@@ -175,14 +170,13 @@ public:
     bool Create(wxWindow* parent, wxWindowID id = -1,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
     bool Create(wxWindow* parent, wxWindowID id = -1,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,

-                long style = wxHSCROLL |  wxVSCROLL,
+                long style = wxHSCROLL | wxVSCROLL,

                 const wxString& name = "scrolledWindow");
 
     /**
         Call this function to prepare the device context for drawing a scrolled image.
         It
         sets the device origin according to the current scroll position.
                 const wxString& name = "scrolledWindow");
 
     /**
         Call this function to prepare the device context for drawing a scrolled image.
         It
         sets the device origin according to the current scroll position.

-        

         DoPrepareDC is called automatically within the default OnPaint() event
         handler, so your OnDraw() override
         will be passed a 'pre-scrolled' device context. However, if you wish to draw
         DoPrepareDC is called automatically within the default OnPaint() event
         handler, so your OnDraw() override
         will be passed a 'pre-scrolled' device context. However, if you wish to draw


@@ -201,15 +195,14 @@ public:
         scrolling will not work, and you should switch it off. Note that you
         will have to reposition child windows yourself, if physical scrolling
         is disabled.
         scrolling will not work, and you should switch it off. Note that you
         will have to reposition child windows yourself, if physical scrolling
         is disabled.

-        
-        @param xScrolling 
-        If @true, enables physical scrolling in the x direction.
-        
-        @param yScrolling 
-        If @true, enables physical scrolling in the y direction.
-        
+
+        @param xScrolling
+            If @true, enables physical scrolling in the x direction.
+        @param yScrolling
+            If @true, enables physical scrolling in the y direction.
+

         @remarks Physical scrolling may not be available on all platforms. Where
         @remarks Physical scrolling may not be available on all platforms. Where

-                   it is available, it is enabled by default.
+                 it is available, it is enabled by default.

     */
     void EnableScrolling(bool xScrolling, bool yScrolling);
 
     */
     void EnableScrolling(bool xScrolling, bool yScrolling);
 


@@ -217,67 +210,63 @@ public:
         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 direction.
         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 direction.

-        
-        @param xUnit 
-        Receives the number of pixels per horizontal unit.
-        
-        @param yUnit 
-        Receives the number of pixels per vertical unit.
-        
-        @sa SetScrollbars(), GetVirtualSize()
+
+        @param xUnit
+            Receives the number of pixels per horizontal unit.
+        @param yUnit
+            Receives the number of pixels per vertical unit.
+
+        @see SetScrollbars(), GetVirtualSize()

     */
     */

-    void GetScrollPixelsPerUnit(int* xUnit, int* yUnit);
+    void GetScrollPixelsPerUnit(int* xUnit, int* yUnit) const;

 
     /**
         Get the position at which the visible portion of the window starts.
 
     /**
         Get the position at which the visible portion of the window starts.

-        
-        @param x 
-        Receives the first visible x position in scroll units.
-        
-        @param y 
-        Receives the first visible y position in scroll units.
-        
+
+        @param x
+            Receives the first visible x position in scroll units.
+        @param y
+            Receives the first visible y position in scroll units.
+

         @remarks If either of the scrollbars is not at the home position, x
         @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.
-        
-        @sa SetScrollbars()
+                 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.
+
+        @see SetScrollbars()

     */
     */

-    void GetViewStart(int* x, int* y);
+    void GetViewStart(int* x, int* y) const;

 
     /**
         Gets the size in device units of the scrollable window area (as
         opposed to the client size, which is the area of the window currently
         visible).
 
     /**
         Gets the size in device units of the scrollable window area (as
         opposed to the client size, which is the area of the window currently
         visible).

-        
-        @param x 
-        Receives the length of the scrollable window, in pixels.
-        
-        @param y 
-        Receives the height of the scrollable window, in pixels.
-        
+
+        @param x
+            Receives the length of the scrollable window, in pixels.
+        @param y
+            Receives the height of the scrollable window, in pixels.
+

         @remarks Use wxDC::DeviceToLogicalX and wxDC::DeviceToLogicalY to
         @remarks Use wxDC::DeviceToLogicalX and wxDC::DeviceToLogicalY to

-                   translate these units to logical units.
-        
-        @sa SetScrollbars(), GetScrollPixelsPerUnit()
+                 translate these units to logical units.
+
+        @see SetScrollbars(), GetScrollPixelsPerUnit()

     */
     */

-    void GetVirtualSize(int* x, int* y);
+    void GetVirtualSize(int* x, int* y) const;

 
     /**
         Motif only: @true if the window has a backing bitmap.
     */
 
     /**
         Motif only: @true if the window has a backing bitmap.
     */

-    bool IsRetained();
+    bool IsRetained() const;

 
     /**
         Called by the default paint event handler to allow the application to define
 
     /**
         Called by the default paint event handler to allow the application to define

-        painting behaviour without having to worry about calling 
+        painting behaviour without having to worry about calling

         DoPrepareDC().
         DoPrepareDC().

-        

         Instead of overriding this function you may also just process the paint event
         in the derived class as usual, but then you will have to call DoPrepareDC()
         yourself.
         Instead of overriding this function you may also just process the paint event
         in the derived class as usual, but then you will have to call DoPrepareDC()
         yourself.


@@ -285,8 +274,8 @@ public:
     virtual void OnDraw(wxDC& dc);
 
     /**
     virtual void OnDraw(wxDC& dc);
 
     /**

-        This function is for backwards compatibility only and simply calls 
-        DoPrepareDC() now. Notice that it is 
+        This function is for backwards compatibility only and simply calls
+        DoPrepareDC() now. Notice that it is

         not called by the default paint event handle (DoPrepareDC() is), so
         overriding this method in your derived class is useless.
     */
         not called by the default paint event handle (DoPrepareDC() is), so
         overriding this method in your derived class is useless.
     */


@@ -294,20 +283,19 @@ public:
 
     /**
         Scrolls a window so the view start is at the given point.
 
     /**
         Scrolls a window so the view start is at the given point.

-        
-        @param x 
-        The x position to scroll to, in scroll units.
-        
-        @param y 
-        The y position to scroll to, in scroll units.
-        
+
+        @param x
+            The x position to scroll to, in scroll units.
+        @param y
+            The y position to scroll to, in scroll units.
+

         @remarks The positions are in scroll units, not pixels, so to convert to
         @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
-                   -1, that position will be ignored (no change in that
-                   direction).
-        
-        @sa SetScrollbars(), GetScrollPixelsPerUnit()
+                 pixels you will have to multiply by the number of
+                 pixels per scroll increment. If either parameter is -1,
+                 that position will be ignored (no change in that
+                 direction).
+
+        @see SetScrollbars(), GetScrollPixelsPerUnit()

     */
     void Scroll(int x, int y);
 
     */
     void Scroll(int x, int y);
 


@@ -319,44 +307,38 @@ public:
 
     /**
         Sets up vertical and/or horizontal scrollbars.
 
     /**
         Sets up vertical and/or horizontal scrollbars.

-        
-        @param pixelsPerUnitX 
-        Pixels per scroll unit in the horizontal direction.
-        
-        @param pixelsPerUnitY 
-        Pixels per scroll unit in the vertical direction.
-        
-        @param noUnitsX 
-        Number of units in the horizontal direction.
-        
-        @param noUnitsY 
-        Number of units in the vertical direction.
-        
-        @param xPos 
-        Position to initialize the scrollbars in the horizontal direction, in scroll
-        units.
-        
-        @param yPos 
-        Position to initialize the scrollbars in the vertical direction, in scroll
+
+        @param pixelsPerUnitX
+            Pixels per scroll unit in the horizontal direction.
+        @param pixelsPerUnitY
+            Pixels per scroll unit in the vertical direction.
+        @param noUnitsX
+            Number of units in the horizontal direction.
+        @param noUnitsY
+            Number of units in the vertical direction.
+        @param xPos
+            Position to initialize the scrollbars in the horizontal direction, in
+        scroll units.
+        @param yPos
+            Position to initialize the scrollbars in the vertical direction, in scroll

         units.
         units.

-        
-        @param noRefresh 
-        Will not refresh window if @true.
-        
+        @param noRefresh
+            Will not refresh window if @true.
+

         @remarks The first pair of parameters give the number of pixels per
         @remarks The first pair of parameters give the number of pixels per

-                   'scroll step', i.e. amount moved when the up or down
-                   scroll arrows are pressed. The second pair gives the
-                   length of scrollbar in scroll steps, which sets the
-                   size of the virtual window.
-        
-        @sa wxWindow::SetVirtualSize
+                 'scroll step', i.e. amount moved when the up or down
+                 scroll arrows are pressed. The second pair gives the
+                 length of scrollbar in scroll steps, which sets the
+                 size of the virtual window.
+
+        @see wxWindow::SetVirtualSize

     */
     void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
                        int noUnitsX,
                        int noUnitsY,
                        int xPos = 0,
                        int yPos = 0,
     */
     void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
                        int noUnitsX,
                        int noUnitsY,
                        int xPos = 0,
                        int yPos = 0,

-                       bool noRefresh = @false);
+                       bool noRefresh = false);

 
     /**
         Call this function to tell wxScrolledWindow to perform the actual scrolling on
 
     /**
         Call this function to tell wxScrolledWindow to perform the actual scrolling on


@@ -364,3 +346,4 @@ public:
     */
     void SetTargetWindow(wxWindow* window);
 };
     */
     void SetTargetWindow(wxWindow* window);
 };

+