CopperSpice API  1.7.2
QGestureEvent Class Reference

The QGestureEvent class provides the description of triggered gestures. More...

Inheritance diagram for QGestureEvent:
QEvent

Public Methods

 QGestureEvent (const QList< QGesture * > &gestures)
 
 ~QGestureEvent ()
 
void accept ()
 
void accept (QGesture *gesture)
 
void accept (Qt::GestureType gestureType)
 
QList< QGesture * > activeGestures () const
 
QList< QGesture * > canceledGestures () const
 
QGesturegesture (Qt::GestureType gestureType) const
 
QList< QGesture * > gestures () const
 
void ignore ()
 
void ignore (QGesture *gesture)
 
void ignore (Qt::GestureType gestureType)
 
bool isAccepted () const
 
bool isAccepted (QGesture *gesture) const
 
bool isAccepted (Qt::GestureType gestureType) const
 
QPointF mapToGraphicsScene (const QPointF &gesturePoint) const
 
void setAccepted (bool accepted)
 
void setAccepted (QGesture *gesture, bool isAccepted)
 
void setAccepted (Qt::GestureType gestureType, bool isAccepted)
 
void setWidget (QWidget *widget)
 
QWidgetwidget () const
 
- Public Methods inherited from QEvent
 QEvent (const QEvent &other)
 
 QEvent (Type type)
 
virtual ~QEvent ()
 
void accept ()
 
void ignore ()
 
bool isAccepted () const
 
QEvent & operator= (const QEvent &other)
 
void setAccepted (bool accepted)
 
bool spontaneous () const
 
Type type () const
 

Friends

class QApplication
 

Additional Inherited Members

- Public Types inherited from QEvent
enum  Type
 
- Static Public Methods inherited from QEvent
static int registerEventType (int hint=-1)
 

Detailed Description

The QGestureEvent class provides the description of triggered gestures.

The QGestureEvent class contains a list of gestures, which can be obtained using the gestures() function.

The gestures are either active or canceled. A list of those that are currently being executed can be obtained using the activeGestures() function. A list of those which were previously active and have been canceled can be accessed using the canceledGestures() function. A gesture might be canceled if the current window loses focus, for example, or because of a timeout, or for other reasons.

If the event handler does not accept the event by calling the generic QEvent::accept() function, all individual QGesture object that were not accepted and in the Qt::GestureStarted state will be propagated up the parent widget chain until a widget accepts them individually, by calling QGestureEvent::accept() for each of them, or an event filter consumes the event.

Further Reading

For an overview of gesture handling in CopperSpice and information on using gestures in your applications, refer to Gestures Programming.

See also
QGesture, QGestureRecognizer, QWidget::grabGesture(), QGraphicsObject::grabGesture()

Constructor & Destructor Documentation

QGestureEvent::QGestureEvent ( const QList< QGesture * > &  gestures)
explicit

Creates new QGestureEvent containing a list of gestures.

QGestureEvent::~QGestureEvent ( )

Destroys QGestureEvent.

Method Documentation

void QEvent::accept ( )
usinginline

Sets the accept flag of the event object, the equivalent of calling setAccepted(true). Setting the accept parameter indicates that the event receiver wants the event. Unwanted events might be propagated to the parent widget.

See also
ignore()
void QGestureEvent::accept ( QGesture gesture)

Sets the accept flag of the given gesture object, the equivalent of calling setAccepted(gesture, true).

Setting the accept flag indicates that the event receiver wants the gesture. Unwanted gestures may be propagated to the parent widget.

See also
QGestureEvent::ignore()
void QGestureEvent::accept ( Qt::GestureType  gestureType)

Sets the accept flag of the given gestureType, the equivalent of calling setAccepted(gestureType, true).

Setting the accept flag indicates that the event receiver wants the gesture. Unwanted gestures may be propagated to the parent widget.

