A widget that hides the implementation of composite widgets. More...

#include <Wt/WCompositeWidget>

Inheritance diagram for Wt::WCompositeWidget:

[legend]

Public Member Functions
	WCompositeWidget (WContainerWidget *parent=0)
	Creates a WCompositeWidget. More...

	WCompositeWidget (WWidget implementation, WContainerWidget parent)
	Creates a WCompositeWidget with given implementation. More...

virtual void	setObjectName (const std::string &name)
	Sets an object name. More...

virtual std::string	objectName () const
	Returns the object name. More...

virtual const std::string	id () const
	Returns the (unique) identifier for this object. More...

virtual void	setPositionScheme (PositionScheme scheme)
	Sets the CSS position scheme. More...

virtual PositionScheme	positionScheme () const
	Returns the CSS position scheme. More...

virtual void	setOffsets (const WLength &offset, WFlags< Side > sides=All)
	Sets CSS offsets for a non-statically positioned widget. More...

virtual WLength	offset (Side s) const
	Returns a CSS offset. More...

virtual void	resize (const WLength &width, const WLength &height)
	Resizes the widget. More...

virtual WLength	width () const
	Returns the width. More...

virtual WLength	height () const
	Returns the height. More...

virtual void	setMinimumSize (const WLength &width, const WLength &height)
	Sets a minimum size. More...

virtual WLength	minimumWidth () const
	Returns the minimum width. More...

virtual WLength	minimumHeight () const
	Returns the minimum height. More...

virtual void	setMaximumSize (const WLength &width, const WLength &height)
	Sets a maximum size. More...

virtual WLength	maximumWidth () const
	Returns the maximum width. More...

virtual WLength	maximumHeight () const
	Returns the maximum height. More...

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. More...

virtual void	setFloatSide (Side s)
	Specifies a CSS float side. More...

virtual Side	floatSide () const
	Returns the CSS float side. More...

virtual void	setClearSides (WFlags< Side > sides)
	Sets the sides that should be cleared of floats. More...

virtual WFlags< Side >	clearSides () const
	Returns the sides that should remain empty. More...

virtual void	setMargin (const WLength &margin, WFlags< Side > sides=All)
	Sets CSS margins around the widget. More...

virtual WLength	margin (Side side) const
	Returns a CSS margin set. More...

virtual void	setHiddenKeepsGeometry (bool enabled)
	Sets whether the widget keeps its geometry when hidden. More...

virtual bool	hiddenKeepsGeometry () const
	Returns whether the widget keeps its geometry when hidden. More...

virtual void	setHidden (bool hidden, const WAnimation &animation=WAnimation())
	Hides or shows the widget. More...

virtual bool	isHidden () const
	Returns whether the widget is set hidden. More...

virtual bool	isVisible () const
	Returns whether the widget is visible. More...

virtual void	setDisabled (bool disabled)
	Sets whether the widget is disabled. More...

virtual bool	isDisabled () const
	Returns whether the widget is set disabled. More...

virtual bool	isEnabled () const
	Returns whether the widget is enabled. More...

virtual void	setPopup (bool popup)
	Lets the widget overlay over other sibling widgets. More...

virtual bool	isPopup () const
	Returns whether the widget is overlayed. More...

virtual void	setInline (bool isInline)
	Sets whether the widget is displayed inline or as a block. More...

virtual bool	isInline () const
	Returns whether the widget is displayed inline or as block. More...

virtual void	setDecorationStyle (const WCssDecorationStyle &style)
	Sets a CSS decoration style. More...

virtual WCssDecorationStyle &	decorationStyle ()
	Returns the decoration style of this widget. More...

virtual void	setStyleClass (const WString &styleClass)
	Sets (one or more) CSS style classes. More...

virtual WString	styleClass () const
	Returns the CSS style class. More...

virtual void	addStyleClass (const WString &styleClass, bool force=false)
	Adds a CSS style class. More...

virtual void	removeStyleClass (const WString &styleClass, bool force=false)
	Removes a CSS style class. More...

virtual bool	hasStyleClass (const WString &styleClass) const
	Returns whether the widget has a style class.

virtual void	setVerticalAlignment (AlignmentFlag alignment, const WLength &length=WLength::Auto)
	Sets the vertical alignment. More...

virtual AlignmentFlag	verticalAlignment () const
	Returns the vertical alignment. More...

virtual WLength	verticalAlignmentLength () const
	Returns the fixed vertical alignment that was set. More...

virtual void	setToolTip (const WString &text, TextFormat textFormat=PlainText)
	Sets a tooltip. More...

virtual WString	toolTip () const
	Returns the tooltip.

virtual void	setDeferredToolTip (bool enable, TextFormat textFormat=PlainText)
	Enable deferred tooltip. More...

