Qt 6.x
The Qt SDK
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
QEventDispatcherUNIX Class Reference

#include <qeventdispatcher_unix_p.h>

+ Inheritance diagram for QEventDispatcherUNIX:
+ Collaboration diagram for QEventDispatcherUNIX:

Public Member Functions

 QEventDispatcherUNIX (QObject *parent=nullptr)
 
 ~QEventDispatcherUNIX ()
 
bool processEvents (QEventLoop::ProcessEventsFlags flags) override
 Processes pending events that match flags until there are no more events to process.
 
void registerSocketNotifier (QSocketNotifier *notifier) final
 Registers notifier with the event loop.
 
void unregisterSocketNotifier (QSocketNotifier *notifier) final
 Unregisters notifier from the event dispatcher.
 
void registerTimer (int timerId, qint64 interval, Qt::TimerType timerType, QObject *object) final
 
bool unregisterTimer (int timerId) final
 
bool unregisterTimers (QObject *object) final
 
QList< TimerInfo > registeredTimers (QObject *object) const final
 Returns a list of registered timers for object.
 
int remainingTime (int timerId) final
 Returns the remaining time in milliseconds with the given timerId.
 
void wakeUp () override
 \threadsafe
 
void interrupt () final
 Interrupts event dispatching.
 
- Public Member Functions inherited from QAbstractEventDispatcher
 QAbstractEventDispatcher (QObject *parent=nullptr)
 Constructs a new event dispatcher with the given parent.
 
 ~QAbstractEventDispatcher ()
 Destroys the event dispatcher.
 
virtual bool processEvents (QEventLoop::ProcessEventsFlags flags)=0
 Processes pending events that match flags until there are no more events to process.
 
virtual void registerSocketNotifier (QSocketNotifier *notifier)=0
 Registers notifier with the event loop.
 
virtual void unregisterSocketNotifier (QSocketNotifier *notifier)=0
 Unregisters notifier from the event dispatcher.
 
int registerTimer (qint64 interval, Qt::TimerType timerType, QObject *object)
 Registers a timer with the specified interval and timerType for the given object and returns the timer id.
 
virtual void registerTimer (int timerId, qint64 interval, Qt::TimerType timerType, QObject *object)=0
 Register a timer with the specified timerId, interval, and timerType for the given object.
 
virtual bool unregisterTimer (int timerId)=0
 Unregisters the timer with the given timerId.
 
virtual bool unregisterTimers (QObject *object)=0
 Unregisters all the timers associated with the given object.
 
virtual QList< TimerInfo > registeredTimers (QObject *object) const =0
 Returns a list of registered timers for object.
 
virtual int remainingTime (int timerId)=0
 Returns the remaining time in milliseconds with the given timerId.
 
virtual void wakeUp ()=0
 \threadsafe
 
virtual void interrupt ()=0
 Interrupts event dispatching.
 
virtual void startingUp ()
 
virtual void closingDown ()
 
void installNativeEventFilter (QAbstractNativeEventFilter *filterObj)
 \variable QAbstractEventDispatcher::TimerInfo::timerId
 
void removeNativeEventFilter (QAbstractNativeEventFilter *filterObj)
 Removes the event filter filter from this object.
 
bool filterNativeEvent (const QByteArray &eventType, void *message, qintptr *result)
 Sends message through the event filters that were set by installNativeEventFilter().
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QString > bindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThread * thread () const
 Returns the thread in which the object lives.
 
void moveToThread (QThread *thread)
 Changes the thread affinity for this object and its children.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
template<typename T >
T findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectList & children () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArray > dynamicPropertyNames () const
 
QBindingStorage * bindingStorage ()
 
const QBindingStorage * bindingStorage () const
 
QObject * parent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 

Protected Member Functions

 QEventDispatcherUNIX (QEventDispatcherUNIXPrivate &dd, QObject *parent=nullptr)
 
