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 <qqmlnotifier_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 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)
 
QObjectsenderAsObject () const
 
QQmlNotifiersenderAsNotifier () const
 

Friends

class QQmlData
 
class QQmlNotifier
 

Detailed Description

Definition at line 45 of file qqmlnotifier_p.h.

Member Enumeration Documentation

◆ Callback

Enumerator
None 
QQmlBoundSignal 
QQmlJavaScriptExpressionGuard 
QQmlVMEMetaObjectEndpoint 
QQmlUnbindableToUnbindableGuard 
QQmlUnbindableToBindableGuard 
QQmlDirtyReferenceObject 

Definition at line 54 of file qqmlnotifier_p.h.

Constructor & Destructor Documentation

◆ QQmlNotifierEndpoint()

QQmlNotifierEndpoint::QQmlNotifierEndpoint ( Callback callback)
inline

Definition at line 129 of file qqmlnotifier_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 134 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 228 of file qqmlnotifier_p.h.

References isNotifying().

+ Here is the call 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 86 of file qqmlnotifier.cpp.

References disconnect().

+ Here is the call graph for this function:

◆ connect() [2/2]

void QQmlNotifierEndpoint::connect ( QQmlNotifier * notifier)
inline

Definition at line 159 of file qqmlnotifier_p.h.

◆ disconnect()

void QQmlNotifierEndpoint::disconnect ( )
inline

Definition at line 170 of file qqmlnotifier_p.h.

Referenced by ~QQmlNotifierEndpoint(), and connect().

+ Here is the caller graph for this function:

◆ isConnected() [1/3]

bool QQmlNotifierEndpoint::isConnected ( ) const
inline

Definition at line 139 of file qqmlnotifier_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 148 of file qqmlnotifier_p.h.

◆ isConnected() [3/3]

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

Definition at line 154 of file qqmlnotifier_p.h.

◆ 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 201 of file qqmlnotifier_p.h.

Referenced by cancelNotify().

+ Here is the caller graph for this function:

◆ sender()

qintptr QQmlNotifierEndpoint::sender ( ) const
inline

Definition at line 238 of file qqmlnotifier_p.h.

◆ senderAsNotifier()

QQmlNotifier * QQmlNotifierEndpoint::senderAsNotifier ( ) const
inline

Definition at line 257 of file qqmlnotifier_p.h.

◆ senderAsObject()

QObject * QQmlNotifierEndpoint::senderAsObject ( ) const
inline

Definition at line 252 of file qqmlnotifier_p.h.

◆ setSender()

void QQmlNotifierEndpoint::setSender ( qintptr sender)
inline

Definition at line 243 of file qqmlnotifier_p.h.

◆ signalIndex()

int QQmlNotifierEndpoint::signalIndex ( ) const
inline

Definition at line 81 of file qqmlnotifier_p.h.

◆ startNotifying()

void QQmlNotifierEndpoint::startNotifying ( qintptr * originalSenderPtr)
inline

Definition at line 206 of file qqmlnotifier_p.h.

◆ stopNotifying()

void QQmlNotifierEndpoint::stopNotifying ( qintptr * originalSenderPtr)
inline

Definition at line 217 of file qqmlnotifier_p.h.

Friends And Related Symbol Documentation

◆ QQmlData

friend class QQmlData
friend

Definition at line 90 of file qqmlnotifier_p.h.

◆ QQmlNotifier

friend class QQmlNotifier
friend

Definition at line 91 of file qqmlnotifier_p.h.


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