virtual void	refresh ()
	Refresh the widget. More...

virtual void	setAttributeValue (const std::string &name, const WString &value)
	Sets an attribute value. More...

virtual WString	attributeValue (const std::string &name) const
	Returns an attribute value. More...

virtual void	setJavaScriptMember (const std::string &name, const std::string &value)
	Sets a JavaScript member. More...

virtual std::string	javaScriptMember (const std::string &name) const
	Returns the value of a JavaScript member. More...

virtual void	callJavaScriptMember (const std::string &name, const std::string &args)
	Calls a JavaScript member. More...

virtual void	load ()
	Loads content just before the widget is used. More...

virtual bool	loaded () const
	Returns whether this widget has been loaded. More...

virtual void	setCanReceiveFocus (bool enabled)
	Sets whether the widget can receive focus. More...

virtual bool	canReceiveFocus () const
	Returns whether the widget can receive focus. More...

virtual void	setFocus (bool focus)
	Sets focus. More...

virtual bool	setFirstFocus ()
	Set focus on the widget's first descendant. More...

virtual bool	hasFocus () const
	Returns whether the widget currently has the focus.

virtual void	setTabIndex (int index)
	Sets the tab index. More...

virtual int	tabIndex () const
	Returns the tab index. More...

virtual void	setId (const std::string &id)
	Sets the CSS Id. More...

virtual WWidget *	find (const std::string &name)
	Finds a descendent widget by name. More...

virtual WWidget *	findById (const std::string &name)
	Finds a descendent widget by id.

virtual void	setSelectable (bool selectable)
	Sets as selectable. More...

virtual void	doJavaScript (const std::string &js)
	Executes the given JavaScript statements when the widget is rendered or updated. More...

virtual void	propagateSetEnabled (bool enabled)
	Propagates that a widget was enabled or disabled through children. More...

virtual bool	scrollVisibilityEnabled () const WT_CXX11ONLY(finaloverride)
	Returns whether scroll visibility detection is enabled for this widget. More...

virtual void	setScrollVisibilityEnabled (bool enabled) WT_CXX11ONLY(finaloverride)
	Sets whether scroll visibility detection is enabled for this widget. More...

virtual int	scrollVisibilityMargin () const WT_CXX11ONLY(finaloverride)
	Returns the margin around the viewport within which the widget is considered visible. More...

virtual void	setScrollVisibilityMargin (int margin) WT_CXX11ONLY(finaloverride)
	Sets the margin around the viewport within which the widget is considered visible. More...

virtual Signal< bool > &	scrollVisibilityChanged () WT_CXX11ONLY(finaloverride)
	Signal triggered when the scroll visibility of this widget changes. More...

virtual bool	isScrollVisible () const WT_CXX11ONLY(finaloverride)
	Returns whether this widget is currently considered scroll visible. More...

virtual void	setThemeStyleEnabled (bool enabled)
	Sets whether theme styling for a widget is enabled or disabled. More...

virtual bool	isThemeStyleEnabled () const
	Returns whether this widget is currently styled by the chosen theme. More...

Public Member Functions inherited from Wt::WWidget
virtual	~WWidget ()
	Destructor. More...

WWidget *	parent () const
	Returns the parent widget. More...

virtual void	removeChild (WObject *child)
	Removes a child object. More...

void	setWidth (const WLength &width)
	Sets the width. More...

void	setHeight (const WLength &height)
	Sets the height. More...

virtual void	positionAt (const WWidget *widget, Orientation orientation=Vertical)
	Positions a widget next to another widget. More...

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. More...

void	setFocus ()
	Sets focus. More...

virtual void	acceptDrops (const std::string &mimeType, const WString &hoverStyleClass=WString())
	Sets a mime type to be accepted for dropping. More...

virtual void	stopAcceptDrops (const std::string &mimeType)
	Indicates that a mime type is no longer accepted for dropping. More...

virtual void	htmlText (std::ostream &out)
	Streams the (X)HTML representation. More...

bool	isRendered () const
	Returns whether the widget is rendered. More...

void	hide ()
	Hides the widget. More...

void	animateHide (const WAnimation &animation)
	Hides the widget using an animation. More...

void	show ()
	Shows the widget. More...

void	animateShow (const WAnimation &animation)
	Shows the widget using an animation. More...

void	enable ()
	Enables the widget. More...

void	disable ()
	Disable thes widget. More...

bool	layoutSizeAware () const
	Returns whether the widget is layout size aware. More...

Public Member Functions inherited from Wt::WObject
	WObject (WObject *parent=0)
	Create a WObject with a given parent object. More...

virtual	~WObject ()
	Destructor. More...

void	resetLearnedSlots ()
	Resets learned stateless slot implementations. More...