- Protected Member Functions inherited from QAbstractEventDispatcher
 QAbstractEventDispatcher (QAbstractEventDispatcherPrivate &, QObject *parent)
 
- Protected Member Functions inherited from QObject
QObject * sender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Signals inherited from QAbstractEventDispatcher
void aboutToBlock ()
 This signal is emitted before the event loop calls a function that could block.
 
void awake ()
 This signal is emitted after the event loop returns from a function that could block.
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 
- Static Public Member Functions inherited from QAbstractEventDispatcher
static QAbstractEventDispatcher * instance (QThread *thread=nullptr)
 Returns a pointer to the event dispatcher object for the specified thread.
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 
- Related Symbols inherited from QObject
template< class T > T qobject_cast (const QObject *object)
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
template< typename T > T qFindChildqFindChildren (const QObject *obj, const QString &name)()
 
template< typename T > QList< T > qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
 
 QObjectList
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

Definition at line 64 of file qeventdispatcher_unix_p.h.

Constructor & Destructor Documentation

◆ QEventDispatcherUNIX() [1/2]

QEventDispatcherUNIX::QEventDispatcherUNIX ( QObject *  parent = nullptr)
explicit

Definition at line 275 of file qeventdispatcher_unix.cpp.

◆ ~QEventDispatcherUNIX()

QEventDispatcherUNIX::~QEventDispatcherUNIX ( )

Definition at line 283 of file qeventdispatcher_unix.cpp.

◆ QEventDispatcherUNIX() [2/2]

QEventDispatcherUNIX::QEventDispatcherUNIX ( QEventDispatcherUNIXPrivate &  dd,
QObject *  parent = nullptr 
)
protected

Definition at line 279 of file qeventdispatcher_unix.cpp.

Member Function Documentation

◆ interrupt()

void QEventDispatcherUNIX::interrupt ( )
finalvirtual

Interrupts event dispatching.

The event dispatcher will return from processEvents() as soon as possible.

Implements QAbstractEventDispatcher.

Definition at line 507 of file qeventdispatcher_unix.cpp.

References d, and wakeUp().

+ Here is the call graph for this function:

◆ processEvents()

bool QEventDispatcherUNIX::processEvents ( QEventLoop::ProcessEventsFlags  flags)
overridevirtual

Processes pending events that match flags until there are no more events to process.

Returns true if an event was processed; otherwise returns false.

This function is especially useful if you have a long running operation, and want to show its progress without allowing user input by using the QEventLoop::ExcludeUserInputEvents flag.

If the QEventLoop::WaitForMoreEvents flag is set in flags, the behavior of this function is as follows:

\list

  • If events are available, this function returns after processing them.
  • If no events are available, this function will wait until more are available and return after processing newly available events.

\endlist

If the QEventLoop::WaitForMoreEvents flag is not set in flags, and no events are available, this function will return immediately.

{Note:} This function does not process events continuously; it returns after all available events are processed.

Implements QAbstractEventDispatcher.

Reimplemented in QUnixEventDispatcherQPA, and QXcbUnixEventDispatcher.

Definition at line 423 of file qeventdispatcher_unix.cpp.

References QAbstractEventDispatcher::aboutToBlock(), QAbstractEventDispatcher::awake(), d, emit, QEventLoop::ExcludeSocketNotifiers, it, qErrnoWarning(), QT_CONFIG, qt_make_pollfd(), qt_safe_poll(), QCoreApplicationPrivate::sendPostedEvents(), QEventLoop::WaitForMoreEvents, and QEventLoop::X11ExcludeTimers.

Referenced by QUnixEventDispatcherQPA::processEvents(), and QXcbUnixEventDispatcher::processEvents().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ registeredTimers()

QList< QEventDispatcherUNIX::TimerInfo > QEventDispatcherUNIX::registeredTimers ( QObject *  object) const
finalvirtual

Returns a list of registered timers for object.

The TimerInfo struct has timerId, interval, and timerType members.

See also
Qt::TimerType

Implements QAbstractEventDispatcher.

