Wt  3.2.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions
Wt::WPushButton Class Reference

A widget that represents a push button. More...

#include <Wt/WPushButton>

Inheritance diagram for Wt::WPushButton:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 WPushButton (WContainerWidget *parent=0)
 Creates a push button.
 WPushButton (const WString &text, WContainerWidget *parent=0)
 Creates a push button with given label text.
void setText (const WString &text)
 Sets the button text.
const WStringtext () const
 Returns the button text.
void setIcon (const WLink &link)
 Sets an icon.
WLink icon () const
 Returns the icon.
void setLink (const WLink &link)
 Sets a destination link.
const WLinklink () const
 Returns the destination link.
void setRef (const std::string &url)
 Sets a destination URL (deprecated).
std::string ref () const
 Returns the destination URL (deprecated).
void setResource (WResource *resource)
 Sets a destination resource (deprecated).
WResourceresource () const
 Returns the destination resource (deprecated).
virtual WString valueText () const
 Returns the current value.
virtual void setValueText (const WString &value)
 Sets the current value.
void setLinkTarget (AnchorTarget target)
 Sets the link target.
AnchorTarget linkTarget () const
 Returns the location where the linked content should be displayed.
virtual void refresh ()
 Refresh the widget.
- Public Member Functions inherited from Wt::WFormWidget
 WFormWidget (WContainerWidget *parent=0)
 Creates a WFormWidget with an optional parent.
 ~WFormWidget ()
 Destructor.
WLabellabel () const
 Returns the label associated with this widget.
virtual void setHidden (bool hidden, const WAnimation &animation=WAnimation())
 Sets the hidden state of this widget.
void setValidator (WValidator *validator)
 Sets a validator for this field.
WValidatorvalidator () const
 Returns the validator.
virtual WValidator::State validate ()
 Validates the field.
void setEnabled (bool enabled)
 Sets whether the widget is enabled.
void setFocus ()
 Gives focus.
void setFocus (bool focus)
 Changes focus.
bool hasFocus () const
 Returns whether this widget has focus.
virtual void setTabIndex (int index)
 Sets the tab index.
virtual int tabIndex () const
 Returns the tab index.
void setReadOnly (bool readOnly)
 Sets the element read-only.
bool isReadOnly () const
 Returns whether the form element is read-only.
void setEmptyText (const WString &emptyText)
 Sets the empty text to be shown when the field is empty.
const WStringemptyText ()
 Returns the empty text to be shown when the field is empty.
EventSignalchanged ()
 Signal emitted when the value was changed.
EventSignalselected ()
 Signal emitted when ??
EventSignalblurred ()
 Signal emitted when the widget lost focus.
EventSignalfocussed ()
 Signal emitted when the widget recieved focus.
- Public Member Functions inherited from Wt::WInteractWidget
 WInteractWidget (WContainerWidget *parent=0)
 Create an InteractWidget with optional parent.
EventSignal< WKeyEvent > & keyWentDown ()
 Event signal emitted when a keyboard key is pushed down.
EventSignal< WKeyEvent > & keyPressed ()
 Event signal emitted when a "character" was entered.
EventSignal< WKeyEvent > & keyWentUp ()
 Event signal emitted when a keyboard key is released.
EventSignalenterPressed ()
 Event signal emitted when enter was pressed.
EventSignalescapePressed ()
 Event signal emitted when escape was pressed.
EventSignal< WMouseEvent > & clicked ()
 Event signal emitted when a mouse key was clicked on this widget.
EventSignal< WMouseEvent > & doubleClicked ()
 Event signal emitted when a mouse key was double clicked on this widget.
EventSignal< WMouseEvent > & mouseWentDown ()
 Event signal emitted when a mouse key was pushed down on this widget.
EventSignal< WMouseEvent > & mouseWentUp ()
 Event signal emitted when a mouse key was released on this widget.
EventSignal< WMouseEvent > & mouseWentOut ()
 Event signal emitted when the mouse went out of this widget.
EventSignal< WMouseEvent > & mouseWentOver ()
 Event signal emitted when the mouse entered this widget.
EventSignal< WMouseEvent > & mouseMoved ()
 Event signal emitted when the mouse moved over this widget.
EventSignal< WMouseEvent > & mouseDragged ()
 Event signal emitted when the mouse is dragged over this widget.
EventSignal< WMouseEvent > & mouseWheel ()
 Event signal emitted when the mouse scroll wheel was used.
EventSignal< WTouchEvent > & touchStarted ()
 Event signal emitted when a finger is placed on the screen.
EventSignal< WTouchEvent > & touchEnded ()
 Event signal emitted when a finger is removed from the screen.
EventSignal< WTouchEvent > & touchMoved ()
 Event signal emitted when a finger, which is already placed on the screen, is moved across the screen.
EventSignal< WGestureEvent > & gestureStarted ()
 Event signal emitted when a gesture is started.
EventSignal< WGestureEvent > & gestureChanged ()
 Event signal emitted when a gesture is changed.
EventSignal< WGestureEvent > & gestureEnded ()
 Event signal emitted when a gesture is ended.
void setDraggable (const std::string &mimeType, WWidget *dragWidget=0, bool isDragWidgetOnly=false, WObject *sourceWidget=0)
 Configure dragging for drag and drop.
virtual void load ()
 Loads content just before the widget is used.
virtual bool isEnabled () const
 Returns whether the widget is enabled.
- Public Member Functions inherited from Wt::WWebWidget
 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< SideclearSides () 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 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 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 WCssDecorationStyledecorationStyle ()
 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 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 bool loaded () const
 Returns whether this widget has been loaded.
virtual void setId (const std::string &id)
 Sets the CSS Id.
virtual WWidgetfind (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.
SignalchildrenChanged ()
 Signal emitted when children have been added or removed.
bool isRendered () const
 Returns whether the widget is rendered.
- Public Member Functions inherited from Wt::WWidget
virtual ~WWidget ()
 Destructor.
WWidgetparent () 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.
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.
- Public Member Functions inherited from Wt::WObject
 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

- Protected Member Functions inherited from Wt::WFormWidget
virtual void enableAjax ()
 Progresses to an Ajax-enabled widget.
virtual WStatelessSlot * getStateless (Method method)
 On-demand stateless slot implementation.
virtual void propagateSetEnabled (bool enabled)
 Propagates that a widget was enabled or disabled through children.

Detailed Description

A widget that represents a push button.

To act on a button click, connect a slot to the clicked() signal.

Usage example:

Wt::WPushButton *ok = new Wt::WPushButton("Okay");
ok->clicked().connect(ok, &Wt::WPushButton::disable);
ok->clicked().connect(this, &MyClass::processData);

WPushButton is an inline widget.

CSS

The widget corresponds to the HTML <button> tag and has the Wt-btn style. It may be styled through the current theme, or you can override the style using internal or external CSS as appropriate.


Member Function Documentation

WLink Wt::WPushButton::icon ( ) const

Returns the icon.

See also:
setIcon()
const WLink& Wt::WPushButton::link ( ) const

Returns the destination link.

See also:
setLink()
AnchorTarget Wt::WPushButton::linkTarget ( ) const

Returns the location where the linked content should be displayed.

See also:
setLinkTarget()
std::string Wt::WPushButton::ref ( ) const

Returns the destination URL (deprecated).

When the button refers to a resource, the current resource URL is returned. Otherwise, the URL is returned that was set using setRef().

See also:
setRef(), WResource::url()
Deprecated:
Use link() instead.
void Wt::WPushButton::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.

Reimplemented from Wt::WFormWidget.

WResource* Wt::WPushButton::resource ( ) const

Returns the destination resource (deprecated).

Returns 0 if no resource has been set.

See also:
setResource()
Deprecated:
Use link() instead.
void Wt::WPushButton::setIcon ( const WLink link)

Sets an icon.

The icon is placed to the left of the text.

void Wt::WPushButton::setLink ( const WLink link)

Sets a destination link.

This method can be used to make the button behave like a WAnchor (or conversely, an anchor look like a button) and redirect to another URL when clicked.

The link may be to a URL, a resource, or an internal path.

By default, a button does not link to an URL and you should listen to the clicked() signal to react to a click event.

void Wt::WPushButton::setLinkTarget ( AnchorTarget  target)

Sets the link target.

This sets the target where the linked contents should be displayed. The default target is TargetSelf.

void Wt::WPushButton::setRef ( const std::string &  url)

Sets a destination URL (deprecated).

Deprecated:
Use setLink() insteadd.
void Wt::WPushButton::setResource ( WResource resource)

Sets a destination resource (deprecated).

This method can be used to make the button behave like a WAnchor (or conversely, an anchor look like a button) and redirect to another resource when clicked.

A resource specifies application-dependent content, which may be generated by your application on demand.

This sets the resource as the destination of the button, and is an alternative to setRef(). The resource may be cleared by passing resource = 0.

The button does not assume ownership of the resource.

See also:
setRef()
Deprecated:
Use setLink() instead.
void Wt::WPushButton::setValueText ( const WString value)
virtual

Sets the current value.

Has no effect, since a button has not value.

Implements Wt::WFormWidget.

const WString& Wt::WPushButton::text ( ) const

Returns the button text.

See also:
setText()
WString Wt::WPushButton::valueText ( ) const
virtual

Returns the current value.

Returns an empty string, since a button has no value.

Implements Wt::WFormWidget.


Generated on Wed Jun 13 2012 for the C++ Web Toolkit (Wt) by doxygen 1.8.1