template<class T >
void	resetLearnedSlot (void(T::*method)())
	Resets a learned stateless slot implementation. More...

template<class T >
WStatelessSlot *	implementStateless (void(T::*method)())
	Declares a slot to be stateless and learn client-side behaviour on first invocation. More...

template<class T >
WStatelessSlot *	implementStateless (void(T::method)(), void(T::undoMethod)())
	Declares a slot to be stateless and learn client-side behaviour in advance. More...

void	isNotStateless ()
	Marks the current function as not stateless. More...

template<class T >
WStatelessSlot *	implementJavaScript (void(T::*method)(), const std::string &jsCode)
	Provides a JavaScript implementation for a method. More...

void	addChild (WObject *child)
	Adds a child object. More...

const std::vector< WObject * > &	children () const
	Returns the children.

WObject *	parent () const
	Returns the parent object.

Protected Member Functions
virtual void	enableAjax ()
	Progresses to an Ajax-enabled widget. More...

void	setImplementation (WWidget *widget)
	Set the implementation widget. More...

WWidget *	implementation ()
	Get the implementation widget. More...

virtual int	boxPadding (Orientation orientation) const
	Returns the widget's built-in padding. More...

virtual int	boxBorder (Orientation orientation) const
	Returns the widget's built-in border width. More...

virtual void	render (WFlags< RenderFlag > flags)
	Renders the widget. More...

Protected Member Functions inherited from Wt::WWidget
void	setLayoutSizeAware (bool sizeAware)
	Sets the widget to be aware of its size set by a layout manager. More...

virtual void	layoutSizeChanged (int width, int height)
	Virtual method that indicates a size change. More...

	WWidget (WContainerWidget *parent=0)
	Creates a widget. More...

virtual void	dropEvent (WDropEvent dropEvent)
	Handles a drop event. More...

void	scheduleRender (WFlags< RepaintFlag > flags=0)
	Schedules rerendering of the widget. More...

virtual WStatelessSlot *	getStateless (Method method)
	On-demand stateless slot implementation. More...

Additional Inherited Members
Public Types inherited from Wt::WObject
typedef void(WObject::*	Method) ()
	Typedef for a WObject method without arguments.

Static Public Member Functions inherited from Wt::WWidget
static WString	tr (const char *key)
	Short hand for WString::tr() More...

Static Protected Member Functions inherited from Wt::WObject
static WObject *	sender ()
	Returns the sender of the current slot call. More...

Detailed Description

A widget that hides the implementation of composite widgets.

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::WContainerWidget *impl_;
};

Constructor & Destructor Documentation

Wt::WCompositeWidget::WCompositeWidget ( WContainerWidget * parent = 0 )

Creates a WCompositeWidget.

You need to set an implemetation using setImplementation() directly after construction.

Wt::WCompositeWidget::WCompositeWidget	(	WWidget *	implementation,
		WContainerWidget *	parent
	)

Creates a WCompositeWidget with given implementation.

See also: setImplementation()

Member Function Documentation

void Wt::WCompositeWidget::addStyleClass	(	const WString &	styleClass,
		bool	force = `false`
	)

virtual

Adds a CSS style class.

When force = true, a JavaScript call will be used to add the style class to the DOM element (if JavaScript is available). This may be necessary when client-side JavaScript manipulates the same style class.

The styleClass should be a single class (although multiple classes will work for the common case that the additional style classes are all not yet present on the element.

Implements Wt::WWidget.

WString Wt::WCompositeWidget::attributeValue ( const std::string & name ) const

virtual

Returns an attribute value.

See also: setAttributeValue()

Implements Wt::WWidget.

int Wt::WCompositeWidget::boxBorder ( Orientation orientation ) const

protectedvirtual

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.

See also: boxPadding()

Reimplemented from Wt::WWidget.

int Wt::WCompositeWidget::boxPadding ( Orientation orientation ) const

protectedvirtual

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.

See also: boxBorder()

Reimplemented from Wt::WWidget.

void Wt::WCompositeWidget::callJavaScriptMember	(	const std::string &	name,
		const std::string &	args
	)

virtual

Calls a JavaScript member.

This calls a JavaScript member.

See also: setJavaScriptMember()

Implements Wt::WWidget.

bool Wt::WCompositeWidget::canReceiveFocus ( ) const

virtual

Returns whether the widget can receive focus.

See also: setCanReceiveFocus()

Implements Wt::WWidget.

WFlags< Side > Wt::WCompositeWidget::clearSides ( ) const

virtual

Returns the sides that should remain empty.

See also: setClearSides(WFlags<Side>)

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).

When a decoration style has not been previously set, it returns a default decoration style object.

See also: setDecorationStyle()

Implements Wt::WWidget.

void Wt::WCompositeWidget::doJavaScript ( const std::string & js )

