|  | Home · All Namespaces · All Classes · Main Classes · Grouped Classes · Modules · Functions |

# Q3ScrollView Class Reference
[Qt3Support module]

The Q3ScrollView widget provides a scrolling area with on-demand scroll bars. More...

     #include <Q3ScrollView>

This class is part of the Qt 3 support library. It is provided to keep old source code working. We strongly advise against using it in new code. See Porting to Qt 4 for more information.

Inherits Q3Frame.

Inherited by Q3CanvasView, Q3GridView, Q3IconView, Q3ListBox, Q3ListView, Q3Table, and Q3TextEdit.

- List of all members, including inherited members
- Obsolete members

### Public Types

- enum ResizePolicy { Default, Manual, AutoOne, AutoOneFit }
- enum ScrollBarMode { Auto, AlwaysOff, AlwaysOn }

### Properties

contentsHeight : const int contentsWidth : const int contentsX : const int contentsY : const int dragAutoScroll : bool | hScrollBarMode : ScrollBarMode resizePolicy : ResizePolicy vScrollBarMode : ScrollBarMode visibleHeight : const int visibleWidth : const int

- 2 properties inherited from Q3Frame
- 6 properties inherited from QFrame
- 57 properties inherited from QWidget
- 1 property inherited from QObject

### Public Functions

- Q3ScrollView ( QWidget * parent = 0, const char * name = 0, Qt::WindowFlags f = 0 )
- ~Q3ScrollView ()
- virtual void addChild ( QWidget * child, int x = 0, int y = 0 )
- int bottomMargin () const
- int childX ( QWidget * child )
- int childY ( QWidget * child )
- QWidget * clipper () const
- int contentsHeight () const
- void contentsToViewport ( int x, int y, int & vx, int & vy ) const
- QPoint contentsToViewport ( const QPoint & p ) const
- int contentsWidth () const
- int contentsX () const
- int contentsY () const
- QWidget * cornerWidget () const
- bool dragAutoScroll () const
- void enableClipper ( bool y )
- ScrollBarMode hScrollBarMode () const
- bool hasStaticBackground () const
- QScrollBar * horizontalScrollBar () const
- bool isHorizontalSliderPressed ()
- bool isVerticalSliderPressed ()
- int leftMargin () const
- virtual void moveChild ( QWidget * child, int x, int y )
- void removeChild ( QWidget * child )
- void repaintContents ( int x, int y, int w, int h, bool erase = true )
- void repaintContents ( const QRect & r, bool erase = true )
- void repaintContents ( bool erase = true )
- ResizePolicy resizePolicy () const
- int rightMargin () const
- virtual void setCornerWidget ( QWidget * corner )
- virtual void setDragAutoScroll ( bool b )
- virtual void setHScrollBarMode ( ScrollBarMode )
- virtual void setMargins ( int left, int top, int right, int bottom )
- virtual void setResizePolicy ( ResizePolicy )
- void setStaticBackground ( bool y )
- virtual void setVScrollBarMode ( ScrollBarMode )
- int topMargin () const
- void updateContents ( int x, int y, int w, int h )
- void updateContents ( const QRect & r )
- void updateContents ()
- ScrollBarMode vScrollBarMode () const
- QScrollBar * verticalScrollBar () const
- QWidget * viewport () const
- QSize viewportSize ( int x, int y ) const
- void viewportToContents ( int vx, int vy, int & x, int & y ) const
- QPoint viewportToContents ( const QPoint & vp ) const
- int visibleHeight () const
- int visibleWidth () const

- 4 public functions inherited from Q3Frame
- 13 public functions inherited from QFrame
- 206 public functions inherited from QWidget
- 29 public functions inherited from QObject
- 12 public functions inherited from QPaintDevice

### Public Slots

- void center ( int x, int y )
- void center ( int x, int y, float xmargin, float ymargin )
- void ensureVisible ( int x, int y )
- void ensureVisible ( int x, int y, int xmargin, int ymargin )
- virtual void resizeContents ( int w, int h )
- void scrollBy ( int dx, int dy )
- virtual void setContentsPos ( int x, int y )
- void updateScrollBars ()

