Wt::WScrollArea Class Reference

A Widget that adds scrolling capabilities to its content. More...

#include <WScrollArea>

Inherits Wt::WWebWidget.

Inheritance diagram for Wt::WScrollArea:

[legend]List of all members.

Public Types
	ScrollBarAsNeeded
	Automatic.
	ScrollBarAlwaysOff
	Always show a scrollbar.
	ScrollBarAlwaysOn
	Never show a scrollbar.
enum	ScrollBarPolicy { ScrollBarAsNeeded, ScrollBarAlwaysOff, ScrollBarAlwaysOn }
Public Member Functions
	WScrollArea (WContainerWidget *parent=0)
	Create a scroll area.
void	setWidget (WWidget *widget)
	Set the widget that is the contents of the scroll area.
WWidget *	takeWidget ()
	Remove the widget content.
WWidget *	widget () const
	Get the widget content.
WScrollBar *	horizontalScrollBar () const
	Get the horizontal scrollbar.
WScrollBar *	verticalScrollBar () const
	Get the vertical scrollbar.
void	setScrollBarPolicy (ScrollBarPolicy scrollBarPolicy)
	Set the policy for both scrollbars.

---

Detailed Description

A Widget that adds scrolling capabilities to its content.

Use a WScrollArea to add scrolling capabilities to another widget. When the content is bigger than the WScrollArea, scrollbars are added so that the user can still view the entire content.

Use setScrollBarPolicy() to configure if and when the scrollbars may appear.

---

Member Enumeration Documentation

enum Wt::WScrollArea::ScrollBarPolicy

brief Policy for showing a scrollbar.

Enumerator:

ScrollBarAsNeeded	Automatic.
ScrollBarAlwaysOff	Always show a scrollbar.
ScrollBarAlwaysOn	Never show a scrollbar.

---

Member Function Documentation

void Wt::WScrollArea::setScrollBarPolicy

(

ScrollBarPolicy

scrollBarPolicy

)

Set the policy for both scrollbars.

When browsers will support seperate policies for vertical and horizontal, we will split this.

void Wt::WScrollArea::setWidget

(

WWidget *

widget

)

Set the widget that is the contents of the scroll area.

Setting a new widget will delete the previously set widget.

---

The documentation for this class was generated from the following files:

• src/wt/WScrollArea
• src/wt/WScrollArea.C

---