virtual

Executes the given JavaScript statements when the widget is rendered or updated.

Calling WApplication::doJavaScript() with JavaScript code that refers to a widget using jsRef(), that is still to be rendered may cause JavaScript errors because the corresponding DOM node does not exist. This happens for example when a widget is created, but not yet inserted in the widget tree.

This method guarantees that the JavaScript code is only run when the corresponding DOM node (using jsRef()) resolves to a valid DOM object.

See also: jsRef()

Implements Wt::WWidget.

void Wt::WCompositeWidget::enableAjax ( )

protectedvirtual

Progresses 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.

See also: WApplication::enableAjax()

Implements Wt::WWidget.

Reimplemented in Wt::WCalendar, Wt::WTreeView, and Wt::WTableView.

WWidget * Wt::WCompositeWidget::find ( const std::string & name )

virtual

Finds a descendent widget by name.

See also: setObjectName()

Implements Wt::WWidget.

Side Wt::WCompositeWidget::floatSide ( ) const

virtual

Returns the CSS float side.

See also: setFloatSide(Side)

Implements Wt::WWidget.

WLength Wt::WCompositeWidget::height ( ) const

virtual

Returns the 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.

See also: resize(const WLength&, const WLength&), width()

Implements Wt::WWidget.

bool Wt::WCompositeWidget::hiddenKeepsGeometry ( ) const

virtual

Returns whether the widget keeps its geometry when hidden.

See also: setHiddenKeepsGeometry()

Implements Wt::WWidget.

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.

See also: WWidget::jsRef()

Reimplemented from Wt::WObject.

WWidget* Wt::WCompositeWidget::implementation ( )

protected

Get the implementation widget.

This returns the widget that implements this compositeWidget.

bool Wt::WCompositeWidget::isDisabled ( ) const

virtual

Returns whether the widget is set disabled.

A widget that is not set disabled may still be disabled when one of its ancestor widgets is set disabled. Use isEnabled() to find out whether a widget is enabled.

See also: setDisabled(), isEnabled()

Implements Wt::WWidget.

bool Wt::WCompositeWidget::isEnabled ( ) const

virtual

Returns whether the widget is enabled.

A widget is enabled if it is not disabled, and none of its ancestors are disabled. This method returns whether the widget is rendered as enabled, while isDisabled() returns whether a widget has been explicitly disabled.

Note that a widget may be at the same time not enabled, and not disabled, in case one of its ancestors was disabled.

See also: isDisabled()

Implements Wt::WWidget.

bool Wt::WCompositeWidget::isHidden ( ) const

virtual

Returns whether the widget is set hidden.

A widget that is not hidden may still be not visible when one of its ancestor widgets is hidden. Use isVisible() to check the visibility of a widget.

See also: setHidden(), isVisible()

Implements Wt::WWidget.

bool Wt::WCompositeWidget::isInline ( ) const

virtual

Returns whether the widget is displayed inline or as block.

See also: setInline(bool)

Implements Wt::WWidget.

bool Wt::WCompositeWidget::isPopup ( ) const

virtual

Returns whether the widget is overlayed.

This applies to CSS-based layout.

See also: setPopup(bool)

Implements Wt::WWidget.

bool Wt::WCompositeWidget::isScrollVisible ( ) const

finaloverridevirtual

Returns whether this widget is currently considered scroll visible.

isScrollVisible() is initially false.

See also: setScrollVisibilityEnabled()

Implements Wt::WWidget.

bool Wt::WCompositeWidget::isThemeStyleEnabled ( ) const

virtual

Returns whether this widget is currently styled by the chosen theme.

isThemeEnabled() is initially true.

See also: setThemeStyleEnabled()

Implements Wt::WWidget.

bool Wt::WCompositeWidget::isVisible ( ) const

virtual

Returns whether the widget is visible.

A widget is visible if it is not hidden, and none of its ancestors are hidden. This method returns the true visibility, while isHidden() returns whether a widget has been explicitly hidden.

Note that a widget may be at the same time not hidden, and not visible, in case one of its ancestors was hidden.

See also: isHidden()

Implements Wt::WWidget.

std::string Wt::WCompositeWidget::javaScriptMember ( const std::string & name ) const

virtual

Returns the value of a JavaScript member.

See also: setJavaScriptMember()

Implements Wt::WWidget.

WLength Wt::WCompositeWidget::lineHeight ( ) const

virtual

Returns the CSS line height for contained text.

sa setLineHeight()

Implements Wt::WWidget.

void Wt::WCompositeWidget::load ( )

virtual

Loads content just before the widget is used.

This method is called after a widget is inserted in the widget hierarchy and fully constructed, but before the widget is rendered. Widgets that get inserted in the widget hierarchy will be rendered. Visible widgets are rendered immediately, and invisible widgets in the back-ground (or not for a plain HTML session). 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 delay loading of resource-intensive contents.