- 19 public slots inherited from QWidget
- 1 public slot inherited from QObject

### Signals

- void contentsMoving ( int x, int y )
- void horizontalSliderPressed ()
- void horizontalSliderReleased ()
- void verticalSliderPressed ()
- void verticalSliderReleased ()

- 1 signal inherited from QWidget
- 1 signal inherited from QObject

### Protected Functions

- virtual void contentsContextMenuEvent ( QContextMenuEvent * e )
- virtual void contentsDragEnterEvent ( QDragEnterEvent * event )
- virtual void contentsDragLeaveEvent ( QDragLeaveEvent * event )
- virtual void contentsDragMoveEvent ( QDragMoveEvent * event )
- virtual void contentsDropEvent ( QDropEvent * event )
- virtual void contentsMouseDoubleClickEvent ( QMouseEvent * e )
- virtual void contentsMouseMoveEvent ( QMouseEvent * e )
- virtual void contentsMousePressEvent ( QMouseEvent * e )
- virtual void contentsMouseReleaseEvent ( QMouseEvent * e )
- virtual void contentsWheelEvent ( QWheelEvent * e )
- virtual void drawContents ( QPainter * p, int clipx, int clipy, int clipw, int cliph )
- virtual void drawContentsOffset ( QPainter * p, int offsetx, int offsety, int clipx, int clipy, int clipw, int cliph )
- virtual bool eventFilter ( QObject * obj, QEvent * e )
- virtual void setHBarGeometry ( QScrollBar & hbar, int x, int y, int w, int h )
- virtual void setVBarGeometry ( QScrollBar & vbar, int x, int y, int w, int h )
- virtual void viewportPaintEvent ( QPaintEvent * pe )
- virtual void viewportResizeEvent ( QResizeEvent * event )

- 5 protected functions inherited from Q3Frame
- 38 protected functions inherited from QWidget
- 7 protected functions inherited from QObject
- 1 protected function inherited from QPaintDevice

### Additional Inherited Members

- 4 static public members inherited from QWidget
- 5 static public members inherited from QObject
- 1 static public member inherited from QPaintDevice
- 1 protected slot inherited from QWidget

## Detailed Description

The Q3ScrollView widget provides a scrolling area with on-demand scroll bars.

The Q3ScrollView is a large canvas - potentially larger than the coordinate system normally supported by the underlying window system. This is important because it is quite easy to go beyond these limitations (e.g. many web pages are more than 32000 pixels high). Additionally, the Q3ScrollView can have QWidgets positioned on it that scroll around with the drawn content. These sub-widgets can also have positions outside the normal coordinate range (but they are still limited in size).

To provide content for the widget, inherit from Q3ScrollView, reimplement drawContents() and use resizeContents() to set the size of the viewed area. Use addChild() and moveChild() to position widgets on the view.

To use Q3ScrollView effectively it is important to understand its widget structure in the three styles of use: a single large child widget, a large panning area with some widgets and a large panning area with many widgets.

### Using One Big Widget

The first, simplest usage of Q3ScrollView (depicted above), is appropriate for scrolling areas that are never more than about 4000 pixels in either dimension (this is about the maximum reliable size on X11 servers). In this usage, you just make one large child in the Q3ScrollView. The child should be a child of the viewport() of the scrollview and be added with addChild():

     Q3ScrollView* sv = new Q3ScrollView(...);
     QWidget *widget = new QWidget(sv->viewport());
     QVBoxLayout *layout = new QVBoxLayout(widget);
     addChild(widget);

You can go on to add arbitrary child widgets to the single child in the scrollview as you would with any widget:

     QLabel* child1 = new QLabel("CHILD", widget);
     QLabel* child2 = new QLabel("CHILD", widget);
     QLabel* child3 = new QLabel("CHILD", widget);
     layout->addWidget(child1);
     layout->addWidget(child2);
     layout->addWidget(child3);
     ...