See also
QGestureEvent::ignore()
QList< QGesture * > QGestureEvent::activeGestures ( ) const

Returns a list of active (not canceled) gestures.

QList< QGesture * > QGestureEvent::canceledGestures ( ) const

Returns a list of canceled gestures.

QGesture * QGestureEvent::gesture ( Qt::GestureType  gestureType) const

Returns a gesture object by gestureType.

QList< QGesture * > QGestureEvent::gestures ( ) const

Returns all gestures that are delivered in the event.

void QEvent::ignore ( )
usinginline

Clears the accept flag parameter of the event object, the equivalent of calling setAccepted(false).

Clearing the accept parameter indicates that the event receiver does not want the event. Unwanted events might be propagated to the parent widget.

See also
accept()
void QGestureEvent::ignore ( QGesture gesture)

Clears the accept flag parameter of the given gesture object, the equivalent of calling setAccepted(gesture, false).

Clearing the accept flag indicates that the event receiver does not want the gesture. Unwanted gestures may be propagated to the parent widget.

See also
QGestureEvent::accept()
void QGestureEvent::ignore ( Qt::GestureType  gestureType)

Clears the accept flag parameter of the given gestureType, the equivalent of calling setAccepted(gesture, false).

Clearing the accept flag indicates that the event receiver does not want the gesture. Unwanted gestures may be propagated to the parent widget.

See also
QGestureEvent::accept()
bool QEvent::isAccepted ( ) const
usinginline

The accept flag of the event object

Setting the accept parameter indicates that the event receiver wants the event. Unwanted events might be propagated to the parent widget. By default, isAccepted() is set to true, but do not rely on this as subclasses may choose to clear it in their constructor.

For convenience the accept flag can also be set with accept(), and cleared with ignore().

bool QGestureEvent::isAccepted ( QGesture gesture) const

Returns true if the gesture is accepted, otherwise returns false.

bool QGestureEvent::isAccepted ( Qt::GestureType  gestureType) const

Returns true if the gesture of type gestureType is accepted, otherwise returns false.

QPointF QGestureEvent::mapToGraphicsScene ( const QPointF gesturePoint) const

Returns the scene-local coordinates if the gesturePoint is inside a graphics view.

This functiona might be useful when the gesture event is delivered to a QGraphicsObject to translate a point in screen coordinates to scene-local coordinates.

See also
QPointF::isNull()
void QEvent::setAccepted ( bool  accepted)
usinginline

The accept flag of the event object

Setting the accept parameter indicates that the event receiver wants the event. Unwanted events might be propagated to the parent widget. By default, isAccepted() is set to true, but do not rely on this as subclasses may choose to clear it in their constructor.

For convenience the accept flag can also be set with accept(), and cleared with ignore().

void QGestureEvent::setAccepted ( QGesture gesture,
bool  isAccepted 
)

If isAccepted is true then the given gesture object is marked as accepted. If it is false then the gesture is marked as ignored. Accepting an event means the receiver has processed the gesture. Ignored gestures may be propagated to the parent widget.

By default, gestures in events of type QEvent::Gesture are accepted and gestures in QEvent::GestureOverride events are ignored. For convenience, the accept flag can also be set with accept(gesture) and cleared with ignore(gesture).

void QGestureEvent::setAccepted ( Qt::GestureType  gestureType,
bool  isAccepted 
)

If isAccepted is true then the given gestureType is marked as accepted. If it is false then the gestureType is marked as ignored. Accepting an event means the receiver has processed the gesture. Ignored gestures may be propagated to the parent widget.

By default, gestures in events of type QEvent::Gesture are accepted and gestures in QEvent::GestureOverride events are ignored. For convenience, the accept flag can also be set with accept(gestureType) and cleared with ignore(gestureType).

void QGestureEvent::setWidget ( QWidget widget)

Property documentation pending.

QWidget * QGestureEvent::widget ( ) const

Returns the widget on which the event occurred.