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
QQmlBoundSignal Class Reference

#include <qqmlboundsignal_p.h>

+ Inheritance diagram for QQmlBoundSignal:
+ Collaboration diagram for QQmlBoundSignal:

Public Member Functions

 QQmlBoundSignal (QObject *target, int signal, QObject *owner, QQmlEngine *engine)
 
 ~QQmlBoundSignal ()
 
void removeFromObject ()
 
QQmlBoundSignalExpressionexpression () const
 Returns the signal expression.
 
void takeExpression (QQmlBoundSignalExpression *)
 Sets the signal expression to e.
 
void setEnabled (bool enabled)
 This property holds whether the item will emit signals.
 
- Public Member Functions inherited from QQmlNotifierEndpoint
 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 QQmlPropertyPrivate
 
class QQmlData
 
class QQmlEngineDebugService
 
void QQmlBoundSignal_callback (QQmlNotifierEndpoint *, void **)
 

Additional Inherited Members

- Public Types inherited from QQmlNotifierEndpoint
enum  Callback {
  None = 0 , QQmlBoundSignal = 1 , QQmlJavaScriptExpressionGuard = 2 , QQmlVMEMetaObjectEndpoint = 3 ,
  QQmlPropertyGuard = 4
}
 

Detailed Description

Definition at line 65 of file qqmlboundsignal_p.h.

Constructor & Destructor Documentation

◆ QQmlBoundSignal()

QQmlBoundSignal::QQmlBoundSignal ( QObject * target,
int signal,
QObject * owner,
QQmlEngine * engine )

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

Definition at line 212 of file qqmlboundsignal.cpp.

References QQmlNotifierEndpoint::connect(), engine, QQmlPropertyCache::originalClone(), and signal.

+ Here is the call graph for this function:

◆ ~QQmlBoundSignal()

QQmlBoundSignal::~QQmlBoundSignal ( )

Definition at line 230 of file qqmlboundsignal.cpp.

References removeFromObject().

+ Here is the call graph for this function:

Member Function Documentation

◆ expression()

QQmlBoundSignalExpression * QQmlBoundSignal::expression ( ) const

Returns the signal expression.

Definition at line 261 of file qqmlboundsignal.cpp.

References QQmlRefPointer< T >::data().

Referenced by QQmlData::destroyed(), and QQmlPropertyPrivate::signalExpression().

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

◆ removeFromObject()

void QQmlBoundSignal::removeFromObject ( )

Definition at line 248 of file qqmlboundsignal.cpp.

Referenced by QQmlBoundSignalDeleter::QQmlBoundSignalDeleter(), and ~QQmlBoundSignal().

+ Here is the caller graph for this function:

◆ setEnabled()

void QQmlBoundSignal::setEnabled ( bool enabled)

This property holds whether the item will emit signals.

The QQmlBoundSignal callback will only emit a signal if this property is set to true.

By default, this property is true.

Definition at line 285 of file qqmlboundsignal.cpp.

References enabled.

◆ takeExpression()

void QQmlBoundSignal::takeExpression ( QQmlBoundSignalExpression * e)

Sets the signal expression to e.

The QQmlBoundSignal instance takes ownership of e (and does not add a reference).

Definition at line 271 of file qqmlboundsignal.cpp.

References QQmlRefPointer< T >::adopt(), and QQmlJavaScriptExpression::setNotifyOnValueChanged().

Referenced by QQmlPropertyPrivate::takeSignalExpression().

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

Friends And Related Symbol Documentation

◆ QQmlBoundSignal_callback

void QQmlBoundSignal_callback ( QQmlNotifierEndpoint * ,
void **  )
friend

Definition at line 293 of file qqmlboundsignal.cpp.

◆ QQmlData

friend class QQmlData
friend

Definition at line 81 of file qqmlboundsignal_p.h.

◆ QQmlEngineDebugService

friend class QQmlEngineDebugService
friend

Definition at line 82 of file qqmlboundsignal_p.h.

◆ QQmlPropertyPrivate

friend class QQmlPropertyPrivate
friend

Definition at line 80 of file qqmlboundsignal_p.h.


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