#include <Wt/WCompositeWidget>
Public Member Functions | |
WCompositeWidget (WContainerWidget *parent=0) | |
Create a WCompositeWidget. | |
virtual const std::string | id () const |
Returns the (unique) identifier for this object. | |
virtual void | setPositionScheme (PositionScheme scheme) |
Sets the widget position scheme. | |
virtual PositionScheme | positionScheme () const |
Returns the widget position scheme. | |
virtual void | setOffsets (const WLength &offset, WFlags< Side > sides=All) |
Applies offsets to a widget. | |
virtual WLength | offset (Side s) const |
Retrieves the offset of the widget. | |
virtual void | resize (const WLength &width, const WLength &height) |
Resizes the widget. | |
virtual WLength | width () const |
Returns the widget width. | |
virtual WLength | height () const |
Returns the widget 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 line height for contained text. | |
virtual WLength | lineHeight () const |
Returns the line height for contained text. | |
virtual void | setFloatSide (Side s) |
Specify a side to which the WWidget must float. | |
virtual Side | floatSide () const |
Returns the 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 margins around the widget. | |
virtual WLength | margin (Side side) const |
Returns the margin set for that side. | |
virtual void | setHidden (bool) |
Sets whether the widget must be hidden. | |
virtual bool | isHidden () const |
Returns whether this widget is set hidden. | |
virtual void | setPopup (bool) |
Let the widget overlay other sibling widgets. | |
virtual bool | isPopup () const |
Returns whether this widget is overlayed. | |
virtual void | setInline (bool) |
Sets whether this widget is displayed inline or as a block. | |
virtual bool | isInline () const |
Returns whether this widget is displayed inline or as block. | |
virtual WCssDecorationStyle & | decorationStyle () |
Returns the decoration style of this widget. | |
virtual void | setStyleClass (const WString &styleClass) |
Sets a style class. | |
virtual WString | styleClass () const |
Returns the style class. | |
virtual void | setVerticalAlignment (AlignmentFlag alignment, const WLength &length=WLength::Auto) |
Sets the vertical alignment of this (inline) widget. | |
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) |
Sets a tooltip. | |
virtual WString | toolTip () const |
Returns the tooltip text. | |
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 | load () |
Load content just before the widget's content is rendered. | |
virtual bool | loaded () const |
Returns if this widget has been loaded. | |
virtual void | setId (const std::string &id) |
Sets the CSS Id. | |
virtual void | setSelectable (bool selectable) |
Sets as selectable. | |
Protected Member Functions | |
virtual void | enableAjax () |
Progress to an Ajax-enabled widget. | |
void | setImplementation (WWidget *widget) |
Set the implementation widget. | |
virtual int | boxPadding (Orientation orientation) const |
Returns the widget's built-in padding. | |
virtual int | boxBorder (Orientation orientation) const |
Returns the widget's built-in border width. |
Composite widgets, built on top of the WebWidgets, should derive from this class, and use setImplementation() to set the widget that implements the composite widget (which is typically a WContainerWidget or a WTable, or another widget that allows composition, including perhaps another WCompositeWidget).
Using this class you can completely hide the implementation of your composite widget, and provide access to only the standard WWidget methods.
Usage example:
class MyWidget : public Wt::WCompositeWidget { public: MyWidget(WContainerWidget *parent = 0) : WCompositeWidget(parent) // initialize members ... { setImplementation(impl_ = new WContainerWidget()); // further initialization code ... } private: Wt::ContainerWidget *impl_; };
const std::string Wt::WCompositeWidget::id | ( | ) | const [virtual] |
Returns the (unique) identifier for this object.
For a WWidget, this corresponds to the id of the DOM element that represents the widget. This is not entirely unique, since a composite widget shares the same id as its implementation.
By default, the id is auto-generated, unless a custom id is set for a widget using WWidget::setId(). The auto-generated id is created by concatenating objectName() with a unique number.
Reimplemented from Wt::WObject.
void Wt::WCompositeWidget::setPositionScheme | ( | PositionScheme | scheme | ) | [virtual] |
Sets the widget position scheme.
Establishes how the widget must be layed-out relative to its siblings. The default position scheme is Static.
This applies to CSS-based layout.
Implements Wt::WWidget.
PositionScheme Wt::WCompositeWidget::positionScheme | ( | ) | const [virtual] |
void Wt::WCompositeWidget::setOffsets | ( | const WLength & | offset, | |
WFlags< Side > | sides = All | |||
) | [virtual] |
Applies offsets to a widget.
The argument sides may be a logical concatenation of Left, Right, Top, and Bottom.
This applies only to widgets that have a position scheme that is Relative, Absolute, or Fixed, and has a slightly different meaning for these three cases.
For a relatively positioned widget, an offset applies relative to the position the widget would have when layed-out using a Static position scheme. The widget may be shifted to the left or right by specifying an offset to the Left or Right). The widget may be shifted vertically, by specifying an offset for the Top or Bottom.
For an absolutely positioned widget, an offset specifies a distance of the corresponding side of the widget with respect to the corresponding side of the reference parent widget. Thus, setting all offsets to 0 result in a widget that spans the entire reference widget. The reference parent widget is the first ancestor widget that is a table cell, or a widget with a relative, absolute or fixed position scheme.
For an fixed positioned widget, an offset specifies a distance of the corresponding side of the widget with respect to the browser window, regardless of scrolling. Thus, setting all offsets to 0 result in a widget that spans the entire browser window.
This applies to CSS-based layout.
Implements Wt::WWidget.
Resizes the widget.
Specify a new size for this widget, by specifying width and height. By default a widget has automatic width and height, see WLength::isAuto().
This applies to CSS-based layout.
Implements Wt::WWidget.
Reimplemented in Wt::WDialog, Wt::WSlider, and Wt::WTreeView.
WLength Wt::WCompositeWidget::width | ( | ) | const [virtual] |
Returns the widget width.
Returns the width set for this widget. This is not a calculated width, based on layout, but the width as specified with resize(const WLength&, const WLength&).
This applies to CSS-based layout.
Implements Wt::WWidget.
WLength Wt::WCompositeWidget::height | ( | ) | const [virtual] |
Returns the widget height.
Returns the height set for this widget. This is not a calculated height, based on layout, but the height as specified previously with resize(const WLength& width, const WLength& height).
This applies to CSS-based layout.
Implements Wt::WWidget.
void Wt::WCompositeWidget::setMinimumSize | ( | const WLength & | width, | |
const WLength & | height | |||
) | [virtual] |
Sets a minimum size.
Specify a minimum size for this widget. When the widget is managed using a layout manager, these sizes are also taken into account.
Implements Wt::WWidget.
WLength Wt::WCompositeWidget::minimumWidth | ( | ) | const [virtual] |
Returns the minimum width.
Returns the minimum width set for this widget with setMinimumSize().
Implements Wt::WWidget.
WLength Wt::WCompositeWidget::minimumHeight | ( | ) | const [virtual] |
Returns the minimum height.
Returns the minmum height set for this widget with setMinimumSize().
Implements Wt::WWidget.
void Wt::WCompositeWidget::setMaximumSize | ( | const WLength & | width, | |
const WLength & | height | |||
) | [virtual] |
Sets a maximum size.
Specify a minimum size for this widget.
Implements Wt::WWidget.
WLength Wt::WCompositeWidget::maximumWidth | ( | ) | const [virtual] |
Returns the maximum width.
Returns the maximum width set for this widget with setMaximumSize().
Implements Wt::WWidget.
WLength Wt::WCompositeWidget::maximumHeight | ( | ) | const [virtual] |
Returns the maximum height.
Returns the minmum height set for this widget with setMaximumSize().
Implements Wt::WWidget.
WLength Wt::WCompositeWidget::lineHeight | ( | ) | const [virtual] |
void Wt::WCompositeWidget::setFloatSide | ( | Side | s | ) | [virtual] |
Specify a side to which the WWidget must float.
This only applies to widgets with a Static positionScheme().
It specifies if the widget must be positioned on one of the sides of the parent widget, at the current line. A typical use is to position images within text. Valid values for Side or
This applies to CSS-based layout.
Implements Wt::WWidget.
Side Wt::WCompositeWidget::floatSide | ( | ) | const [virtual] |
void Wt::WCompositeWidget::setClearSides | ( | WFlags< Side > | sides | ) | [virtual] |
Sets the sides that should be cleared of floats.
This pushes the widget down until it is not surrounded by floats at the sides (which may be a logical OR of Left and Right.
This applies to CSS-based layout.
Implements Wt::WWidget.
WFlags< Side > Wt::WCompositeWidget::clearSides | ( | ) | const [virtual] |
Returns the sides that should remain empty.
Implements Wt::WWidget.
void Wt::WCompositeWidget::setMargin | ( | const WLength & | margin, | |
WFlags< Side > | sides = All | |||
) | [virtual] |
Sets margins around the widget.
Setting margin has the effect of adding a distance between the widget and surrounding widgets. The default margin (with an automatic length) is zero.
Use any combination of Left , Right , Bottom , or Top .
This applies to CSS-based layout.
Implements Wt::WWidget.
Returns the margin set for that side.
This applies to CSS-based layout.
Implements Wt::WWidget.
void Wt::WCompositeWidget::setHidden | ( | bool | hidden | ) | [virtual] |
Sets whether the widget must be hidden.
Hide or show the widget (including all its descendant widgets). setHidden(false) will show this widget and all child widgets that are not hidden.
Implements Wt::WWidget.
Reimplemented in Wt::WDialog, and Wt::WPopupMenu.
bool Wt::WCompositeWidget::isHidden | ( | ) | const [virtual] |
Returns whether this widget is set hidden.
A widget that is not hidden may still be not visible when one of its ancestor widgets are hidden.
Implements Wt::WWidget.
void Wt::WCompositeWidget::setPopup | ( | bool | popup | ) | [virtual] |
Let the widget overlay other sibling widgets.
A widget that isPopup() will be rendered on top of any other sibling widget contained within the same parent (including other popup widgets previously added to the container).
This will only have an effect when the widgetis either Absolute or Fixed positionScheme().
This applies to CSS-based layout.
Implements Wt::WWidget.
bool Wt::WCompositeWidget::isPopup | ( | ) | const [virtual] |
Returns whether this widget is overlayed.
This applies to CSS-based layout.
Implements Wt::WWidget.
void Wt::WCompositeWidget::setInline | ( | bool | inlined | ) | [virtual] |
Sets whether this widget is displayed inline or as a block.
This option changes whether this widget must be rendered in-line with sibling widgets wrapping at the right edge of the parent container (like text), or whether this widget must be rendered as a rectangular block that stacks vertically with sibling widgets (unless a CSS float property is applied). Depending on the widget type, the default value is inline (such as for example for WText, or WPushButton), or block (such as for example for a WContainerWidget).
This applies to CSS-based layout.
Implements Wt::WWidget.
bool Wt::WCompositeWidget::isInline | ( | ) | const [virtual] |
Returns whether this widget is displayed inline or as block.
Implements Wt::WWidget.
WCssDecorationStyle & Wt::WCompositeWidget::decorationStyle | ( | ) | [virtual] |
Returns the decoration style of this widget.
This groups all decorative aspects of the widget, which do not affect the widget layout (except for the border properties which may behave like extra margin around the widget).
Implements Wt::WWidget.
void Wt::WCompositeWidget::setStyleClass | ( | const WString & | styleClass | ) | [virtual] |
Sets a style class.
The CSS style class works in conjunction with style sheet, and provides a flexible way to provide many widgets the same markup.
Setting an empty string removes the style class.
Implements Wt::WWidget.
WString Wt::WCompositeWidget::styleClass | ( | ) | const [virtual] |
void Wt::WCompositeWidget::setVerticalAlignment | ( | AlignmentFlag | alignment, | |
const WLength & | length = WLength::Auto | |||
) | [virtual] |
Sets the vertical alignment of this (inline) widget.
This only applies to inline widgets, and determines how to position itself on the current line, with respect to sibling inline widgets.
This applies to CSS-based layout.
Implements Wt::WWidget.
AlignmentFlag Wt::WCompositeWidget::verticalAlignment | ( | ) | const [virtual] |
Returns the vertical alignment.
This applies to CSS-based layout.
Implements Wt::WWidget.
WLength Wt::WCompositeWidget::verticalAlignmentLength | ( | ) | const [virtual] |
Returns the fixed vertical alignment that was set.
This applies to CSS-based layout.
Implements Wt::WWidget.
void Wt::WCompositeWidget::setToolTip | ( | const WString & | text | ) | [virtual] |
Sets a tooltip.
The tooltip is displayed when the cursor hovers over the widget.
Implements Wt::WWidget.
void Wt::WCompositeWidget::refresh | ( | ) | [virtual] |
Refresh the widget.
The refresh method is invoked when the locale is changed using WApplication::setLocale() or when the user hit the refresh button.
The widget must actualize its contents in response.
Implements Wt::WWidget.
Reimplemented in Wt::WGoogleMap, and Wt::WTreeView.
void Wt::WCompositeWidget::setAttributeValue | ( | const std::string & | name, | |
const WString & | value | |||
) | [virtual] |
Sets an attribute value.
Associate an extra attribute with this widget, with the given value. This is only useful when processing dom nodes associated with widgets in custom JavaScript code.
Implements Wt::WWidget.
WString Wt::WCompositeWidget::attributeValue | ( | const std::string & | name | ) | const [virtual] |
void Wt::WCompositeWidget::load | ( | ) | [virtual] |
Load content just before the widget's content is rendered.
As soon as a widget is inserted into the widget hierarchy, it is rendered. Visible widgets are rendered immediately, and invisible widgets in the back-ground. This method is called when the widget is directly or indirectly inserted into the widget tree.
The default implementation simply propagates the load signal to its children. You may want to override this method to load resource-intensive content only when the widget is loaded into the browser.
Implements Wt::WWidget.
Reimplemented in Wt::WPopupMenuItem, and Wt::WTreeView.
bool Wt::WCompositeWidget::loaded | ( | ) | const [virtual] |
void Wt::WCompositeWidget::setId | ( | const std::string & | id | ) | [virtual] |
Sets the CSS Id.
Sets a custom Id. Note that the Id must be unique across the whole widget tree, can only be set right after construction and cannot be changed.
Implements Wt::WWidget.
void Wt::WCompositeWidget::setSelectable | ( | bool | selectable | ) | [virtual] |
Sets as selectable.
When a widget is made unselectable, a selection of text (or images) will not be visible (but may still be possible).
By default, the widget inherits this property from its parent, and this property propagates to all children. The top level container (WApplication::root()) selectable by default.
Implements Wt::WWidget.
Reimplemented in Wt::WTreeNode.
void Wt::WCompositeWidget::enableAjax | ( | ) | [protected, virtual] |
Progress to an Ajax-enabled widget.
This method is called when the progressive bootstrap method is used, and support for AJAX has been detected. The default behavior will upgrade the widget's event handling to use AJAX instead of full page reloads, and propagate the call to its children.
You may want to reimplement this method if you want to make changes to widget when AJAX is enabled. You should always call the base implementation.
Implements Wt::WWidget.
Reimplemented in Wt::WMenu, and Wt::WTreeView.
void Wt::WCompositeWidget::setImplementation | ( | WWidget * | widget | ) | [protected] |
Set the implementation widget.
This sets the widget that implements this compositeWidget. Ownership of the widget is completely transferred (including deletion).
int Wt::WCompositeWidget::boxPadding | ( | Orientation | orientation | ) | const [protected, virtual] |
Returns the widget's built-in padding.
This is used by the layout managers to correct for a built-in padding which interferes with setting a widget's width (or height) to 100%.
A layout manager needs to set the width to 100% only for form widgets (WTextArea, WLineEdit, WComboBox, etc...). Therefore, only for those widgets this needs to return the padding (the default implementation returns 0).
For form widgets, the padding depends on the specific browser/platform combination, unless an explicit padding is set for the widget.
When setting an explicit padding for the widget using a style class, you will want to reimplement this method to return this padding in case you want to set the widget inside a layout manager.
Reimplemented from Wt::WWidget.
int Wt::WCompositeWidget::boxBorder | ( | Orientation | orientation | ) | const [protected, virtual] |
Returns the widget's built-in border width.
This is used by the layout managers to correct for a built-in border which interferes with setting a widget's width (or height) to 100%.
A layout manager needs to set the width to 100% only for form widgets (WTextArea, WLineEdit, WComboBox, etc...). Therefore, only for those widgets this needs to return the border width (the default implementation returns 0).
For form widgets, the border width depends on the specific browser/platform combination, unless an explicit border is set for the widget.
When setting an explicit border for the widget using a style class, you will want to reimplement this method to return this border width, in case you want to set the widget inside a layout manager.
Reimplemented from Wt::WWidget.