/usr/include/Wt/WInteractWidget is in libwt-dev 3.1.10-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 | // This may look like C code, but it's really -*- C++ -*-
/*
* Copyright (C) 2008 Emweb bvba, Kessel-Lo, Belgium.
*
* See the LICENSE file for terms of use.
*/
#ifndef WINTERACT_WIDGET_H_
#define WINTERACT_WIDGET_H_
#include <Wt/WWebWidget>
#include <Wt/WEvent>
namespace Wt {
class JSlot;
/*! \class WInteractWidget Wt/WInteractWidget Wt/WInteractWidget
* \brief An abstract 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).
*
* <h3>CSS</h3>
*
* Styling through CSS is not applicable.
*/
class WT_API WInteractWidget : public WWebWidget
{
public:
/*! \brief Create an InteractWidget with optional parent.
*/
WInteractWidget(WContainerWidget *parent = 0);
~WInteractWidget();
/*! \brief 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.
*
* Form widgets (like WLineEdit) will receive key events when
* focussed. Other widgets will receive key events when they contain
* (directly or indirectly) a form widget that has focus.
*
* To capture a key down event when no element has focus, see
* WApplication::globalKeyWentDown()
*
* \sa keyPressed(), keyWentUp()
*/
EventSignal<WKeyEvent>& keyWentDown();
/*! \brief Event signal emitted when a "character" was entered.
*
* The keyPressed signal is emitted when a key is pressed, and a
* character is entered. Unlike 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.
*
* Form widgets (like WLineEdit) will receive key events when
* focussed. Other widgets will receive key events when they contain
* (directly or indirectly) a form widget that has focus.
*
* To capture a key press when no element has focus, see
* WApplication::globalKeyPressed()
*
* \sa keyWentDown()
*/
EventSignal<WKeyEvent>& keyPressed();
/*! \brief Event signal emitted when a keyboard key is released.
*
* This is the counter-part of the keyWentDown() event. Every
* key-down has its corresponding key-up.
*
* Form widgets (like WLineEdit) will receive key events when
* focussed. Other widgets will receive key events when they contain
* (directly or indirectly) a form widget that has focus.
*
* To capture a key up event when no element has focus, see
* WApplication::globalKeyWentUp()
*
* \sa keyWentDown()
*/
EventSignal<WKeyEvent>& keyWentUp();
/*! \brief Event signal emitted when enter was pressed.
*
* This signal is emitted when the Enter or Return key was pressed.
*
* Form widgets (like WLineEdit) will receive key events when
* focussed. Other widgets will receive key events when they contain
* (directly or indirectly) a form widget that has focus.
*
* To capture an enter press when no element has focus, see
* WApplication::globalEnterPressed()
*
* \sa keyPressed(), Key_Enter
*/
EventSignal<>& enterPressed();
/*! \brief Event signal emitted when escape was pressed.
*
* This signal is emitted when the Escape key was pressed.
*
* Form widgets (like WLineEdit) will receive key events when
* focussed. Other widgets will receive key events when they contain
* (directly or indirectly) a form widget that has focus.
*
* To capture an escape press when no element has focus, see
* WApplication::globalEscapePressed()
*
* \sa keyPressed(), Key_Escape
*/
EventSignal<>& escapePressed();
/*! \brief Event signal emitted when a mouse key was clicked on this
* widget.
*
* The event details contains information such as the \link
* WMouseEvent::button button\endlink, optional \link
* WMouseEvent::modifiers() keyboard modifiers\endlink, and mouse
* coordinates relative to the \link WMouseEvent::widget()
* widget\endlink, the window \link WMouseEvent::window()
* window\endlink, or the \link WMouseEvent::document()
* document\endlink.
*
* \note When JavaScript is disabled, the event details contain
* invalid information.
*/
EventSignal<WMouseEvent>& clicked();
/*! \brief Event signal emitted when a mouse key was double clicked
* on this widget.
*
* The event details contains information such as the \link
* WMouseEvent::button button\endlink, optional \link
* WMouseEvent::modifiers() keyboard modifiers\endlink, and mouse
* coordinates relative to the \link WMouseEvent::widget()
* widget\endlink, the window \link WMouseEvent::window()
* window\endlink, or the \link WMouseEvent::document()
* document\endlink.
*
* \note When JavaScript is disabled, the signal will never fire.
*/
EventSignal<WMouseEvent>& doubleClicked();
/*! \brief Event signal emitted when a mouse key was pushed down on this
* widget.
*
* The event details contains information such as the \link
* WMouseEvent::button button\endlink, optional \link
* WMouseEvent::modifiers() keyboard modifiers\endlink, and mouse
* coordinates relative to the \link WMouseEvent::widget()
* widget\endlink, the window \link WMouseEvent::window()
* window\endlink, or the \link WMouseEvent::document()
* document\endlink.
*
* \note When JavaScript is disabled, the signal will never fire.
*/
EventSignal<WMouseEvent>& mouseWentDown();
/*! \brief Event signal emitted when a mouse key was released on this
* widget.
*
* The event details contains information such as the \link
* WMouseEvent::button button\endlink, optional \link
* WMouseEvent::modifiers() keyboard modifiers\endlink, and mouse
* coordinates relative to the \link WMouseEvent::widget()
* widget\endlink, the window \link WMouseEvent::window()
* window\endlink, or the \link WMouseEvent::document()
* document\endlink.
*
* \note When JavaScript is disabled, the signal will never fire.
*/
EventSignal<WMouseEvent>& mouseWentUp();
/*! \brief Event signal emitted when the mouse went out of this widget.
*
* \note When JavaScript is disabled, the signal will never fire.
*/
EventSignal<WMouseEvent>& mouseWentOut();
/*! \brief Event signal emitted when the mouse entered this widget.
*
* \note When JavaScript is disabled, the signal will never fire.
*/
EventSignal<WMouseEvent>& mouseWentOver();
/*! \brief Event signal emitted when the mouse moved over this widget.
*
* The mouse event contains information on the button(s) currently
* pressed. If multiple buttons are currently pressed, only the
* button with smallest enum value is returned.
*
* \note When JavaScript is disabled, the signal will never fire.
*/
EventSignal<WMouseEvent>& mouseMoved();
/*! \brief Event signal emitted when the mouse is dragged over this widget.
*
* The mouse event contains information on the button(s) currently
* pressed. If multiple buttons are currently pressed, only the
* button with smallest enum value is returned.
*
* \note When JavaScript is disabled, the signal will never fire.
*/
EventSignal<WMouseEvent>& mouseDragged();
/*! \brief Event signal emitted when the mouse scroll wheel was used.
*
* The event details contains information such as the \link
* WMouseEvent::wheelDelta() wheel delta\endlink, optional \link
* WMouseEvent::modifiers() keyboard modifiers\endlink, and mouse
* coordinates relative to the \link WMouseEvent::widget()
* widget\endlink, the window \link WMouseEvent::window()
* window\endlink, or the \link WMouseEvent::document()
* document\endlink.
*
* \note When JavaScript is disabled, the signal will never fire.
*/
EventSignal<WMouseEvent>& mouseWheel();
/*! \brief Event signal emitted when a finger is placed on the screen.
*
* The event details contains information such as the \link
* WTouchEvent::touches() touches\endlink, \link WTouchEvent::targetTouches()
* target touches\endlink and \link WTouchEvent::changedTouches() changed
* touches\endlink.
*
* \note When JavaScript is disabled, the signal will never fire.
*/
EventSignal<WTouchEvent>& touchStarted();
/*! \brief Event signal emitted when a finger is removed from the screen.
*
* The event details contains information such as the \link
* WTouchEvent::touches() touches\endlink, \link WTouchEvent::targetTouches()
* target touches\endlink and \link WTouchEvent::changedTouches() changed
* touches\endlink.
*
* \note When JavaScript is disabled, the signal will never fire.
*/
EventSignal<WTouchEvent>& touchEnded();
/*! \brief Event signal emitted when a finger, which is already placed on the
* screen, is moved across the screen.
*
* The event details contains information such as the \link
* WTouchEvent::touches() touches\endlink, \link WTouchEvent::targetTouches()
* target touches\endlink and \link WTouchEvent::changedTouches() changed
* touches\endlink.
*
* \note When JavaScript is disabled, the signal will never fire.
*/
EventSignal<WTouchEvent>& touchMoved();
/*! \brief Event signal emitted when a gesture is started.
*
* The event details contains information about the \link
* WGestureEvent::scale() scale\endlink and the \link
* WGestureEvent::rotation() rotation\endlink.
*
* \note When JavaScript is disabled, the signal will never fire.
*/
EventSignal<WGestureEvent>& gestureStarted();
/*! \brief Event signal emitted when a gesture is changed.
*
* The event details contains information about the \link
* WGestureEvent::scale() scale\endlink and the \link
* WGestureEvent::rotation() rotation\endlink.
*
* \note When JavaScript is disabled, the signal will never fire.
*/
EventSignal<WGestureEvent>& gestureChanged();
/*! \brief Event signal emitted when a gesture is ended.
*
* The event details contains information about the \link
* WGestureEvent::scale() scale\endlink and the \link
* WGestureEvent::rotation() rotation\endlink.
*
* \note When JavaScript is disabled, the signal will never fire.
*/
EventSignal<WGestureEvent>& gestureEnded();
/*! \brief Configure dragging for drag and drop.
*
* 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 as \p dragWidget) or
* a \p dragWidget whose function is only to represent the drag
* visually (when \p isDragWidgetOnly = \c true).
*
* The widget to be identified as source in the dropEvent may be given
* explicitly, and will default to this widget otherwise.
*
* \note When JavaScript is disabled, drag&drop does not work.
*
* \sa WWidget::dropEvent(), WWidget::acceptDrops(), WDropEvent
*/
void setDraggable(const std::string& mimeType, WWidget *dragWidget = 0,
bool isDragWidgetOnly = false, WObject *sourceWidget = 0);
virtual void load();
virtual bool isEnabled() const;
protected:
virtual void updateDom(DomElement& element, bool all);
virtual void propagateRenderOk(bool deep);
virtual void propagateSetEnabled(bool enabled);
void updateEventSignals(DomElement& element, bool all);
JSlot *dragSlot_;
protected:
// also used in WAbstractToggleButton
static const char *CLICK_SIGNAL;
private:
static const char *KEYDOWN_SIGNAL;
static const char *KEYPRESS_SIGNAL;
static const char *KEYUP_SIGNAL;
static const char *ENTER_PRESS_SIGNAL;
static const char *ESCAPE_PRESS_SIGNAL;
static const char *DBL_CLICK_SIGNAL;
static const char *MOUSE_DOWN_SIGNAL;
static const char *MOUSE_UP_SIGNAL;
static const char *MOUSE_OUT_SIGNAL;
static const char *MOUSE_OVER_SIGNAL;
static const char *MOUSE_MOVE_SIGNAL;
static const char *MOUSE_DRAG_SIGNAL;
static const char *MOUSE_WHEEL_SIGNAL;
static const char *TOUCH_START_SIGNAL;
static const char *TOUCH_MOVE_SIGNAL;
static const char *TOUCH_END_SIGNAL;
static const char *GESTURE_START_SIGNAL;
static const char *GESTURE_CHANGE_SIGNAL;
static const char *GESTURE_END_SIGNAL;
friend class DomElement;
friend class WWebWidget;
};
}
#endif // WINTERACT_WIDGET_H_
|