Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Friends | List of all members
QQmlNotifierEndpoint Class Reference

#include <qqmlnotifier_p.h>

+ Inheritance diagram for QQmlNotifierEndpoint:
+ Collaboration diagram for QQmlNotifierEndpoint:

Public Types

enum  Callback {
  None = 0 , QQmlBoundSignal = 1 , QQmlJavaScriptExpressionGuard = 2 , QQmlVMEMetaObjectEndpoint = 3 ,
  QQmlPropertyGuard = 4
}
 

Public Member Functions

 QQmlNotifierEndpoint (Callback callback)
 
 ~QQmlNotifierEndpoint ()
 
bool isConnected () const
 
bool isConnected (QObject *source, int sourceSignal) const
 
bool isConnected (QQmlNotifier *) const
 
void connect (QObject *source, int sourceSignal, QQmlEngine *engine, bool doNotify=true)
 
void connect (QQmlNotifier *)
 
void disconnect ()
 
bool isNotifying () const
 Returns true if a notify is in progress.
 
void startNotifying (qintptr *originalSenderPtr)
 
void stopNotifying (qintptr *originalSenderPtr)
 
void cancelNotify ()
 Cancel any notifies that are in progress.
 
int signalIndex () const
 
qintptr sender () const
 
void setSender (qintptr sender)
 
QObject * senderAsObject () const
 
QQmlNotifier * senderAsNotifier () const
 

Friends

class QQmlData
 
class QQmlNotifier
 

Detailed Description

Definition at line 45 of file qqmlnotifier_p.h.

Member Enumeration Documentation

◆ Callback

enum QQmlNotifierEndpoint::Callback
Enumerator
None 
QQmlBoundSignal 
QQmlJavaScriptExpressionGuard 
QQmlVMEMetaObjectEndpoint 
QQmlPropertyGuard 

Definition at line 54 of file qqmlnotifier_p.h.

Constructor & Destructor Documentation

◆ QQmlNotifierEndpoint()

QQmlNotifierEndpoint::QQmlNotifierEndpoint ( Callback callback)
inline

Definition at line 127 of file qqmlnotifier_p.h.

◆ ~QQmlNotifierEndpoint()

QQmlNotifierEndpoint::~QQmlNotifierEndpoint ( )
inline

Definition at line 132 of file qqmlnotifier_p.h.

References disconnect().

+ Here is the call graph for this function:

Member Function Documentation

◆ cancelNotify()

void QQmlNotifierEndpoint::cancelNotify ( )
inline

Cancel any notifies that are in progress.

Definition at line 226 of file qqmlnotifier_p.h.

References isNotifying(), ptr(), and Q_ASSERT.

Referenced by QQmlPropertyCapture::captureProperty().

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

◆ connect() [1/2]

void QQmlNotifierEndpoint::connect ( QObject * source,
int sourceSignal,
QQmlEngine * engine,
bool doNotify = true )

sourceSignal MUST be in the signal index range (see QObjectPrivate::signalIndex()). This is different from QMetaMethod::methodIndex().

Definition at line 82 of file qqmlnotifier.cpp.

References disconnect(), doNotify(), engine, QQmlPropertyPrivate::flushSignal(), QObjectPrivate::get(), QQmlData::get(), QString::left(), priv(), Q_ASSERT, qFatal, qPrintable, setSender(), QMetaObjectPrivate::signal(), and QString::size().

Referenced by QQmlBoundSignal::QQmlBoundSignal(), QQmlVMEMetaObject::connectAlias(), and QQmlVMEMetaObjectEndpoint::tryConnect().

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

◆ connect() [2/2]

void QQmlNotifierEndpoint::connect ( QQmlNotifier * notifier)
inline

Definition at line 157 of file qqmlnotifier_p.h.

References disconnect(), notifier, and setSender().

+ Here is the call graph for this function:

◆ disconnect()

void QQmlNotifierEndpoint::disconnect ( )
inline