Here the Q3ScrollView has four children: the viewport(), the verticalScrollBar(), the horizontalScrollBar() and a small cornerWidget(). The viewport() has one child: the QWidget. The QWidget has the three QLabel objects as child widgets. When the view is scrolled, the QWidget is moved; its children move with it as child widgets normally do.

### Using a Very Big View with Some Widgets

The second usage of Q3ScrollView (depicted above) is appropriate when few, if any, widgets are on a very large scrolling area that is potentially larger than 4000 pixels in either dimension. In this usage you call resizeContents() to set the size of the area and reimplement drawContents() to paint the contents. You may also add some widgets by making them children of the viewport() and adding them with addChild() (this is the same as the process for the single large widget in the previous example):

     Q3ScrollView* sv = new Q3ScrollView(...);
     QLabel* child1 = new QLabel("CHILD", sv->viewport());
     sv->addChild(child1);
     QLabel* child2 = new QLabel("CHILD", sv->viewport());
     sv->addChild(child2);
     QLabel* child3 = new QLabel("CHILD", sv->viewport());
     sv->addChild(child3);

Here, the Q3ScrollView has the same four children: the viewport(), the verticalScrollBar(), the horizontalScrollBar() and a small cornerWidget(). The viewport() has the three QLabel objects as child widgets. When the view is scrolled, the scrollview moves the child widgets individually.

### Using a Very Big View with Many Widgets

The final usage of Q3ScrollView (depicted above) is appropriate when many widgets are on a very large scrolling area that is potentially larger than 4000 pixels in either dimension. In this usage you call resizeContents() to set the size of the area and reimplement drawContents() to paint the contents. You then call enableClipper(true) and add widgets, again by making them children of the viewport(), and adding them with addChild():

     Q3ScrollView* sv = new Q3ScrollView(...);
     sv->enableClipper(true);
     QLabel* child1 = new QLabel("CHILD", sv->viewport());
     sv->addChild(child1);
     QLabel* child2 = new QLabel("CHILD", sv->viewport());
     sv->addChild(child2);
     QLabel* child3 = new QLabel("CHILD", sv->viewport());
     sv->addChild(child3);

Here, the Q3ScrollView has four children: the clipper() (not the viewport() this time), the verticalScrollBar(), the horizontalScrollBar() and a small cornerWidget(). The clipper() has one child: the viewport(). The viewport() has the same three labels as child widgets. When the view is scrolled the viewport() is moved; its children move with it as child widgets normally do.

### Details Relevant for All Views

Normally you will use the first or third method if you want any child widgets in the view.

Note that the widget you see in the scrolled area is the viewport() widget, not the Q3ScrollView itself. So to turn mouse tracking on, for example, use viewport()->setMouseTracking(true).

To enable drag-and-drop, you would setAcceptDrops(true) on the Q3ScrollView (because drag-and-drop events propagate to the parent). But to work out the logical position in the view, you would need to map the drop co-ordinate from being relative to the Q3ScrollView to being relative to the contents; use the function viewportToContents() for this.

To handle mouse events on the scrolling area, subclass scrollview as you would subclass other widgets, but rather than reimplementing mousePressEvent(), reimplement contentsMousePressEvent() instead. The contents specific event handlers provide translated events in the coordinate system of the scrollview. If you reimplement mousePressEvent(), you'll get called only when part of the Q3ScrollView is clicked: and the only such part is the "corner" (if you don't set a cornerWidget()) and the frame; everything else is covered up by the viewport, clipper or scroll bars.

When you construct a Q3ScrollView, some of the window flags apply to the viewport() instead of being sent to the QWidget constructor for the Q3ScrollView.

- An image-manipulation widget would use `WNoAutoErase|WStaticContents` because the widget draws all pixels itself, and when its size increases, it only needs a paint event for the new part because the old part remains unchanged.
- A scrolling game widget in which the background scrolls as the characters move might use `WNoAutoErase` (in addition to `WStaticContents`) so that the window system background does not flash in and out during scrolling.
- A word processing widget might use `WNoAutoErase` and repaint itself line by line to get a less-flickery resizing. If the widget is in a mode in which no text justification can take place, it might use `WStaticContents` too, so that it would only get a repaint for the newly visible parts.

Child widgets may be moved using addChild() or moveChild(). Use childX() and childY() to get the position of a child widget.

A widget may be placed in the corner between the vertical and horizontal scroll bars with setCornerWidget(). You can get access to the scroll bars using horizontalScrollBar() and verticalScrollBar(), and to the viewport with viewport(). The scroll view can be scrolled using scrollBy(), ensureVisible(), setContentsPos() or center().

The visible area is given by visibleWidth() and visibleHeight(), and the contents area by contentsWidth() and contentsHeight(). The contents may be repainted using one of the repaintContents() or updateContents() functions.

Coordinate conversion is provided by contentsToViewport() and viewportToContents().

The contentsMoving() signal is emitted just before the contents are moved to a new position.

Warning: Q3ScrollView currently does not erase the background when resized, i.e. you must always clear the background manually in scrollview subclasses. This will change in a future version of Qt and we recommend specifying the `WNoAutoErase` flag explicitly.

## Member Type Documentation

### enum Q3ScrollView::ResizePolicy

This enum type is used to control a Q3ScrollView's reaction to resize events.

Constant | Value | Description
--- | --- | ---
`Q3ScrollView::Default` | `0` | the Q3ScrollView selects one of the other settings automatically when it has to. In this version of Qt, Q3ScrollView changes to `Manual` if you resize the contents with resizeContents() and to `AutoOne` if a child is added.
`Q3ScrollView::Manual` | `1` | the contents stays the size set by resizeContents().
`Q3ScrollView::AutoOne` | `2` | if there is only one child widget the contents stays the size of that widget. Otherwise the behavior is undefined.
`Q3ScrollView::AutoOneFit` | `3` | if there is only one child widget the contents stays the size of that widget's sizeHint(). If the scrollview is resized larger than the child's sizeHint(), the child will be resized to fit. If there is more than one child, the behavior is undefined.

### enum Q3ScrollView::ScrollBarMode

This enum type describes the various modes of Q3ScrollView's scroll bars.

Constant | Value | Description
--- | --- | ---
`Q3ScrollView::Auto` | `0` | Q3ScrollView shows a scroll bar when the content is too large to fit and not otherwise. This is the default.
`Q3ScrollView::AlwaysOff` | `1` | Q3ScrollView never shows a scroll bar.
`Q3ScrollView::AlwaysOn` | `2` | Q3ScrollView always shows a scroll bar.

(The modes for the horizontal and vertical scroll bars are independent.)

## Property Documentation

### contentsHeight : const int

This property holds the height of the contents area.

Access functions:

- int contentsHeight () const

### contentsWidth : const int

This property holds the width of the contents area.

Access functions:

- int contentsWidth () const

### contentsX : const int

This property holds the X coordinate of the contents that are at the left edge of the viewport.

Access functions:

- int contentsX () const

### contentsY : const int

This property holds the Y coordinate of the contents that are at the top edge of the viewport.

Access functions:

- int contentsY () const

### dragAutoScroll : bool

This property holds whether autoscrolling in drag move events is enabled.

If this property is set to true (the default), the Q3ScrollView automatically scrolls the contents in drag move events if the user moves the cursor close to a border of the view. Of course this works only if the viewport accepts drops. Specifying false disables this autoscroll feature.

Access functions:

- bool dragAutoScroll () const
- virtual void setDragAutoScroll ( bool b )

### hScrollBarMode : ScrollBarMode

This property holds the mode for the horizontal scroll bar.

The default mode is Q3ScrollView::Auto.

Access functions:

- ScrollBarMode hScrollBarMode () const
- virtual void setHScrollBarMode ( ScrollBarMode )

See also vScrollBarMode.

### resizePolicy : ResizePolicy

This property holds the resize policy.

The default is `Default`.

Access functions:

- ResizePolicy resizePolicy () const
- virtual void setResizePolicy ( ResizePolicy )

See also ResizePolicy.