Definition at line 344 of file qeventdispatcher_unix.cpp.

References d, and qWarning.

◆ registerSocketNotifier()

void QEventDispatcherUNIX::registerSocketNotifier ( QSocketNotifier *  notifier)
finalvirtual

Registers notifier with the event loop.

Note
processEvents() only processes events queued before the function is called. Events that are posted while the function runs will be queued until a later round of event processing. This only applies to posted Qt events. For timers and system level events, the situation is unknown.

Subclasses must implement this method to tie a socket notifier into another event loop.

Implements QAbstractEventDispatcher.

Definition at line 359 of file qeventdispatcher_unix.cpp.

References QThread::currentThread(), d, notifier, QSocketNotifierSetUNIX::notifiers, Q_ASSERT, Q_FUNC_INFO, qWarning, socketType(), and QObject::thread().

+ Here is the call graph for this function:

◆ registerTimer()

void QEventDispatcherUNIX::registerTimer ( int  timerId,
qint64  interval,
Qt::TimerType  timerType,
QObject *  obj 
)
finalvirtual

Implements QAbstractEventDispatcher.

Definition at line 289 of file qeventdispatcher_unix.cpp.

References QThread::currentThread(), d, qWarning, and QObject::thread().

+ Here is the call graph for this function:

◆ remainingTime()

int QEventDispatcherUNIX::remainingTime ( int  timerId)
finalvirtual

Returns the remaining time in milliseconds with the given timerId.

If the timer is inactive, the returned value will be -1. If the timer is overdue, the returned value will be 0.

See also
Qt::TimerType

Implements QAbstractEventDispatcher.

Definition at line 488 of file qeventdispatcher_unix.cpp.

References d, and qWarning.

◆ unregisterSocketNotifier()

void QEventDispatcherUNIX::unregisterSocketNotifier ( QSocketNotifier *  notifier)
finalvirtual

Unregisters notifier from the event dispatcher.

Subclasses must reimplement this method to tie a socket notifier into another event loop. Reimplementations must call the base implementation.

Implements QAbstractEventDispatcher.

Definition at line 381 of file qeventdispatcher_unix.cpp.

References QThread::currentThread(), d, i, QSocketNotifierSetUNIX::isEmpty(), notifier, QSocketNotifierSetUNIX::notifiers, Q_ASSERT, Q_FUNC_INFO, qWarning, socketType(), and QObject::thread().

+ Here is the call graph for this function:

◆ unregisterTimer()

bool QEventDispatcherUNIX::unregisterTimer ( int  timerId)
finalvirtual

Implements QAbstractEventDispatcher.

Definition at line 308 of file qeventdispatcher_unix.cpp.

References QThread::currentThread(), d, qWarning, and QObject::thread().

+ Here is the call graph for this function:

◆ unregisterTimers()

bool QEventDispatcherUNIX::unregisterTimers ( QObject *  object)
finalvirtual

Implements QAbstractEventDispatcher.

Definition at line 327 of file qeventdispatcher_unix.cpp.

References QThread::currentThread(), d, qWarning, and QObject::thread().

+ Here is the call graph for this function:

◆ wakeUp()

void QEventDispatcherUNIX::wakeUp ( )
overridevirtual

\threadsafe

Wakes up the event loop.

\omit

FIXME - QTBUG-70229

On Unix and Glib event dispatchers, if the dispatcher is already awake when this function is called, it is ensured that the current iteration won't block waiting for more events, but will instead do another event loop iteration.

TODO - does other event dispatchers behave the same?

\endomit

See also
awake()

Implements QAbstractEventDispatcher.

Definition at line 501 of file qeventdispatcher_unix.cpp.

References d.

Referenced by QAndroidEventDispatcher::goingToStop(), interrupt(), QAndroidEventDispatcher::processEvents(), QAndroidEventDispatcher::start(), and QAndroidEventDispatcher::stop().

+ Here is the caller graph for this function:
The documentation for this class was generated from the following files: