Wt::WScrollArea Class Reference

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

#include <Wt/WScrollArea>

Inheritance diagram for Wt::WScrollArea:

Inheritance graph
[legend]

List of all members.

Public Types

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.
WWidgettakeWidget ()
 Remove the widget content.
WWidgetwidget () const
 Get the widget content.
WScrollBarhorizontalScrollBar () const
 Get the horizontal scrollbar.
WScrollBarverticalScrollBar () const
 Get the vertical scrollbar.
void setScrollBarPolicy (ScrollBarPolicy scrollBarPolicy)
 Set the policy for both scrollbars.
void setHorizontalScrollBarPolicy (ScrollBarPolicy scrollBarPolicy)
 Set the horizontal scroll bar policy.
void setVerticalScrollBarPolicy (ScrollBarPolicy scrollBarPolicy)
 Set the vertical scroll bar policy.


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.

In many cases, it might be easier to use the CSS overflow property


Member Enumeration Documentation

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::setWidget ( WWidget widget  ) 

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

Setting a new widget will delete the previously set widget.

void Wt::WScrollArea::setScrollBarPolicy ( ScrollBarPolicy  scrollBarPolicy  ) 

Set the policy for both scrollbars.

See also:
setHorizontalScrollBarPolicy(), setVerticalScrollBarPolicy()

void Wt::WScrollArea::setHorizontalScrollBarPolicy ( ScrollBarPolicy  scrollBarPolicy  ) 

Set the horizontal scroll bar policy.

See also:
setScrollBarPolicy()

void Wt::WScrollArea::setVerticalScrollBarPolicy ( ScrollBarPolicy  scrollBarPolicy  ) 

Set the vertical scroll bar policy.

See also:
setScrollBarPolicy()


Generated on Mon Nov 3 15:01:02 2008 for Wt by doxygen 1.5.6