### vScrollBarMode : ScrollBarMode

This property holds the mode for the vertical scroll bar.

The default mode is Q3ScrollView::Auto.

Access functions:

- ScrollBarMode vScrollBarMode () const
- virtual void setVScrollBarMode ( ScrollBarMode )

See also hScrollBarMode.

### visibleHeight : const int

This property holds the vertical amount of the content that is visible.

Access functions:

- int visibleHeight () const

### visibleWidth : const int

This property holds the horizontal amount of the content that is visible.

Access functions:

- int visibleWidth () const

## Member Function Documentation

### Q3ScrollView::Q3ScrollView ( QWidget * parent = 0, const char * name = 0, Qt::WindowFlags f = 0 )

Constructs a Q3ScrollView called name with parent parent and widget flags f.

The widget flags `WStaticContents`, `WNoAutoErase` and `WPaintClever` are propagated to the viewport() widget. The other widget flags are propagated to the parent constructor as usual.

### Q3ScrollView::~Q3ScrollView ()

Destroys the Q3ScrollView. Any children added with addChild() will be deleted.

### void Q3ScrollView::addChild ( QWidget * child, int x = 0, int y = 0 ) `[virtual]`

Inserts the widget, child, into the scrolled area positioned at (x, y). The position defaults to (0, 0). If the child is already in the view, it is just moved.

You may want to call enableClipper(true) if you add a large number of widgets.

### int Q3ScrollView::bottomMargin () const

Returns the bottom margin.

See also setMargins().

### void Q3ScrollView::center ( int x, int y ) `[slot]`

Scrolls the content so that the point (x, y) is in the center of visible area.

### void Q3ScrollView::center ( int x, int y, float xmargin, float ymargin ) `[slot]`

This is an overloaded member function, provided for convenience.

Scrolls the content so that the point (x, y) is visible with the xmargin and ymargin margins (as fractions of visible the area).

For example:

- Margin 0.0 allows (x, y) to be on the edge of the visible area.
- Margin 0.5 ensures that (x, y) is in middle 50% of the visible area.
- Margin 1.0 ensures that (x, y) is in the center of the the visible area.

### int Q3ScrollView::childX ( QWidget * child )

Returns the X position of the given child widget. Use this rather than QWidget::x() for widgets added to the view.

This function returns 0 if child has not been added to the view.

### int Q3ScrollView::childY ( QWidget * child )

Returns the Y position of the given child widget. Use this rather than QWidget::y() for widgets added to the view.

This function returns 0 if child has not been added to the view.

### QWidget * Q3ScrollView::clipper () const

Returns the clipper widget. Contents in the scrollview are ultimately clipped to be inside the clipper widget.

You should not need to use this function.

See also visibleWidth() and visibleHeight().

### void Q3ScrollView::contentsContextMenuEvent ( QContextMenuEvent * e ) `[virtual protected]`

This event handler is called whenever the Q3ScrollView receives a contextMenuEvent() in e: the mouse position is translated to be a point on the contents.

### void Q3ScrollView::contentsDragEnterEvent ( QDragEnterEvent * event ) `[virtual protected]`

This event handler is called whenever the Q3ScrollView receives a dragEnterEvent(): the drag position is translated to be a point on the contents.

The default implementation does nothing. The event parameter is ignored.

### void Q3ScrollView::contentsDragLeaveEvent ( QDragLeaveEvent * event ) `[virtual protected]`

This event handler is called whenever the Q3ScrollView receives a dragLeaveEvent(): the drag position is translated to be a point on the contents.

The default implementation does nothing. The event parameter is ignored.

### void Q3ScrollView::contentsDragMoveEvent ( QDragMoveEvent * event ) `[virtual protected]`

This event handler is called whenever the Q3ScrollView receives a dragMoveEvent(): the drag position is translated to be a point on the contents.

The default implementation does nothing. The event parameter is ignored.

### void Q3ScrollView::contentsDropEvent ( QDropEvent * event ) `[virtual protected]`

This event handler is called whenever the Q3ScrollView receives a dropEvent(): the drop position is translated to be a point on the contents.

