Home · All Classes · Modules

QEvent Class Reference
^{[QtCore module]}

The QEvent class is the base class of all event classes. Event objects contain event parameters. More...

Inherited by QActionEvent, QChildEvent, QCloseEvent, QDragLeaveEvent, QDropEvent, QDynamicPropertyChangeEvent, QFileOpenEvent, QFocusEvent, QGestureEvent, QGraphicsSceneEvent, QHelpEvent, QHideEvent, QHoverEvent, QIconDragEvent, QInputEvent, QInputMethodEvent, QMoveEvent, QPaintEvent, QResizeEvent, QShortcutEvent, QShowEvent, SignalEvent, WrappedEvent, QStatusTipEvent, QTimerEvent, QWhatsThisClickedEvent and QWindowStateChangeEvent.

Types

• enum Type { None_, Timer, MouseButtonPress, MouseButtonRelease, ..., MaxUser }

Methods

• __init__ (self, Type type)
• __init__ (self, QEvent)
• accept (self)
• ignore (self)
• bool isAccepted (self)
• setAccepted (self, bool accepted)
• bool spontaneous (self)
• Type type (self)

Static Methods

• int registerEventType (int hint = -1)

Qt's main event loop (QCoreApplication.exec()) fetches native window system events from the event queue, translates them into QEvents, and sends the translated events to QObjects.

In general, events come from the underlying window system (spontaneous() returns true), but it is also possible to manually send events using QCoreApplication.sendEvent() and QCoreApplication.postEvent() (spontaneous() returns false).

QObjects receive events by having their QObject.event() function called. The function can be reimplemented in subclasses to customize event handling and add additional event types; QWidget.event() is a notable example. By default, events are dispatched to event handlers like QObject.timerEvent() and QWidget.mouseMoveEvent(). QObject.installEventFilter() allows an object to intercept events destined for another object.

The basic QEvent contains only an event type parameter and an "accept" flag. The accept flag set with accept(), and cleared with ignore(). It is set by default, but don't rely on this as subclasses may choose to clear it in their constructor.

Subclasses of QEvent contain additional parameters that describe the particular event.

Type Documentation

QEvent.Type

This enum type defines the valid event types in Qt. The event types and the specialized classes for each type are as follows:

For convenience, you can use the registerEventType() function to register and reserve a custom event type for your application. Doing so will allow you to avoid accidentally re-using a custom event type already in use elsewhere in your application.

Method Documentation

QEvent.__init__ (self, Type type)

Contructs an event object of type type.

QEvent.__init__ (self, QEvent)

QEvent.accept (self)

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

See also ignore().

QEvent.ignore (self)

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

See also accept().

bool QEvent.isAccepted (self)

int QEvent.registerEventType (int hint = -1)

Registers and returns a custom event type. The hint provided will be used if it is available, otherwise it will return a value between QEvent.User and QEvent.MaxUser that has not yet been registered. The hint is ignored if its value is not between QEvent.User and QEvent.MaxUser.

Note: This function is thread-safe.

This function was introduced in Qt 4.4.

QEvent.setAccepted (self, bool accepted)

bool QEvent.spontaneous (self)

Returns true if the event originated outside the application (a system event); otherwise returns false.

Type QEvent.type (self)

Returns the event type.