/usr/include/Wt/WEvent 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 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 | // 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 WEVENT_H_
#define WEVENT_H_
#include <Wt/WGlobal>
#include <string>
#include <vector>
namespace Wt {
/*! \brief A coordinate.
*/
struct Coordinates {
int x; //!< X coordinate
int y; //!< Y coordinate
operator WPointF() const;
/*! \brief Constructor.
*/
Coordinates(int X, int Y) : x(X), y(Y) { }
};
/*! \brief A single finger touch of a touch event.
*
* \sa WTouchEvent
*/
class Touch {
public:
/*! \brief Constructor.
*/
Touch(unsigned identifier,
int clientX, int clientY,
int documentX, int documentY,
int screenX, int screenY,
int widgetX, int widgetY);
/*! \brief Returns the touch position relative to the document.
*/
Coordinates document() const { return Coordinates(documentX_, documentY_); }
/*! \brief Returns the touch position relative to the window.
*
* This differs from document() only when scrolling through
* the document.
*/
Coordinates window() const { return Coordinates(clientX_, clientY_); }
/*! \brief Returns the touch position relative to the screen.
*/
Coordinates screen() const { return Coordinates(screenX_, screenY_); }
/*! \brief Returns the touch position relative to the widget.
*/
Coordinates widget() const { return Coordinates(widgetX_, widgetY_); }
private:
int clientX_, clientY_;
int documentX_, documentY_;
int screenX_, screenY_;
int widgetX_, widgetY_;
unsigned identifier_;
};
class WebRequest;
class WObject;
class WString;
template<class E> class EventSignal;
class WT_API JavaScriptEvent {
public:
// for mouse events:
int clientX, clientY;
int documentX, documentY;
int screenX, screenY;
int widgetX, widgetY;
int dragDX, dragDY;
int wheelDelta;
// for key events or mouse event modifiers
int button;
int keyCode, charCode;
WFlags<KeyboardModifier> modifiers;
// for touch events
std::vector<Touch> touches, targetTouches, changedTouches;
// for gesture events
double scale, rotation;
// for scroll events
int scrollX, scrollY, viewportWidth, viewportHeight;
// event type
std::string type;
// target id
std::string tid;
std::string response;
std::vector<std::string> userEventArgs;
void get(const WebRequest& request, const std::string& se);
JavaScriptEvent();
};
/*! \class WEvent Wt/WEvent Wt/WEvent
* \brief An application event.
*
* The application is notified of an event (like a user interaction, a
* sesion timeout, an internal keep-alive event, or other event) using
* WApplication::notify().
*
* You can check for a particular event type using eventType().
*/
class WT_API WEvent {
public:
struct Impl;
/*! \brief Returns the event type.
*/
EventType eventType() const;
private:
WEvent(const Impl& impl)
: impl_(impl)
{ }
const Impl& impl_;
friend class WebSession;
friend class WebController;
};
#ifdef WT_TARGET_JAVA
/*! \class WAbstractEvent Wt/WEvent Wt/WEvent
* \brief Internal class WAbstractEvent.
*/
class WAbstractEvent
{
public:
virtual WAbstractEvent *createFromJSEvent(const JavaScriptEvent& jsEvent) = 0;
};
#endif // WT_TARGET_JAVA
/*! \class WMouseEvent Wt/WEvent Wt/WEvent
* \brief A class providing details for a mouse event.
*
* \sa WInteractWidget::clicked(), WInteractWidget::doubleClicked(),
* WInteractWidget::mouseWentDown(), WInteractWidget::mouseWentUp(),
* WInteractWidget::mouseWentOver(), WInteractWidget::mouseMoved()
*
* \ingroup signalslot
*/
class WT_API WMouseEvent
#ifdef WT_TARGET_JAVA
: public WAbstractEvent
#endif // WT_TARGET_JAVA
{
public:
/*! \brief Default constructor
*/
WMouseEvent();
/*! \brief Enumeration for the mouse button.
*/
enum Button { NoButton = 0, //!< No button
LeftButton = 1, //!< Left button
MiddleButton = 2, //!< Middle button
RightButton = 4 //!< Right button
};
/*! \brief Mouse coordinates.
*/
typedef Wt::Coordinates Coordinates;
/*! \brief Returns the button.
*
* If multiple buttons are currently pressed for a mouse moved or
* mouse dragged event, then the one with the smallest numerical value
* is returned.
*/
Button button() const { return (Button)jsEvent_.button; }
/*! \brief Returns keyboard modifiers.
*
* The result is a logical OR of \link Wt::KeyboardModifier
* KeyboardModifier\endlink flags.
*/
WFlags<KeyboardModifier> modifiers() const { return jsEvent_.modifiers; }
/*! \brief Returns the mouse position relative to the document.
*/
Coordinates document() const
{ return Coordinates(jsEvent_.documentX, jsEvent_.documentY); }
/*! \brief Returns the mouse position relative to the window.
*
* This differs from documentX() only through scrolling
* through the document.
*/
Coordinates window() const
{ return Coordinates(jsEvent_.clientX, jsEvent_.clientY); }
/*! \brief Returns the mouse position relative to the screen.
*/
Coordinates screen() const
{ return Coordinates(jsEvent_.screenX, jsEvent_.screenY); }
/*! \brief Returns the mouse position relative to the widget.
*/
Coordinates widget() const
{ return Coordinates(jsEvent_.widgetX, jsEvent_.widgetY); }
/*! \brief Returns the distance over which the mouse has been dragged.
*
* This is only defined for a WInteractWidget::mouseWentUp() event.
*/
Coordinates dragDelta() const
{ return Coordinates(jsEvent_.dragDX, jsEvent_.dragDY); }
/*! \brief Returns the scroll wheel delta.
*
* This is 1 when wheel was scrolled up or -1 when wheel was scrolled down.
*
* This is only defined for a WInteractWidget::mouseWheel() event.
*/
int wheelDelta() const { return jsEvent_.wheelDelta; }
#ifndef WT_DEPRECATED_3_0_0
/*! \brief Returns whether the alt key is pressed (<b>deprecated</b>).
*
* \deprecated Use modifiers() instead.
*/
bool altKey() const { return (jsEvent_.modifiers & AltModifier) != 0; }
/*! \brief Returns whether the meta key is pressed (<b>deprecated</b>).
*
* \deprecated Use modifiers() instead.
*/
bool metaKey() const { return (jsEvent_.modifiers & MetaModifier) != 0; }
/*! \brief Returns whether the control key is pressed (<b>deprecated</b>).
*
* \deprecated Use modifiers() instead.
*/
bool ctrlKey() const { return (jsEvent_.modifiers & ControlModifier) != 0; }
/*! \brief Returns whether the shift key is pressed (<b>deprecated</b>).
*
* \deprecated Use modifiers() instead.
*/
bool shiftKey() const { return (jsEvent_.modifiers & ShiftModifier) != 0; }
#endif // WT_DEPRECATED_3_0_0
#ifdef WT_TARGET_JAVA
virtual WAbstractEvent *createFromJSEvent(const JavaScriptEvent& jsEvent)
{
return new WMouseEvent(jsEvent);
}
static WMouseEvent templateEvent;
#endif // WT_TARGET_JAVA
WMouseEvent(const JavaScriptEvent& jsEvent);
protected:
JavaScriptEvent jsEvent_;
};
/*! \class WKeyEvent Wt/WEvent Wt/WEvent
* \brief A class providing details for a keyboard event.
*
* A key event is associated with the WInteractWidget::keyWentDown(),
* WInteractWidget::keyWentUp() and WInteractWidget::keyPressed()
* signals.
*
* \ingroup signalslot
*/
class WT_API WKeyEvent
#ifdef WT_TARGET_JAVA
: public WAbstractEvent
#endif // WT_TARGET_JAVA
{
public:
/*! \brief Default constructor
*/
WKeyEvent();
/*! \brief Returns the key code key that was pressed or released.
*
* The key code corresponds to the actual key on the keyboard,
* rather than the generated character.
*
* All three types of key events provide this information.
*
* \sa modifiers(), charCode()
*/
Key key() const;
/*! \brief Returns keyboard modifiers.
*
* The result is a logical OR of \link Wt::KeyboardModifier
* KeyboardModifier\endlink flags.
*
* All three types of key events provide this information.
*
* \sa key(), charCode()
*/
WFlags<KeyboardModifier> modifiers() const { return jsEvent_.modifiers; }
/*! \brief Returns the unicode character code.
*
* This is only defined for a \link WInteractWidget::keyPressed
* keyPressed \endlink event, and returns the unicode character code
* of a character that is entered.
*
* For the \link WInteractWidget::keyWentDown keyWentDown \endlink
* and \link WInteractWidget::keyWentUp keyWentUp \endlink events,
* '0' is returned.
*
* The charCode() may be different from key(). For example, a \link
* Wt::Key_M Key_M\endlink key may correspond to 'm' or 'M'
* character, depending on whether the shift key is pressed
* simultaneously.
*
* \sa key(), text()
*/
int charCode() const;
/*! \brief The (unicode) text that this key generated.
*
* This is only defined for a \link WInteractWidget::keyPressed
* keyPressed \endlink event, and returns a string that holds
* exactly one unicode character, which corresponds to charCode().
*
* For the \link WInteractWidget::keyWentDown keyWentDown \endlink
* and \link WInteractWidget::keyWentUp keyWentUp \endlink events,
* an empty string is returned.
*
* \sa charCode()
*/
WT_USTRING text() const;
#ifndef WT_DEPRECATED_3_0_0
/*! \brief Returns the raw key code (<b>deprecated</b>).
*
* \deprecated The value returned is somewhat browser-specific, and
* it is therefore recommended to use the key() method instead.
*
* \sa key()
*/
int keyCode() const { return jsEvent_.keyCode; }
/*! \brief Returns whether the alt key is pressed (<b>deprecated</b>).
*
* \deprecated Use modifiers() instead.
*/
bool altKey() const { return (jsEvent_.modifiers & AltModifier) != 0; }
/*! \brief Returns whether the meta key is pressed (<b>deprecated</b>).
*
* \deprecated Use modifiers() instead.
*/
bool metaKey() const { return (jsEvent_.modifiers & MetaModifier) != 0; }
/*! \brief Returns whether the control key is pressed (<b>deprecated</b>).
*
* \deprecated Use modifiers() instead.
*/
bool ctrlKey() const { return (jsEvent_.modifiers & ControlModifier) != 0; }
/*! \brief Returns whether the shift key is pressed (<b>deprecated</b>).
*
* \deprecated Use modifiers() instead.
*/
bool shiftKey() const { return (jsEvent_.modifiers & ShiftModifier) != 0; }
#endif // WT_DEPRECATED_3_0_0
#ifdef WT_TARGET_JAVA
virtual WAbstractEvent *createFromJSEvent(const JavaScriptEvent& jsEvent)
{
return new WKeyEvent(jsEvent);
}
static WKeyEvent templateEvent;
#endif // WT_TARGET_JAVA
WKeyEvent(const JavaScriptEvent& jsEvent);
private:
JavaScriptEvent jsEvent_;
};
/*! \class WDropEvent Wt/WEvent Wt/WEvent
* \brief A class providing details for a drop event.
*
* \sa WWidget::dropEvent(WDropEvent)
*
* \ingroup signalslot
*/
class WT_API WDropEvent
{
public:
/*! \brief Constructor.
*/
WDropEvent(WObject *source, const std::string& mimeType,
const WMouseEvent& mouseEvent);
/*! \brief Returns the source of the drag&drop operation.
*
* The source is the widget that was set draggable using
* WInteractWidget::setDraggable().
*/
WObject *source() const { return dropSource_; }
/*! \brief Returns the mime type of this drop event.
*/
const std::string& mimeType() const { return dropMimeType_; }
/*! \brief Returns the original mouse event.
*/
const WMouseEvent& mouseEvent() const { return mouseEvent_; }
private:
WObject *dropSource_;
std::string dropMimeType_;
const WMouseEvent& mouseEvent_;
};
/*! \class WScrollEvent Wt/WEvent Wt/WEvent
* \brief A class providing details for a scroll event.
*
* \sa WContainerWidget::scrolled()
*
* \ingroup signalslot
*/
class WT_API WScrollEvent
#ifdef WT_TARGET_JAVA
: public WAbstractEvent
#endif // WT_TARGET_JAVA
{
public:
/*! \brief Default constructor
*/
WScrollEvent();
/*! \brief Returns the current horizontal scroll position.
*
* \sa scrollY(), viewportWidth()
*/
int scrollX() const { return jsEvent_.scrollX; }
/*! \brief Returns the current vertical scroll position.
*
* \sa scrollX(), viewportHeight()
*/
int scrollY() const { return jsEvent_.scrollY; }
/*! \brief Returns the current horizontal viewport width.
*
* Returns the current viewport width.
*
* \sa viewportHeight(), scrollX()
*/
int viewportWidth() const { return jsEvent_.viewportWidth; }
/*! \brief Returns the current horizontal viewport height.
*
* Returns the current viewport height.
*
* \sa viewportWidth(), scrollY()
*/
int viewportHeight() const { return jsEvent_.viewportHeight; }
#ifdef WT_TARGET_JAVA
virtual WAbstractEvent *createFromJSEvent(const JavaScriptEvent& jsEvent)
{
return new WScrollEvent(jsEvent);
}
static WScrollEvent templateEvent;
#endif // WT_TARGET_JAVA
private:
JavaScriptEvent jsEvent_;
WScrollEvent(const JavaScriptEvent& jsEvent);
friend class EventSignal<WScrollEvent>;
};
/*! \class WTouchEvent Wt/WEvent Wt/WEvent
* \brief A class providing details for a touch event.
*
* \sa WInteractWidget::touchStarted(), WInteractWidget::touchMoved(),
* WInteractWidget::touchEnded()
*
* \ingroup signalslot
*/
class WT_API WTouchEvent
#ifdef WT_TARGET_JAVA
: public WAbstractEvent
#endif // WT_TARGET_JAVA
{
public:
/*! \brief Default constructor
*/
WTouchEvent();
/*! \brief Returns a list of \link Touch\endlink objects for every finger
* currently touching the screen.
*/
const std::vector<Touch>& touches() const
{ return jsEvent_.touches; }
/*! \brief Returns a list of \link Touch\endlink objects for finger touches
* that started out within the same widget.
*/
const std::vector<Touch>& targetTouches() const
{ return jsEvent_.targetTouches; }
/*! \brief Returns a list of \link Touch\endlink objects for every finger
* involved in the event.
*/
const std::vector<Touch>& changedTouches() const
{ return jsEvent_.changedTouches; }
#ifdef WT_TARGET_JAVA
virtual WAbstractEvent *createFromJSEvent(const JavaScriptEvent& jsEvent)
{
return new WTouchEvent(jsEvent);
}
static WTouchEvent templateEvent;
#endif // WT_TARGET_JAVA
WTouchEvent(const JavaScriptEvent& jsEvent);
protected:
JavaScriptEvent jsEvent_;
};
/*! \class WGestureEvent Wt/WEvent Wt/WEvent
* \brief A class providing details for a gesture event.
*
* \sa WInteractWidget::gestureStarted(), WInteractWidget::gestureChanged(),
* WInteractWidget::gestureEnded()
*
* \ingroup signalslot
*/
class WT_API WGestureEvent
#ifdef WT_TARGET_JAVA
: public WAbstractEvent
#endif // WT_TARGET_JAVA
{
public:
/*! \brief Default constructor
*/
WGestureEvent();
/*! \brief Returns the multiplier which the user has pinched or pushed
(relative to 1).
*/
double scale() const { return jsEvent_.scale; }
/*! \brief Returns the number of degrees the user has rotated his/her fingers.
*/
double rotation() const { return jsEvent_.rotation; }
#ifdef WT_TARGET_JAVA
virtual WAbstractEvent *createFromJSEvent(const JavaScriptEvent& jsEvent)
{
return new WGestureEvent(jsEvent);
}
static WGestureEvent templateEvent;
#endif // WT_TARGET_JAVA
WGestureEvent(const JavaScriptEvent& jsEvent);
protected:
JavaScriptEvent jsEvent_;
};
}
#endif // WEVENT_H_
|