The default implementation does nothing. The event parameter is ignored.

### void Q3ScrollView::contentsMouseDoubleClickEvent ( QMouseEvent * e ) `[virtual protected]`

This event handler is called whenever the Q3ScrollView receives a mouseDoubleClickEvent(): the click position in e is translated to be a point on the contents.

The default implementation generates a normal mouse press event.

### void Q3ScrollView::contentsMouseMoveEvent ( QMouseEvent * e ) `[virtual protected]`

This event handler is called whenever the Q3ScrollView receives a mouseMoveEvent(): the mouse position in e is translated to be a point on the contents.

### void Q3ScrollView::contentsMousePressEvent ( QMouseEvent * e ) `[virtual protected]`

This event handler is called whenever the Q3ScrollView receives a mousePressEvent(): the press position in e is translated to be a point on the contents.

### void Q3ScrollView::contentsMouseReleaseEvent ( QMouseEvent * e ) `[virtual protected]`

This event handler is called whenever the Q3ScrollView receives a mouseReleaseEvent(): the release position in e is translated to be a point on the contents.

### void Q3ScrollView::contentsMoving ( int x, int y ) `[signal]`

This signal is emitted just before the contents are moved to position (x, y).

See also contentsX() and contentsY().

### void Q3ScrollView::contentsToViewport ( int x, int y, int & vx, int & vy ) const

Translates a point (x, y) in the contents to a point (vx, vy) on the viewport() widget.

### QPoint Q3ScrollView::contentsToViewport ( const QPoint & p ) const

This is an overloaded member function, provided for convenience.

Returns the point p translated to a point on the viewport() widget.

### void Q3ScrollView::contentsWheelEvent ( QWheelEvent * e ) `[virtual protected]`

This event handler is called whenever the Q3ScrollView receives a wheelEvent() in e: the mouse position is translated to be a point on the contents.

### QWidget * Q3ScrollView::cornerWidget () const

Returns the widget in the corner between the two scroll bars.

By default, no corner widget is present.

See also setCornerWidget().

### void Q3ScrollView::drawContents ( QPainter * p, int clipx, int clipy, int clipw, int cliph ) `[virtual protected]`

Reimplement this function if you are viewing a drawing area rather than a widget.

The function should draw the rectangle (clipx, clipy, clipw, cliph) of the contents using painter p. The clip rectangle is in the scrollview's coordinates.

For example:

     {
         // Fill a 40000 by 50000 rectangle at (100000,150000)

         // Calculate the coordinates...
         int x1 = 100000, y1 = 150000;
         int x2 = x1+40000-1, y2 = y1+50000-1;

         // Clip the coordinates so X/Windows will not have problems...
         if (x1 < clipx) x1=clipx;
         if (y1 < clipy) y1=clipy;
         if (x2 > clipx+clipw-1) x2=clipx+clipw-1;
         if (y2 > clipy+cliph-1) y2=clipy+cliph-1;

         // Paint using the small coordinates...
         if (x2 >= x1 && y2 >= y1)
             p->fillRect(x1, y1, x2-x1+1, y2-y1+1, red);
     }

The clip rectangle and translation of the painter p is already set appropriately.

### void Q3ScrollView::drawContentsOffset ( QPainter * p, int offsetx, int offsety, int clipx, int clipy, int clipw, int cliph ) `[virtual protected]`

For backward-compatibility only. It is easier to use drawContents(QPainter*,int,int,int,int).

The default implementation translates the painter appropriately and calls drawContents(QPainter*,int,int,int,int). See drawContents() for an explanation of the parameters p, offsetx, offsety, clipx, clipy, clipw and cliph.

### void Q3ScrollView::enableClipper ( bool y )

When a large numbers of child widgets are in a scrollview, especially if they are close together, the scrolling performance can suffer greatly. If y is true the scrollview will use an extra widget to group child widgets.

Note that you may only call enableClipper() prior to adding widgets.

### void Q3ScrollView::ensureVisible ( int x, int y ) `[slot]`