During the life-time of a widget, this method may be called multiple times, so you should make sure that you do a deferred initializiation only once.

Implements Wt::WWidget.

Reimplemented in Wt::WMenu, and Wt::WCalendar.

bool Wt::WCompositeWidget::loaded ( ) const

virtual

Returns whether this widget has been loaded.

See also: load()

Implements Wt::WWidget.

WLength Wt::WCompositeWidget::margin ( Side side ) const

virtual

Returns a CSS margin set.

This applies to CSS-based layout.

See also: setMargin()

Implements Wt::WWidget.

WLength Wt::WCompositeWidget::maximumHeight ( ) const

virtual

Returns the maximum height.

Returns the minmum height set for this widget with setMaximumSize().

See also: setMaximumSize(), maximumWidth()

Implements Wt::WWidget.

WLength Wt::WCompositeWidget::maximumWidth ( ) const

virtual

Returns the maximum width.

Returns the maximum width set for this widget with setMaximumSize().

See also: setMaximumSize(), maximumHeight()

Implements Wt::WWidget.

WLength Wt::WCompositeWidget::minimumHeight ( ) const

virtual

Returns the minimum height.

Returns the minmum height set for this widget with setMinimumSize().

See also: setMinimumSize(), minimumWidth()

Implements Wt::WWidget.

WLength Wt::WCompositeWidget::minimumWidth ( ) const

virtual

Returns the minimum width.

Returns the minimum width set for this widget with setMinimumSize().

See also: setMinimumSize(), minimumHeight()

Implements Wt::WWidget.

std::string Wt::WCompositeWidget::objectName ( ) const

virtual

Returns the object name.

See also: setObjectName()

Reimplemented from Wt::WObject.

WLength Wt::WCompositeWidget::offset ( Side side ) const

virtual

Returns a CSS offset.

This applies to CSS-based layout.

See also: setOffsets(const WLength&, WFlags<Side>)

Implements Wt::WWidget.

PositionScheme Wt::WCompositeWidget::positionScheme ( ) const

virtual

Returns the CSS position scheme.

This applies to CSS-based layout.

See also: Wt::PositionScheme, setPositionScheme(PositionScheme)

Implements Wt::WWidget.

void Wt::WCompositeWidget::propagateSetEnabled ( bool enabled )

virtual

Propagates that a widget was enabled or disabled through children.

When enabling or disabling a widget, you usually also want to disable contained children. This method is called by setDisabled() to propagate its state to all children.

You may want to reimplement this method if they wish to render differently when a widget is disabled. The default implementation will propagate the signal to all children.

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.

