A ConnectionHandle represents the connection of a Signal to a slot (i.e. a function that is called when the Signal is emitted). More...
|ConnectionHandle(ConnectionHandle && ) =default|
|ConnectionHandle(const ConnectionHandle & ) =default|
|template <typename... Args>
|belongsTo(const Signal< Args... > & signal) const|
|ConnectionHandle &||operator=(ConnectionHandle && ) =default|
|ConnectionHandle &||operator=(const ConnectionHandle & ) =default|
A ConnectionHandle represents the connection of a Signal to a slot (i.e. a function that is called when the Signal is emitted).
It is returned from a Signal when a connection is created and used to manage the connection by disconnecting, (un)blocking it and checking its state.
Public Functions Documentation¶
A ConnectionHandle can be default constructed. In this case the ConnectionHandle will not reference any active connection (i.e. isActive() will return false), and not belong to any Signal.
1 2 3
A ConnectionHandle can be moved.
1 2 3
A ConnectionHandle can be copied.
1 2 3 4
Return: true if this ConnectionHandle refers to a connection within the given Signal
Check whether this ConnectionHandle belongs to the given Signal.
1 2 3
- blocked The new blocked state of the connection.
- std::out_of_range Throws if the connection is not active (i.e. isActive() returns false).
Return: whether the connection was previously blocked.
Sets the block state of the connection. If a connection is blocked, emitting the Signal will no longer call this connections slot, until the connection is unblocked.
Behaves the same as calling Signal::blockConnection with this ConnectionHandle as argument.
To temporarily block a connection, consider using an instance of ConnectionBlocker, which offers a RAII-style implementation that makes sure the connection is always returned to its original state.
Disconnect the slot.
When this function is called, the function that was passed to Signal::connect to create this ConnectionHandle will no longer be called when the Signal is emitted.
If the ConnectionHandle is not active or the connection has already been disconnected, nothing happens.
After this call, the ConnectionHandle will be inactive (i.e. isActive() returns false) and will no longer belong to any Signal (i.e. belongsTo returns false).
Return: true if the ConnectionHandle refers to an active Signal and the connection was not disconnected previously, false otherwise.
Check whether the connection of this ConnectionHandle is active.
Return: whether the connection is currently blocked.
Checks whether the connection is currently blocked.
To change the blocked state of a connection, call ConnectionHandle::block.
1 2 3
1 2 3
Updated on 2023-02-28 at 00:00:24 +0000