Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QQmlNotifierEndpoint Class Reference

#include <qqmlnotifierendpoint_p.h>

Inheritance diagram for QQmlNotifierEndpoint:
Collaboration diagram for QQmlNotifierEndpoint:

Public Types

enum  Callback {
  None = 0 , QQmlBoundSignal = 1 , QQmlJavaScriptExpressionGuard = 2 , QQmlVMEMetaObjectEndpoint = 3 ,
  QQmlUnbindableToUnbindableGuard = 4 , QQmlUnbindableToBindableGuard = 5 , QQmlDirtyReferenceObject = 6
}

Public Member Functions

 QQmlNotifierEndpoint (Callback callback)
 ~QQmlNotifierEndpoint ()
bool isConnected () const
bool isConnected (QObject *source, int sourceSignal) const
bool isConnected (QQmlNotifier *) const
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
Callback callbackType () const
QQmlNotifierEndpoint * nextEndpoint () const
qintptr sender () const
void setSender (qintptr sender)
QObject * senderAsObject () const
QQmlNotifier * senderAsNotifier () const

Friends

class QQmlData
class QQmlNotifier
class QQmlNotifyList

Detailed Description

Definition at line 33 of file qqmlnotifierendpoint_p.h.

Member Enumeration Documentation

◆ Callback

enum QQmlNotifierEndpoint::Callback
Enumerator
None 
QQmlBoundSignal 
QQmlJavaScriptExpressionGuard 
QQmlVMEMetaObjectEndpoint 
QQmlUnbindableToUnbindableGuard 
QQmlUnbindableToBindableGuard 
QQmlDirtyReferenceObject 

Definition at line 43 of file qqmlnotifierendpoint_p.h.

Constructor & Destructor Documentation

◆ QQmlNotifierEndpoint()

QQmlNotifierEndpoint::QQmlNotifierEndpoint ( Callback callback)
inline

Definition at line 96 of file qqmlnotifierendpoint_p.h.

References QQmlNotifierEndpoint().

Referenced by QQmlNotifierEndpoint().

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

◆ ~QQmlNotifierEndpoint()

QQmlNotifierEndpoint::~QQmlNotifierEndpoint ( )
inline

Definition at line 106 of file qqmlnotifierendpoint_p.h.

References disconnect().

Here is the call graph for this function:

Member Function Documentation

◆ callbackType()

Callback QQmlNotifierEndpoint::callbackType ( ) const
inline

Definition at line 70 of file qqmlnotifierendpoint_p.h.

◆ cancelNotify()

void QQmlNotifierEndpoint::cancelNotify ( )
inline

Cancel any notifies that are in progress.

Definition at line 191 of file qqmlnotifierendpoint_p.h.

References isNotifying().

Here is the call graph for this function:

◆ disconnect()

void QQmlNotifierEndpoint::disconnect ( )
inline

Definition at line 131 of file qqmlnotifierendpoint_p.h.

Referenced by ~QQmlNotifierEndpoint().

Here is the caller graph for this function:

◆ isConnected() [1/3]

bool QQmlNotifierEndpoint::isConnected ( ) const
inline

Definition at line 111 of file qqmlnotifierendpoint_p.h.

◆ 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 120 of file qqmlnotifierendpoint_p.h.

◆ isConnected() [3/3]

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

Definition at line 126 of file qqmlnotifierendpoint_p.h.

References 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 endpoint 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 164 of file qqmlnotifierendpoint_p.h.

Referenced by cancelNotify().

Here is the caller graph for this function:

◆ nextEndpoint()

QQmlNotifierEndpoint * QQmlNotifierEndpoint::nextEndpoint ( ) const
inline

Definition at line 71 of file qqmlnotifierendpoint_p.h.

◆ sender()

qintptr QQmlNotifierEndpoint::sender ( ) const
inline

Definition at line 201 of file qqmlnotifierendpoint_p.h.

◆ senderAsNotifier()

QQmlNotifier * QQmlNotifierEndpoint::senderAsNotifier ( ) const
inline

Definition at line 220 of file qqmlnotifierendpoint_p.h.

Referenced by isConnected().

Here is the caller graph for this function:

◆ senderAsObject()

QObject * QQmlNotifierEndpoint::senderAsObject ( ) const
inline

Definition at line 215 of file qqmlnotifierendpoint_p.h.

◆ setSender()

void QQmlNotifierEndpoint::setSender ( qintptr sender)
inline

Definition at line 206 of file qqmlnotifierendpoint_p.h.

◆ signalIndex()

int QQmlNotifierEndpoint::signalIndex ( ) const
inline

Definition at line 68 of file qqmlnotifierendpoint_p.h.

◆ startNotifying()

void QQmlNotifierEndpoint::startNotifying ( qintptr * originalSenderPtr)
inline

Definition at line 169 of file qqmlnotifierendpoint_p.h.

◆ stopNotifying()

void QQmlNotifierEndpoint::stopNotifying ( qintptr * originalSenderPtr)
inline

Definition at line 180 of file qqmlnotifierendpoint_p.h.

◆ QQmlData

friend class QQmlData
friend

Definition at line 80 of file qqmlnotifierendpoint_p.h.

◆ QQmlNotifier

friend class QQmlNotifier
friend

Definition at line 81 of file qqmlnotifierendpoint_p.h.

◆ QQmlNotifyList

friend class QQmlNotifyList
friend

Definition at line 82 of file qqmlnotifierendpoint_p.h.

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