Note: This does *not* rerender the widget! Calling refresh() usually does not have any effect (unless you've reimplemented refresh() to attach to it an effect).

Reimplemented from Wt::WWidget.

Reimplemented in Wt::WMediaPlayer.

void Wt::WCompositeWidget::removeStyleClass	(	const WString &	styleClass,
		bool	force = `false`
	)

virtual

Removes a CSS style class.

When force = true, a JavaScript call will be used to remove the style class from the DOM element (if JavaScript is available). This may be necessary when client-side JavaScript manipulates the same style class.

The styleClass should be a single class

Implements Wt::WWidget.

void Wt::WCompositeWidget::render ( WFlags< RenderFlag > flags )

protectedvirtual

Renders the widget.

This function renders the widget (or an update for the widget), after this has been scheduled using scheduleRender().

The default implementation will render the widget by serializing changes to JavaScript and HTML. You may want to reimplement this widget if you have been postponing some of the layout / rendering implementation until the latest moment possible. In that case you should make sure you call the base implementation however.

Reimplemented from Wt::WWidget.

Reimplemented in Wt::WMenu, Wt::WSuggestionPopup, Wt::WMediaPlayer, Wt::WDialog, Wt::WCalendar, Wt::WGoogleMap, Wt::WTreeView, Wt::WPopupMenu, Wt::WDatePicker, Wt::WInPlaceEdit, Wt::WTreeTable, Wt::WTableView, and Wt::WPopupWidget.

void Wt::WCompositeWidget::resize	(	const WLength &	width,
		const WLength &	height
	)

virtual

Resizes the widget.

Specifies a fixed size for this widget, setting CSS width and height properties. By default a widget has automatic width and height, which sets a size for the widget following CSS rules.

When the widget is not managed by a layout manager, the automatic (natural) size of a widget depends on whether they widget is a block or inline widget:

a block widget takes by default the width of the parent, and the height that it needs based on its contents
an inline widget takes the width and height that it needs based on its contents (possibly wrapping over multiple lines). The width and height of an inline widget cannot be changed (by the letter of CSS, although most browsers will react to it in varying ways).

When inserted in a layout manager, the size set will be used as a widget's preferred size, but the widget may be given a different size by the layout manager based on available space and stretch factors. The actual size given by a layout manager may be retrieved by making the widget "layout size aware", using setLayoutSizeAware(). If you have defined a "wtResize()" JavaScript method for the widget, then this method will also be called.

The default width and height of a widget is WLength::Auto.

See also: width(), height()

Reimplemented from Wt::WWidget.

Reimplemented in Wt::WTreeView, and Wt::WTableView.

Signal< bool > & Wt::WCompositeWidget::scrollVisibilityChanged ( )

finaloverridevirtual

Signal triggered when the scroll visibility of this widget changes.

The boolean parameter indicates whether the widget is currently scroll visible.

See also: setScrollVisibilityEnabled()

Implements Wt::WWidget.

bool Wt::WCompositeWidget::scrollVisibilityEnabled ( ) const

finaloverridevirtual

Returns whether scroll visibility detection is enabled for this widget.

See also: setScrollVisibilityEnabled()

Implements Wt::WWidget.

int Wt::WCompositeWidget::scrollVisibilityMargin ( ) const

finaloverridevirtual

Returns the margin around the viewport within which the widget is considered visible.

See also: setScrollVisibilityMargin()

Implements Wt::WWidget.

void Wt::WCompositeWidget::setAttributeValue	(	const std::string &	name,
		const WString &	value
	)

virtual

Sets an attribute value.

Sets the value for an HTML attribute.

This is only useful for HTML features that are not supported directly in Wt (and beware that browsers have non-consistent support for many more exotic HTML features).

See also: JSlot, doJavaScript()

Implements Wt::WWidget.

void Wt::WCompositeWidget::setCanReceiveFocus ( bool enabled )

virtual

Sets whether the widget can receive focus.

By default, only form widgets (descendants of WFormWidget), anchors (WAnchor) and buttons (WPushButton) can receive focus.

Any other widget can be configured to receive focus however.

Implements Wt::WWidget.

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 combination of Wt::Left and Wt::Right).

This applies to CSS-based layout.

See also: setFloatSide()

Implements Wt::WWidget.

void Wt::WCompositeWidget::setDecorationStyle ( const WCssDecorationStyle & style )

virtual

Sets a CSS decoration style.

This copies the style over its current decorationStyle()

Implements Wt::WWidget.

void Wt::WCompositeWidget::setDeferredToolTip	(	bool	enable,
		TextFormat	textFormat = `PlainText`
	)

virtual

Enable deferred tooltip.

You may override toolTip() to read data only when the user hovers over the widget.

When textFormat is XHTMLText, the tooltip may contain any valid XHTML snippet. The tooltip will then be rendered using JavaScript.

Note: To change existing toolTip call setDeferredToolTip() again.

See also: toolTip

Implements Wt::WWidget.

void Wt::WCompositeWidget::setDisabled ( bool disabled )

virtual

Sets whether the widget is disabled.

Enables or disables the widget (including all its descendant widgets). setDisabled(false) will enable this widget and all descendant widgets that are not disabled. A widget is only enabled if it and all its ancestors in the widget tree are disabled.

Typically, a disabled form widget will not allow changing the value, and disabled widgets will not react to mouse click events.

Note: enable() and disable() are considered to be stateless slots by default. If you override setDisabled() and need to modify server state whenever it is called, you'll need to call WObject::isNotStateless().

See also: disable(), enable()

Implements Wt::WWidget.

Reimplemented in Wt::WDatePicker.

bool Wt::WCompositeWidget::setFirstFocus ( )

virtual

Set focus on the widget's first descendant.

Set focus on the widget itself, or on a first descendant which can receive focus.

Returns whether focus could be set.

Implements Wt::WWidget.

void Wt::WCompositeWidget::setFloatSide ( Side s )

virtual

Specifies a CSS float side.

This only applies to widgets with a Wt::Static positionScheme().

This lets the widget float to 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 Wt::Nonejava {javadoclink Side::None None} , Wt::Left or Wt::Right.

This applies to CSS-based layout.

Implements Wt::WWidget.

void Wt::WCompositeWidget::setFocus ( bool focus )

virtual

Sets focus.

When using focus = false, you can undo a previous setFocus() call.

Implements Wt::WWidget.

void Wt::WCompositeWidget::setHidden	(	bool	hidden,
		const WAnimation &	animation = `WAnimation()`
	)

virtual

Hides or shows the widget.

Hides or show the widget (including all its descendant widgets). When setting hidden = false, this widget and all descendant widgets that are not hidden will be shown. A widget is only visible if it and all its ancestors in the widget tree are visible, which may be checked using isVisible().

