A widget that adds scrolling capabilities to its content. More...
#include <Wt/WScrollArea>
Public Types | |
enum | ScrollBarPolicy { ScrollBarAsNeeded, ScrollBarAlwaysOff, ScrollBarAlwaysOn } |
Public Member Functions | |
WScrollArea (WContainerWidget *parent=0) | |
Creates a scroll area. | |
void | setWidget (WWidget *widget) |
Sets the widget that is the contents of the scroll area. | |
WWidget * | takeWidget () |
Remove the widget content. | |
WWidget * | widget () const |
Returns the widget content. | |
WScrollBar * | horizontalScrollBar () const |
Returns the horizontal scrollbar. | |
WScrollBar * | verticalScrollBar () const |
Returns the vertical scrollbar. | |
void | setScrollBarPolicy (ScrollBarPolicy scrollBarPolicy) |
Returns the policy for both scrollbars. | |
void | setHorizontalScrollBarPolicy (ScrollBarPolicy scrollBarPolicy) |
Returns the horizontal scroll bar policy. | |
void | setVerticalScrollBarPolicy (ScrollBarPolicy scrollBarPolicy) |
Returns the vertical scroll bar policy. |
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.
In many cases, it might be easier to use the CSS overflow property on a WContainerWidget (see WContainerWidget::setOverflow()). However, this class will behave better when used inside a layout manager: in that case it will make sure horizontal scrolling works properly, since otherwise the layout manager would overflow rather than scrollbars appear.
This widget is rendered using a <div>
with a CSS overflow attribute. When in a layout manager it is positioned absolutely. It can be styled using inline or external CSS as appropriate.
void Wt::WScrollArea::setHorizontalScrollBarPolicy | ( | ScrollBarPolicy | scrollBarPolicy ) |
Returns the horizontal scroll bar policy.
void Wt::WScrollArea::setScrollBarPolicy | ( | ScrollBarPolicy | scrollBarPolicy ) |
Returns the policy for both scrollbars.
void Wt::WScrollArea::setVerticalScrollBarPolicy | ( | ScrollBarPolicy | scrollBarPolicy ) |
Returns the vertical scroll bar policy.
void Wt::WScrollArea::setWidget | ( | WWidget * | widget ) |
Sets the widget that is the contents of the scroll area.
Setting a new widget will delete the previously set widget.