Scrolls the content so that the point (x, y) is visible with at least 50-pixel margins (if possible, otherwise centered).

### void Q3ScrollView::ensureVisible ( int x, int y, int xmargin, int ymargin ) `[slot]`

This is an overloaded member function, provided for convenience.

Scrolls the content so that the point (x, y) is visible with at least the xmargin and ymargin margins (if possible, otherwise centered).

### bool Q3ScrollView::eventFilter ( QObject * obj, QEvent * e ) `[virtual protected]`

This event filter ensures the scroll bars are updated when a single contents widget is resized, shown, hidden or destroyed; it passes mouse events to the Q3ScrollView. The event is in e and the object is in obj.

Reimplemented from QObject.

### bool Q3ScrollView::hasStaticBackground () const

Returns true if Q3ScrollView uses a static background; otherwise returns false.

See also setStaticBackground().

### QScrollBar * Q3ScrollView::horizontalScrollBar () const

Returns the component horizontal scroll bar. It is made available to allow accelerators, autoscrolling, etc.

It should not be used for other purposes.

This function never returns 0.

### void Q3ScrollView::horizontalSliderPressed () `[signal]`

This signal is emitted whenever the user presses the horizontal slider.

### void Q3ScrollView::horizontalSliderReleased () `[signal]`

This signal is emitted whenever the user releases the horizontal slider.

### bool Q3ScrollView::isHorizontalSliderPressed ()

Returns true if horizontal slider is pressed by user; otherwise returns false.

### bool Q3ScrollView::isVerticalSliderPressed ()

Returns true if vertical slider is pressed by user; otherwise returns false.

### int Q3ScrollView::leftMargin () const

Returns the left margin.

See also setMargins().

### void Q3ScrollView::moveChild ( QWidget * child, int x, int y ) `[virtual]`

Repositions the child widget to (x, y). This function is the same as addChild().

### void Q3ScrollView::removeChild ( QWidget * child )

Removes the child widget from the scrolled area. Note that this happens automatically if the child is deleted.

### void Q3ScrollView::repaintContents ( int x, int y, int w, int h, bool erase = true )

Calls repaint() on a rectangle defined by x, y, w, h, translated appropriately. If the rectangle is not visible, nothing is repainted. If erase is true the background is cleared using the background color.

See also updateContents().

### void Q3ScrollView::repaintContents ( const QRect & r, bool erase = true )

This is an overloaded member function, provided for convenience.

Repaints the contents of rectangle r. If erase is true the background is cleared using the background color.

### void Q3ScrollView::repaintContents ( bool erase = true )

This is an overloaded member function, provided for convenience.

Repaints the contents. If erase is true the background is cleared using the background color.

### void Q3ScrollView::resizeContents ( int w, int h ) `[virtual slot]`

Sets the size of the contents area to w pixels wide and h pixels high and updates the viewport accordingly.

### int Q3ScrollView::rightMargin () const

Returns the right margin.

See also setMargins().

### void Q3ScrollView::scrollBy ( int dx, int dy ) `[slot]`

Scrolls the content by dx to the left and dy upwards.

### void Q3ScrollView::setContentsPos ( int x, int y ) `[virtual slot]`

Scrolls the content so that the point (x, y) is in the top-left corner.

### void Q3ScrollView::setCornerWidget ( QWidget * corner ) `[virtual]`

Sets the widget in the corner between the two scroll bars.

You will probably also want to set at least one of the scroll bar modes to `AlwaysOn`.

Passing 0 shows no widget in the corner.

Any previous corner widget is hidden.

You may call setCornerWidget() with the same widget at different times.

All widgets set here will be deleted by the Q3ScrollView when it is destroyed unless you separately reparent the widget after setting some other corner widget (or 0).

Any newly set widget should have no current parent.

By default, no corner widget is present.

See also cornerWidget(), setVScrollBarMode(), and setHScrollBarMode().

### void Q3ScrollView::setHBarGeometry ( QScrollBar & hbar, int x, int y, int w, int h ) `[virtual protected]`