Note: hide() and show() are considered to be stateless slots by default. If you override setHidden() and need to modify server state whenever it is called, you'll need to call WObject::isNotStateless().

Implements Wt::WWidget.

Reimplemented in Wt::WDialog, Wt::WMessageBox, Wt::WPopupMenu, Wt::WDatePicker, Wt::WTableView, and Wt::WPopupWidget.

void Wt::WCompositeWidget::setHiddenKeepsGeometry ( bool enabled )

virtual

Sets whether the widget keeps its geometry when hidden.

Normally, a widget that is hidden will no longer occupy space, causing a reflow of sibling widgets. Using this method you may change this behavior to keep an (open) space when hidden.

Note: Currently you can only set this before initial rendering.

See also: setHidden()

Implements Wt::WWidget.

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. This is mostly useful for in tests using a test plan that manipulates DOM elements by Id.

By default, auto-generated id's are used.

Note: An id must start with a letter ([A-Za-z]), followed by one or more letters, digits ([0-9]), hyphens ("-"), underscores ("_"), colons (":"), and periods (".").

See also: WObject::id()

Implements Wt::WWidget.

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).

Note: You cannot change the implementation of a composite widget after it has been rendered.

void Wt::WCompositeWidget::setInline ( bool inlined )

virtual

Sets whether the 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.

void Wt::WCompositeWidget::setJavaScriptMember	(	const std::string &	name,
		const std::string &	value
	)

virtual

Sets a JavaScript member.

This binds a JavaScript member, which is set as a JavaScript property to the DOM object that implements this widget. The value may be any JavaScript expression, including a function.

Members that start with "wt" are reserved for internal use. You may define a member "wtResize(self, width, height)" method if your widget needs active layout management. If defined, this method will be used by layout managers and when doing resize() to set the size of the widget, instead of setting the CSS width and height properties.

Implements Wt::WWidget.

void Wt::WCompositeWidget::setMargin	(	const WLength &	margin,
		WFlags< Side >	sides = `All`
	)

virtual

Sets CSS 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 Wt::Left, Wt::Right, Wt::Bottom, or Wt::Top.

This applies to CSS-based layout.

See also: margin()

Implements Wt::WWidget.

void Wt::WCompositeWidget::setMaximumSize	(	const WLength &	width,
		const WLength &	height
	)

virtual

Sets a maximum size.

Specifies a maximum size for this widget, setting CSS max-width and max-height properties.

The default the maximum width and height are WLength::Auto, indicating no maximum size. A WLength::Percentage size should not be used, as this is (in virtually all cases) undefined behaviour.

When the widget is a container widget that contains a layout manager, then setting a maximum size will have the effect of letting the size of the container to reflect the preferred size of the contents (rather than constraining the size of the children based on the size of the container), up to the specified maximum size.

See also: resize(), setMinimumSize()

Implements Wt::WWidget.

Reimplemented in Wt::WDialog, and Wt::WPopupMenu.

void Wt::WCompositeWidget::setMinimumSize	(	const WLength &	width,
		const WLength &	height
	)

virtual

Sets a minimum size.

Specifies a minimum size for this widget, setting CSS min-width and min-height properties.

The default minimum width and height is 0. The special value WLength::Auto indicates that the initial width is used as minimum size. A WLength::Percentage size should not be used, as this is (in virtually all cases) undefined behaviour.

When the widget is inserted in a layout manager, then the minimum size will be taken into account.

See also: resize(), minimumWidth(), minimumHeight()

Implements Wt::WWidget.

Reimplemented in Wt::WDialog, and Wt::WPopupMenu.

void Wt::WCompositeWidget::setObjectName ( const std::string & name )

virtual

Sets an object name.

The object name can be used to easily identify a type of object in the DOM, and does not need to be unique. It will usually reflect the widget type or role. The object name is prepended to the auto-generated object id().

The default object name is empty.

Note: Only letters ([A-Za-z]), digits ([0-9]), hyphens ("-"), underscores ("_"), colons (":"), and periods (".") are allowed in the id.

See also: id()

Reimplemented from Wt::WWidget.

Reimplemented in Wt::WAbstractItemView.

void Wt::WCompositeWidget::setOffsets	(	const WLength &	offset,
		WFlags< Side >	sides = `All`
	)

virtual

Sets CSS offsets for a non-statically positioned widget.

The argument sides may be a combination of Wt::Left, Wt::Right, Wt::Top, and Wt::Bottom.

This applies only to widgets that have a position scheme that is Wt::Relative, Wt::Absolute, or Wt::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 for the left or right) side. The widget may be shifted vertically, by specifying an offset for the top or bottom side.

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.

See also: offset(Side) const

Implements Wt::WWidget.

void Wt::WCompositeWidget::setPopup ( bool popup )

virtual

Lets the widget overlay over 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 Wt::Absolute or Wt::Fixed positionScheme().

This applies to CSS-based layout, and configures the z-index property.

Implements Wt::WWidget.

void Wt::WCompositeWidget::setPositionScheme ( PositionScheme scheme )

virtual

Sets the CSS 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.

See also: Wt::PositionScheme, positionScheme()

Implements Wt::WWidget.

void Wt::WCompositeWidget::setScrollVisibilityEnabled ( bool enabled )

finaloverridevirtual

Sets whether scroll visibility detection is enabled for this widget.

Disabled by default. When enabled, the client keeps track of whether this widget is currently visible inside of the browser window. A widget is "scroll visible" if it is currently visible according to isVisible(), and its position is inside of the browser window, with an extra margin determined by scrollVisibilityMargin().

If scroll visibility changes, the scrollVisibilityChanged() signal is fired, and isScrollVisible() is updated.

This feature can be useful to implement infinite scroll, where a sentinel widget placed at the bottom of the page causes more content to be loaded when it becomes visible, see the infinite-scroll example.

This feature can also be used to lazy load widgets when they become visible.

Note: If the widget is "scroll visible" when scroll visibility detection is first enabled, the scrollVisibilityChanged() signal will be emitted. If it is outside of the browser's viewport when first enabled, the scrollVisibilityChanged() signal will not be emitted.; If scroll visibility is enabled, disabled, and then enabled again, isScrollVisible() may not be correctly updated, and scrollVisibilityChanged() may not be correctly emitted, because then Wt can't properly keep track of the state that the widget is in on the client side. This feature is not intended to be toggled on and off, but rather enabled once and disabled once after that.

Implements Wt::WWidget.

void Wt::WCompositeWidget::setScrollVisibilityMargin ( int margin )

finaloverridevirtual

Sets the margin around the viewport within which the widget is considered visible.

This causes the widget to be considered "scroll visible" before it is within the viewport. Setting this margin could be useful to trigger the loading of content before it is in view.

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::setStyleClass ( const WString & styleClass )

virtual

Sets (one or more) CSS style classes.

You may set one or more space separated style classes. 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(es).

See also: WApplication::styleSheet()

Implements Wt::WWidget.

void Wt::WCompositeWidget::setTabIndex ( int index )

virtual

Sets the tab index.

For widgets that receive focus (canReceiveFocus()), focus is passed on to the next widget in the tabbing chain based on their tab index. When the user navigates through form widgets using the keyboard, widgets receive focus starting from the element with the lowest tab index to elements with the highest tab index.

Widgets with a same tab index will receive focus in the same order as they are inserted in the widget tree.

The default tab index is 0 (for a widget that can receive focus).

See also: setTabOrder()

Implements Wt::WWidget.

void Wt::WCompositeWidget::setThemeStyleEnabled ( bool enabled )

virtual

Sets whether theme styling for a widget is enabled or disabled.

By default all widgets are styled according to the chosen theme. Disabling the theme style could be useful to completely customize the style of the widget outside of the theme.

Note: This should be changed after the construction but before the rendering of the widget.

Implements Wt::WWidget.

void Wt::WCompositeWidget::setToolTip	(	const WString &	text,
		TextFormat	textFormat = `PlainText`
	)

virtual

Sets a tooltip.

The tooltip is displayed when the cursor hovers over the widget.

When textFormat is XHTMLText, the tooltip may contain any valid XHTML snippet. The tooltip will then be rendered using JavaScript.

Note: This will set deferred tooltip to false.

See also: setDeferredTooltip()

Implements Wt::WWidget.

void Wt::WCompositeWidget::setVerticalAlignment	(	AlignmentFlag	alignment,
		const WLength &	length = `WLength::Auto`
	)

virtual

Sets the vertical alignment.

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.

WString Wt::WCompositeWidget::styleClass ( ) const

virtual

Returns the CSS style class.

See also: setStyleClass()

Implements Wt::WWidget.

int Wt::WCompositeWidget::tabIndex ( ) const

virtual

Returns the tab index.

See also: setTabIndex()

Implements Wt::WWidget.

AlignmentFlag Wt::WCompositeWidget::verticalAlignment ( ) const

virtual

Returns the vertical alignment.

This applies to CSS-based layout.

See also: setVerticalAlignment()

Implements Wt::WWidget.

WLength Wt::WCompositeWidget::verticalAlignmentLength ( ) const

virtual

Returns the fixed vertical alignment that was set.

This applies to CSS-based layout.

See also: setVerticalAlignment()

Implements Wt::WWidget.

WLength Wt::WCompositeWidget::width ( ) const

virtual

Returns the 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.

See also: resize(const WLength&, const WLength&), height()

Implements Wt::WWidget.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation