QTabletEvent

Section: Misc. Reference Manual Pages (3qt)
Updated: 2 February 2007
Index Return to Main Contents

NAME

QTabletEvent - Parameters that describe a Tablet event

SYNOPSIS

#include <qevent.h>

Inherits QEvent.

Public Members

enum TabletDevice { NoDevice = -1, Puck, Stylus, Eraser }

QTabletEvent ( Type t, const QPoint & pos, const QPoint & globalPos, int device, int pressure, int xTilt, int yTilt, const QPair<int, int> & uId )

QTabletEvent ( const QPoint & pos, const QPoint & globalPos, int device, int pressure, int xTilt, int yTilt, const QPair<int, int> & uId ) (obsolete)

int pressure () const

int xTilt () const

int yTilt () const

const QPoint & pos () const

const QPoint & globalPos () const

int x () const

int y () const

int globalX () const

int globalY () const

TabletDevice device () const

int isAccepted () const

void accept ()

void ignore ()

QPair<int, int> uniqueId ()

DESCRIPTION

The QTabletEvent class contains parameters that describe a Tablet event.

Tablet Events are generated from a Wacom© tablet. Most of the time you will want to deal with events from the tablet as if they were events from a mouse, for example retrieving the position with x(), y(), pos(), globalX(), globalY() and globalPos(). In some situations you may wish to retrieve the extra information provided by the tablet device driver, for example, you might want to adjust color brightness based on pressure. QTabletEvent allows you to get the pressure(), the xTilt() and yTilt(), as well as the type of device being used with device() (see TabletDevice).

A tablet event contains a special accept flag that indicates whether the receiver wants the event. You should call QTabletEvent::accept() if you handle the tablet event; otherwise it will be sent to the parent widget.

The QWidget::setEnabled() function can be used to enable or disable mouse and keyboard events for a widget.

The event handler QWidget::tabletEvent() receives all three types of tablet events. Qt will first send a tabletEvent and then, if it is not accepted, it will send a mouse event. This allows applications that don't utilize tablets to use a tablet like a mouse while also enabling those who want to use both tablets and mouses differently.

Member Type Documentation

QTabletEvent::TabletDevice

This enum defines what type of device is generating the event.

QTabletEvent::NoDevice - No device, or an unknown device.
QTabletEvent::Puck - A Puck (a device that is similar to a flat mouse with a transparent circle with cross-hairs).
QTabletEvent::Stylus - A Stylus (the narrow end of the pen).
QTabletEvent::Eraser - An Eraser (the broad end of the pen).

MEMBER FUNCTION DOCUMENTATION

QTabletEvent::QTabletEvent ( Type t, const QPoint & pos, const QPoint & globalPos, int device, int pressure, int xTilt, int yTilt, const QPair<int, int> & uId )

Construct a tablet event of type t. The position of when the event occurred is given int pos and globalPos. device contains the device type, pressure contains the pressure exerted on the device, xTilt and yTilt contain device's degree of tilt from the X and Y axis respectively. The uId contains an event id.

On Irix, globalPos will contain the high-resolution coordinates received from the tablet device driver, instead of from the windowing system.

See also pos(), globalPos(), device(), pressure(), xTilt(), and yTilt().

QTabletEvent::QTabletEvent ( const QPoint & pos, const QPoint & globalPos, int device, int pressure, int xTilt, int yTilt, const QPair<int, int> & uId )

This function is obsolete. It is provided to keep old source working. We strongly advise against using it in new code.

Constructs a tablet event object. The position when the event occurred is is given in pos and globalPos. device contains the device type, pressure contains the pressure exerted on the device, xTilt and yTilt contain the device's degrees of tilt from the X and Y axis respectively. The uId contains an event id.

On Irix, globalPos will contain the high-resolution coordinates received from the tablet device driver, instead of from the windowing system.

See also pos(), globalPos(), device(), pressure(), xTilt(), and yTilt().

void QTabletEvent::accept ()

Sets the accept flag of the tablet event object.

Setting the accept flag indicates that the receiver of the event wants the tablet event. Unwanted tablet events are sent to the parent widget.

The accept flag is set by default.

TabletDevice QTabletEvent::device () const

Returns the type of device that generated the event. Useful if you want one end of the pen to do something different than the other.

const QPoint & QTabletEvent::globalPos () const

Returns the global position of the device at the time of the event. This is important on asynchronous windows systems like X11; whenever you move your widgets around in response to mouse events, globalPos() can differ significantly from the current position QCursor::pos().

int QTabletEvent::globalX () const

Returns the global x-position of the mouse pointer at the time of the event.

int QTabletEvent::globalY () const

Returns the global y-position of the mouse pointer at the time of the event.

void QTabletEvent::ignore ()

Clears the accept flag parameter of the tablet event object.

Clearing the accept flag indicates that the event receiver does not want the tablet event. Unwanted tablet events are sent to the parent widget.

The accept flag is set by default.

int QTabletEvent::isAccepted () const

Returns TRUE if the receiver of the event handles the tablet event; otherwise returns FALSE.

const QPoint & QTabletEvent::pos () const

Returns the position of the device, relative to the widget that received the event.

If you move widgets around in response to mouse events, use globalPos() instead of this function.

int QTabletEvent::pressure () const

Returns the pressure that is exerted on the device. This number is a value from 0 (no pressure) to 255 (maximum pressure). The pressure is always scaled to be within this range no matter how many pressure levels the underlying hardware supports.

QPair<int, int> QTabletEvent::uniqueId ()

Returns a unique ID for the current device. It is possible to generate a unique ID for any Wacom© device. This makes it possible to differentiate between multiple devices being used at the same time on the tablet. The first member contains a value for the type, the second member contains a physical ID obtained from the device. Each combination of these values is unique. Note: for different platforms, the first value is different due to different driver implementations.

int QTabletEvent::x () const

Returns the x-position of the device, relative to the widget that received the event.

int QTabletEvent::xTilt () const

Returns the difference from the perpendicular in the X Axis. Positive values are towards the tablet's physical right. The angle is in the range -60 to +60 degrees.

int QTabletEvent::y () const

Returns the y-position of the device, relative to the widget that received the event.

int QTabletEvent::yTilt () const

Returns the difference from the perpendicular in the Y Axis. Positive values are towards the bottom of the tablet. The angle is within the range -60 to +60 degrees.

COPYRIGHT

AUTHOR

Generated automatically from the source code.

BUGS

If you find a bug in Qt, please report it as described in http://doc.trolltech.com/bughowto.html. Good bug reports help us to help you. Thank you. The definitive Qt documentation is provided in HTML format; it is located at $QTDIR/doc/html and can be read using Qt Assistant or with a web browser. This man page is provided as a convenience for those users who prefer man pages, although this format is not officially supported by Trolltech. If you find errors in this manual page, please report them to qt-bugs@trolltech.com. Please include the name of the manual page (qtabletevent.3qt) and the Qt version (3.3.8).