Called when the horizontal scroll bar geometry changes. This is provided as a protected function so that subclasses can do interesting things such as providing extra buttons in some of the space normally used by the scroll bars.

The default implementation simply gives all the space to hbar. The new geometry is given by x, y, w and h.

See also setVBarGeometry().

### void Q3ScrollView::setMargins ( int left, int top, int right, int bottom ) `[virtual]`

Sets the margins around the scrolling area to left, top, right and bottom. This is useful for applications such as spreadsheets with "locked" rows and columns. The marginal space is inside the frameRect() and is left blank; reimplement drawFrame() or put widgets in the unused area.

By default all margins are zero.

See also frameChanged().

### void Q3ScrollView::setStaticBackground ( bool y )

Sets the scrollview to have a static background if y is true, or a scrolling background if y is false. By default, the background is scrolling.

Be aware that this mode is quite slow, as a full repaint of the visible area has to be triggered on every contents move.

See also hasStaticBackground().

### void Q3ScrollView::setVBarGeometry ( QScrollBar & vbar, int x, int y, int w, int h ) `[virtual protected]`

Called when the vertical scroll bar geometry changes. This is provided as a protected function so that subclasses can do interesting things such as providing extra buttons in some of the space normally used by the scroll bars.

The default implementation simply gives all the space to vbar. The new geometry is given by x, y, w and h.

See also setHBarGeometry().

### int Q3ScrollView::topMargin () const

Returns the top margin.

See also setMargins().

### void Q3ScrollView::updateContents ( int x, int y, int w, int h )

Calls update() on a rectangle defined by x, y, w, h, translated appropriately. If the rectangle is not visible, nothing is repainted.

See also repaintContents().

### void Q3ScrollView::updateContents ( const QRect & r )

This is an overloaded member function, provided for convenience.

Updates the contents in rectangle r

### void Q3ScrollView::updateContents ()

This is an overloaded member function, provided for convenience.

### void Q3ScrollView::updateScrollBars () `[slot]`

Updates scroll bars: all possibilities are considered. You should never need to call this in your code.

### QScrollBar * Q3ScrollView::verticalScrollBar () const

Returns the component vertical scroll bar. It is made available to allow accelerators, autoscrolling, etc.

It should not be used for other purposes.

This function never returns 0.

### void Q3ScrollView::verticalSliderPressed () `[signal]`

This signal is emitted whenever the user presses the vertical slider.

### void Q3ScrollView::verticalSliderReleased () `[signal]`

This signal is emitted whenever the user releases the vertical slider.

### QWidget * Q3ScrollView::viewport () const

Returns the viewport widget of the scrollview. This is the widget containing the contents widget or which is the drawing area.

### void Q3ScrollView::viewportPaintEvent ( QPaintEvent * pe ) `[virtual protected]`

This is a low-level painting routine that draws the viewport contents. Reimplement this if drawContents() is too high-level (for example, if you don't want to open a QPainter on the viewport). The paint event is passed in pe.

### void Q3ScrollView::viewportResizeEvent ( QResizeEvent * event ) `[virtual protected]`

To provide simple processing of events on the contents, this function receives all resize events sent to the viewport.

The default implementation does nothing. The event parameter is ignored.

See also QWidget::resizeEvent().

### QSize Q3ScrollView::viewportSize ( int x, int y ) const

Returns the viewport size for size (x, y).

The viewport size depends on (x, y) (the size of the contents), the size of this widget and the modes of the horizontal and vertical scroll bars.

This function permits widgets that can trade vertical and horizontal space for each other to control scroll bar appearance better. For example, a word processor or web browser can control the width of the right margin accurately, whether or not there needs to be a vertical scroll bar.

### void Q3ScrollView::viewportToContents ( int vx, int vy, int & x, int & y ) const

Translates a point (vx, vy) on the viewport() widget to a point (x, y) in the contents.

### QPoint Q3ScrollView::viewportToContents ( const QPoint & vp ) const

This is an overloaded member function, provided for convenience.

Returns the point on the viewport vp translated to a point in the contents.