Wt::WPopupWidget Class Reference

Base class for popup widgets. More...

#include <Wt/WPopupWidget>

Inheritance diagram for Wt::WPopupWidget:

Public Member Functions
	WPopupWidget (WWidget *impl, WObject *parent=0)
	Constructor. More...
virtual	~WPopupWidget ()
	Destructor.
void	setAnchorWidget (WWidget *widget, Orientation orientation=Vertical)
	Sets an anchor widget. More...
Orientation	orientation () const
	Returns the orientation. More...
void	setTransient (bool transient, int autoHideDelay=0)
	Sets transient property. More...
bool	isTransient () const
	Returns whether the popup is transient. More...
int	autoHideDelay () const
	Returns the auto-hide delay. More...
void	setDeleteWhenHidden (bool enabled)
	Lets the popup delete itself when hidden. More...
bool	isDeleteWhenHidden () const
	Returns whether auto delete is enabled. More...
virtual void	setHidden (bool hidden, const WAnimation &animation=WAnimation())
	Hides or shows the widget. More...
Signal &	hidden ()
	Signal emitted when the popup is hidden. More...
Signal &	shown ()
	Signal emitted when the popup is shown. More...
Public Member Functions inherited from Wt::WCompositeWidget
	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 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	render (WFlags< RenderFlag > flags)
	Renders the widget. More...
Protected Member Functions inherited from Wt::WCompositeWidget
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...
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

Base class for popup widgets.

A popup widget anchors to another widget, for which it usually provides additional information or assists in editing, etc...

The popup widget will position itself relative to the anchor widget by taking into account available space, and switching sides if necessary to fit the widget into the current window. For example, a vertically anchored widget will by default be a "drop-down", positioning itself under the anchor widget, but it may also choose to position itself above the anchor widget if space is lacking below.

Constructor & Destructor Documentation

Wt::WPopupWidget::WPopupWidget	(	WWidget *	impl,
		WObject *	parent = 0
	)

Constructor.

You need to pass in a widget that provides the main contents of the widget (e.g. a WTemplate or WContainerWidget).

Unlike other widgets, a popup widget does not need a parent widget (it acts like a pseudo top-level widget), but it can be given a parent object which is used to scope its lifetime.

Member Function Documentation

int Wt::WPopupWidget::autoHideDelay

(

)

const

Returns the auto-hide delay.

See also

setTransient()

Signal& Wt::WPopupWidget::hidden

(

)

Signal emitted when the popup is hidden.

This signal is emitted when the popup is being hidden because of a client-side event (not when setHidden() or hide() is called).

bool Wt::WPopupWidget::isDeleteWhenHidden

(

)

const

Returns whether auto delete is enabled.

See also

setDeleteWhenHidden()

bool Wt::WPopupWidget::isTransient

(

)

const

Returns whether the popup is transient.

See also

setTransient()

Orientation Wt::WPopupWidget::orientation

(

)

const

Returns the orientation.

See also

setOrientation()

void Wt::WPopupWidget::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::WCompositeWidget.

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

void Wt::WPopupWidget::setAnchorWidget	(	WWidget *	widget,
		Orientation	orientation = Vertical
	)

Sets an anchor widget.

A vertical popup will show below (or above) the widget, while a horizontal popup will show right (or left) of the widget.

void Wt::WPopupWidget::setDeleteWhenHidden

(

bool

enabled

)

Lets the popup delete itself when hidden.

When this is enabled, the popup will delete itself when hidden. You need to take care that when overriding setHidden(), the popup may thus be deleted from within WPopupWidget::setHidden().

The default value is false.

void Wt::WPopupWidget::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().

Reimplemented from Wt::WCompositeWidget.

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

void Wt::WPopupWidget::setTransient	(	bool	transient,
		int	autoHideDelay = 0
	)

Sets transient property.

A transient popup will automatically hide when the user clicks outside of the popup. When autoHideDelay is not 0, then it will also automatically hide when the user moves the mouse outside the widget for longer than this delay.

Signal& Wt::WPopupWidget::shown

(

)

Signal emitted when the popup is shown.

This signal is emitted when the popup is being hidden because of a client-side event (not when setHidden() or show() is called).