Wt::WInteractWidget Class Reference

A widget that can receive user-interface interaction. More...

#include <Wt/WInteractWidget>

Inheritance diagram for Wt::WInteractWidget:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 WInteractWidget (WContainerWidget *parent=0)
 Create an InteractWidget with optional parent.
void setDraggable (const std::string &mimeType, WWidget *dragWidget=0, bool isDragWidgetOnly=false, WObject *sourceWidget=0)
 Configure dragging.

Public Attributes

EventSignal< WKeyEventkeyWentDown
 Event signal emitted when a keyboard key is pushed down.
EventSignal< WKeyEventkeyPressed
 Event signal emitted when a "character" was entered.
EventSignal< WKeyEventkeyWentUp
 Event signal emitted when a keyboard key is released.
EventSignal< void > enterPressed
 Event signal emitted when enter was pressed.
EventSignal< void > escapePressed
 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.


Detailed Description

A widget that can receive user-interface interaction.

This abstract widget provides access to event signals that correspond to user-interface interaction through mouse or keyboard.

When JavaScript is disabled, only the clicked event will propagate (but without event details information).


Member Function Documentation

void Wt::WInteractWidget::setDraggable ( const std::string &  mimeType,
WWidget dragWidget = 0,
bool  isDragWidgetOnly = false,
WObject sourceWidget = 0 
)

Configure dragging.

Enable drag&drop for this widget. The mimeType is used to find a suitable drop target, which must accept dropping of this mimetype.

By default, the entire widget is dragged. One may specify another widget to be dragged (for example the parent), or a drag widget whose function is only to represent the drag visually (when isDragWidgetOnly = true).

The widget to be identified as source in the dropEvent may be given explicitly, and will default to this widget otherwise.

See also:
WWidget::dropEvent, WWidget::acceptDrops, WDropEvent
Note:
When JavaScript is disabled, drag&drop does not work.


Member Data Documentation

EventSignal<WKeyEvent> Wt::WInteractWidget::keyWentDown

Event signal emitted when a keyboard key is pushed down.

The keyWentDown signal is the first signal emitted when a key is pressed (before the keyPressed signal). Unlike keyPressed however it is also emitted for modifier keys (such as "shift", "control", ...) or keyboard navigation keys that do not have a corresponding character.

See also:
WInteractWidget::keyPressed, WInteractWidget::keyWentUp

EventSignal<WKeyEvent> Wt::WInteractWidget::keyPressed

Event signal emitted when a "character" was entered.

The keyPressed signal is emitted when a key is pressed, and a character is entered. Unlike WInteractWidget::keyWentDown, it is emitted only for key presses that result in a character being entered, and thus not for modifier keys or keyboard navigation keys.

See also:
WInteractWidget::keyWentDown

EventSignal<WKeyEvent> Wt::WInteractWidget::keyWentUp

Event signal emitted when a keyboard key is released.

This is the counter-part of the WInteractWidget::keyWentDown event. Every key-down has its corresponding key-up.

See also:
WInteractWidget::keyWentDown

EventSignal<void> Wt::WInteractWidget::enterPressed

Event signal emitted when enter was pressed.

This signal is emitted when the Enter or Return key was pressed.

See also:
keyPressed, Key_Enter

EventSignal<void> Wt::WInteractWidget::escapePressed

Event signal emitted when escape was pressed.

This signal is emitted when the Escape key was pressed.

See also:
keyPressed, Key_Escape

EventSignal<WMouseEvent> Wt::WInteractWidget::clicked

Event signal emitted when a mouse key was clicked on this widget.

The event details contains information such as the button, optional keyboard modifiers, and mouse coordinates relative to the widget, the window window, or the document.

Note:
When JavaScript is disabled, the event details contain invalid information.

EventSignal<WMouseEvent> Wt::WInteractWidget::doubleClicked

Event signal emitted when a mouse key was double clicked on this widget.

The event details contains information such as the button, optional keyboard modifiers, and mouse coordinates relative to the widget, the window window, or the document.

Note:
When JavaScript is disabled, the signal will never fire.

EventSignal<WMouseEvent> Wt::WInteractWidget::mouseWentDown

Event signal emitted when a mouse key was pushed down on this widget.

The event details contains information such as the button, optional keyboard modifiers, and mouse coordinates relative to the widget, the window window, or the document.

Note:
When JavaScript is disabled, the signal will never fire.

EventSignal<WMouseEvent> Wt::WInteractWidget::mouseWentUp

Event signal emitted when a mouse key was released on this widget.

The event details contains information such as the button, optional keyboard modifiers, and mouse coordinates relative to the widget, the window window, or the document.

Note:
When JavaScript is disabled, the signal will never fire.

EventSignal<WMouseEvent> Wt::WInteractWidget::mouseWentOut

Event signal emitted when the mouse went out of this widget.

Note:
When JavaScript is disabled, the signal will never fire.

EventSignal<WMouseEvent> Wt::WInteractWidget::mouseWentOver

Event signal emitted when the mouse entered this widget.

Note:
When JavaScript is disabled, the signal will never fire.

EventSignal<WMouseEvent> Wt::WInteractWidget::mouseMoved

Event signal emitted when the mouse moved over this widget.

Note:
When JavaScript is disabled, the signal will never fire.


Generated on Fri Jul 25 17:56:38 2008 for Wt by doxygen 1.5.3