Definition at line 168 of file qqmlnotifier_p.h.

References QObjectPrivate::get(), mo, priv(), Q_ASSERT, senderAsObject(), setSender(), and QMetaObjectPrivate::signal().

Referenced by ~QQmlNotifierEndpoint(), connect(), connect(), and QQmlData::disconnectNotifiers().

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

◆ isConnected() [1/3]

bool QQmlNotifierEndpoint::isConnected ( ) const
inline

Definition at line 137 of file qqmlnotifier_p.h.

Referenced by QQmlData::addNotify(), and QQmlPropertyCapture::captureProperty().

+ Here is the caller graph for this function:

◆ isConnected() [2/3]

bool QQmlNotifierEndpoint::isConnected ( QObject * source,
int sourceSignal ) const
inline

sourceSignal MUST be in the signal index range (see QObjectPrivate::signalIndex()). This is different from QMetaMethod::methodIndex().

Definition at line 146 of file qqmlnotifier_p.h.

References senderAsObject().

+ Here is the call graph for this function:

◆ isConnected() [3/3]

bool QQmlNotifierEndpoint::isConnected ( QQmlNotifier * notifier) const
inline

Definition at line 152 of file qqmlnotifier_p.h.

References notifier, and senderAsNotifier().

+ Here is the call graph for this function:

◆ isNotifying()

bool QQmlNotifierEndpoint::isNotifying ( ) const
inline

Returns true if a notify is in progress.

This means that the signal or QQmlNotifier that this endpoing is connected to has been triggered, but this endpoint's callback has not yet been called.

An in progress notify can be cancelled by calling cancelNotify.

Definition at line 199 of file qqmlnotifier_p.h.

Referenced by cancelNotify(), QQmlData::destroyed(), sender(), and setSender().

+ Here is the caller graph for this function:

◆ sender()

qintptr QQmlNotifierEndpoint::sender ( ) const
inline

Definition at line 236 of file qqmlnotifier_p.h.

References isNotifying().

Referenced by senderAsNotifier(), senderAsObject(), and setSender().

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

◆ senderAsNotifier()

QQmlNotifier * QQmlNotifierEndpoint::senderAsNotifier ( ) const
inline

Definition at line 255 of file qqmlnotifier_p.h.

References sender().

Referenced by isConnected().

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

◆ senderAsObject()

QObject * QQmlNotifierEndpoint::senderAsObject ( ) const
inline

Definition at line 250 of file qqmlnotifier_p.h.

References sender().

Referenced by disconnect(), and isConnected().

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

◆ setSender()

void QQmlNotifierEndpoint::setSender ( qintptr sender)
inline

Definition at line 241 of file qqmlnotifier_p.h.

References isNotifying(), and sender().

Referenced by QQmlNotifier::~QQmlNotifier(), connect(), connect(), and disconnect().

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

◆ signalIndex()

int QQmlNotifierEndpoint::signalIndex ( ) const
inline

Definition at line 79 of file qqmlnotifier_p.h.

Referenced by QQmlPropertyPrivate::signalExpression(), and QQmlPropertyPrivate::takeSignalExpression().

+ Here is the caller graph for this function:

◆ startNotifying()

void QQmlNotifierEndpoint::startNotifying ( qintptr * originalSenderPtr)
inline

Definition at line 204 of file qqmlnotifier_p.h.

References Q_ASSERT.

◆ stopNotifying()

void QQmlNotifierEndpoint::stopNotifying ( qintptr * originalSenderPtr)
inline

Definition at line 215 of file qqmlnotifier_p.h.

References Q_ASSERT.

Friends And Related Symbol Documentation

◆ QQmlData

friend class QQmlData
friend

Definition at line 88 of file qqmlnotifier_p.h.

◆ QQmlNotifier

friend class QQmlNotifier
friend

Definition at line 89 of file qqmlnotifier_p.h.

The documentation for this class was generated from the following files: