Wt
3.2.2
|
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 content of the scroll area. | |
WWidget * | takeWidget () |
Removes 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) |
Sets the policy for both scrollbars. | |
void | setHorizontalScrollBarPolicy (ScrollBarPolicy scrollBarPolicy) |
Sets the horizontal scroll bar policy. | |
void | setVerticalScrollBarPolicy (ScrollBarPolicy scrollBarPolicy) |
Sets the vertical scroll bar policy. | |
ScrollBarPolicy | horizontalScrollBarPolicy () |
Returns the horizontal scroll bar policy. | |
ScrollBarPolicy | verticalScrollBarPolicy () |
Returns the vertical scroll bar policy. | |
![]() | |
WWebWidget (WContainerWidget *parent=0) | |
Construct a WebWidget with a given parent. | |
virtual void | setPositionScheme (PositionScheme scheme) |
Sets the CSS position scheme. | |
virtual PositionScheme | positionScheme () const |
Returns the CSS position scheme. | |
virtual void | setOffsets (const WLength &offset, WFlags< Side > sides=All) |
Sets CSS offsets for a non-statically positioned widget. | |
virtual WLength | offset (Side s) const |
Returns a CSS offset. | |
virtual void | resize (const WLength &width, const WLength &height) |
Resizes the widget. | |
virtual WLength | width () const |
Returns the width. | |
virtual WLength | height () const |
Returns the height. | |
virtual void | setMinimumSize (const WLength &width, const WLength &height) |
Sets a minimum size. | |
virtual WLength | minimumWidth () const |
Returns the minimum width. | |
virtual WLength | minimumHeight () const |
Returns the minimum height. | |
virtual void | setMaximumSize (const WLength &width, const WLength &height) |
Sets a maximum size. | |
virtual WLength | maximumWidth () const |
Returns the maximum width. | |
virtual WLength | maximumHeight () const |
Returns the maximum height. | |
virtual void | setLineHeight (const WLength &height) |
Sets the CSS line height for contained text. | |
virtual WLength | lineHeight () const |
Returns the CSS line height for contained text. | |
virtual void | setFloatSide (Side s) |
Specifies a CSS float side. | |
virtual Side | floatSide () const |
Returns the CSS float side. | |
virtual void | setClearSides (WFlags< Side > sides) |
Sets the sides that should be cleared of floats. | |
virtual WFlags< Side > | clearSides () const |
Returns the sides that should remain empty. | |
virtual void | setMargin (const WLength &margin, WFlags< Side > sides=All) |
Sets CSS margins around the widget. | |
virtual WLength | margin (Side side) const |
Returns a CSS margin set. | |
virtual void | setHiddenKeepsGeometry (bool enabled) |
Sets whether the widget keeps its geometry when hidden. | |
virtual bool | hiddenKeepsGeometry () const |
Returns whether the widget keeps its geometry when hidden. | |
virtual void | setHidden (bool hidden, const WAnimation &animation=WAnimation()) |
Hides or shows the widget. | |
virtual bool | isHidden () const |
Returns whether the widget is set hidden. | |
virtual bool | isVisible () const |
Returns whether the widget is visible. | |
virtual void | setDisabled (bool disabled) |
Sets whether the widget is disabled. | |
virtual bool | isDisabled () const |
Returns whether the widget is set disabled. | |
virtual bool | isEnabled () const |
Returns whether the widget is enabled. | |
virtual void | setPopup (bool popup) |
Lets the widget overlay over other sibling widgets. | |
virtual bool | isPopup () const |
Returns whether the widget is overlayed. | |
virtual void | setInline (bool isInline) |
Sets whether the widget is displayed inline or as a block. | |
virtual bool | isInline () const |
Returns whether the widget is displayed inline or as block. | |
virtual void | setDecorationStyle (const WCssDecorationStyle &style) |
Sets a CSS decoration style. | |
virtual WCssDecorationStyle & | decorationStyle () |
Returns the decoration style of this widget. | |
virtual void | setStyleClass (const WString &styleClass) |
Sets (one or more) CSS style classes. | |
virtual WString | styleClass () const |
Returns the CSS style class. | |
virtual void | addStyleClass (const WString &styleClass, bool force=false) |
Adds a CSS style class. | |
virtual void | removeStyleClass (const WString &styleClass, bool force=false) |
Removes a CSS style class. | |
virtual void | setVerticalAlignment (AlignmentFlag alignment, const WLength &length=WLength()) |
Sets the vertical alignment. | |
virtual AlignmentFlag | verticalAlignment () const |
Returns the vertical alignment. | |
virtual WLength | verticalAlignmentLength () const |
Returns the fixed vertical alignment that was set. | |
virtual void | setToolTip (const WString &text, TextFormat textFormat=PlainText) |
Sets a tooltip. | |
virtual WString | toolTip () const |
Returns the tooltip. | |
virtual void | refresh () |
Refresh the widget. | |
virtual void | setAttributeValue (const std::string &name, const WString &value) |
Sets an attribute value. | |
virtual WString | attributeValue (const std::string &name) const |
Returns an attribute value. | |
virtual void | setJavaScriptMember (const std::string &name, const std::string &value) |
Sets a JavaScript member. | |
virtual std::string | javaScriptMember (const std::string &name) const |
Returns the value of a JavaScript member. | |
virtual void | callJavaScriptMember (const std::string &name, const std::string &args) |
Calls a JavaScript member. | |
virtual void | load () |
Loads content just before the widget is used. | |
virtual bool | loaded () const |
Returns whether this widget has been loaded. | |
virtual void | setTabIndex (int index) |
Sets the tab index. | |
virtual int | tabIndex () const |
Returns the tab index. | |
virtual void | setId (const std::string &id) |
Sets the CSS Id. | |
virtual WWidget * | find (const std::string &name) |
Finds a descendent widget by name. | |
virtual void | setSelectable (bool selectable) |
Sets as selectable. | |
virtual void | doJavaScript (const std::string &javascript) |
Executes the given JavaScript statements when the widget is rendered or updated. | |
virtual const std::string | id () const |
Returns the (unique) identifier for this object. | |
void | setLoadLaterWhenInvisible (bool) |
Change the way the widget is loaded when invisible. | |
const std::vector< WWidget * > & | children () const |
Returns contained widgets. | |
Signal & | childrenChanged () |
Signal emitted when children have been added or removed. | |
bool | isRendered () const |
Returns whether the widget is rendered. | |
![]() | |
virtual | ~WWidget () |
Destructor. | |
WWidget * | parent () const |
Returns the parent widget. | |
void | setWidth (const WLength &width) |
Sets the width. | |
void | setHeight (const WLength &height) |
Sets the height. | |
virtual void | positionAt (const WWidget *widget, Orientation orientation=Vertical) |
Positions a widget next to another widget. | |
virtual void | toggleStyleClass (const WString &styleClass, bool add, bool force=false) |
Toggles a CSS style class. | |
std::string | jsRef () const |
Returns a JavaScript expression to the corresponding DOM node. | |
virtual void | acceptDrops (const std::string &mimeType, const WString &hoverStyleClass=WString()) |
Sets a mime type to be accepted for dropping. | |
virtual void | stopAcceptDrops (const std::string &mimeType) |
Indicates that a mime type is no longer accepted for dropping. | |
virtual void | htmlText (std::ostream &out) |
Streams the (X)HTML representation. | |
void | hide () |
Hides the widget. | |
void | animateHide (const WAnimation &animation) |
Hides the widget using an animation. | |
void | show () |
Shows the widget. | |
void | animateShow (const WAnimation &animation) |
Shows the widget using an animation. | |
void | enable () |
Enables the widget. | |
void | disable () |
Disable thes widget. | |
bool | layoutSizeAware () const |
Returns whether the widget is layout size aware. | |
![]() | |
WObject (WObject *parent=0) | |
Create a WObject with a given parent object. | |
virtual | ~WObject () |
Destructor. | |
void | setObjectName (const std::string &name) |
Sets an object name. | |
virtual std::string | objectName () const |
Returns the object name. | |
void | resetLearnedSlots () |
Resets learned stateless slot implementations. | |
template<class T > | |
void | resetLearnedSlot (void(T::*method)()) |
Resets a learned stateless slot implementation. | |
template<class T > | |
WStatelessSlot * | implementStateless (void(T::*method)()) |
Declares a slot to be stateless and learn client-side behaviour on first invocation. | |
template<class T > | |
WStatelessSlot * | implementStateless (void(T::*method)(), void(T::*undoMethod)()) |
Declares a slot to be stateless and learn client-side behaviour in advance. | |
template<class T > | |
WStatelessSlot * | implementJavaScript (void(T::*method)(), const std::string &jsCode) |
Provides a JavaScript implementation for a method. | |
void | addChild (WObject *child) |
Adds a child object. |
Additional Inherited Members | |
![]() | |
static WString | escapeText (const WString &text, bool newlinesToo=false) |
Escape HTML control characters in the text, to display literally (deprecated). | |
static std::string & | escapeText (std::string &text, bool newlinestoo=false) |
Escape HTML control characters in the text, to display literally (deprecated). | |
static bool | removeScript (WString &text) |
Remove tags/attributes from text that are not passive (deprecated). | |
static std::string | jsStringLiteral (const std::string &v, char delimiter= '\'') |
Turn a UTF8 encoded string into a JavaScript string literal. | |
![]() | |
virtual void | propagateSetEnabled (bool enabled) |
Propagates that a widget was enabled or disabled through children. | |
virtual void | enableAjax () |
Progresses to an Ajax-enabled widget. | |
virtual void | removeChild (WObject *child) |
Removes a child object. | |
![]() | |
static WObject * | sender () |
Returns the sender of the current slot call. |
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.
ScrollBarPolicy Wt::WScrollArea::horizontalScrollBarPolicy | ( | ) |
Returns the horizontal scroll bar policy.
void Wt::WScrollArea::setHorizontalScrollBarPolicy | ( | ScrollBarPolicy | scrollBarPolicy | ) |
Sets the horizontal scroll bar policy.
void Wt::WScrollArea::setScrollBarPolicy | ( | ScrollBarPolicy | scrollBarPolicy | ) |
Sets the policy for both scrollbars.
void Wt::WScrollArea::setVerticalScrollBarPolicy | ( | ScrollBarPolicy | scrollBarPolicy | ) |
Sets the vertical scroll bar policy.
void Wt::WScrollArea::setWidget | ( | WWidget * | widget | ) |
Sets the widget that is the content of the scroll area.
Setting a new widget will delete the previously set widget.
ScrollBarPolicy Wt::WScrollArea::verticalScrollBarPolicy | ( | ) |
Returns the vertical scroll bar policy.