Dali 3D User Interface Engine
List of all members | Public Member Functions | Private Member Functions | Private Attributes
Dali::Signal< void() > Class Template Reference

A template for Signals with no parameters or return value. More...

#include <dali-signal.h>

Collaboration diagram for Dali::Signal< void() >:
Collaboration graph
[legend]

Public Member Functions

 Signal ()
 Default constructor. More...
 
 ~Signal ()
 Non-virtual destructor. More...
 
bool Empty () const
 Query whether there are any connected slots. More...
 
std::size_t GetConnectionCount () const
 Query the number of slots. More...
 
void Connect (void(*func)())
 Connect a function. More...
 
void Disconnect (void(*func)())
 Disconnect a function. More...
 
template<class X >
void Connect (X *obj, void(X::*func)())
 Connect a member function. More...
 
template<class X >
void Disconnect (X *obj, void(X::*func)())
 Disconnect a member function. More...
 
template<class X >
void Connect (SlotDelegate< X > &delegate, void(X::*func)())
 Connect a member function. More...
 
template<class X >
void Disconnect (SlotDelegate< X > &delegate, void(X::*func)())
 Disconnect a member function. More...
 
template<class X >
void Connect (ConnectionTrackerInterface *connectionTracker, const X &func)
 Connect a function object. More...
 
void Connect (ConnectionTrackerInterface *connectionTracker, FunctorDelegate *delegate)
 Connect a function object using FunctorDelegate. More...
 
void Emit ()
 Emit the signal. More...
 

Private Member Functions

 Signal (const Signal &)
 undefined copy constructor, signals don't support copying. .0 More...
 
Signaloperator= (const Signal &)
 undefined assignment operator .0 More...
 

Private Attributes

BaseSignal mImpl
 The base signal implementation. More...
 

Detailed Description

template<>
class Dali::Signal< void() >

A template for Signals with no parameters or return value.

.0

Definition at line 144 of file dali-signal.h.

Constructor & Destructor Documentation

Dali::Signal< void() >::Signal ( )
inline

Default constructor.

.0

Definition at line 152 of file dali-signal.h.

Dali::Signal< void() >::~Signal ( )
inline

Non-virtual destructor.

.0

Definition at line 160 of file dali-signal.h.

Dali::Signal< void() >::Signal ( const Signal< void() > &  )
private

undefined copy constructor, signals don't support copying. .0

Member Function Documentation

void Dali::Signal< void() >::Connect ( void(*)()  func)
inline
template<class X >
void Dali::Signal< void() >::Connect ( X *  obj,
void(X::*)()  func 
)
inline

Connect a member function.

.0

Parameters
[in]objAn object which must implement the ConnectionTrackerInterface.
[in]funcThe member function to connect.

Definition at line 216 of file dali-signal.h.

References Dali::MakeCallback().

Here is the call graph for this function:

template<class X >
void Dali::Signal< void() >::Connect ( SlotDelegate< X > &  delegate,
void(X::*)()  func 
)
inline

Connect a member function.

.0

Parameters
[in]delegateA slot delegate.
[in]funcThe member function to connect.

Definition at line 242 of file dali-signal.h.

References Dali::SlotDelegate< Slot >::GetConnectionTracker(), Dali::SlotDelegate< Slot >::GetSlot(), and Dali::MakeCallback().

Here is the call graph for this function:

template<class X >
void Dali::Signal< void() >::Connect ( ConnectionTrackerInterface connectionTracker,
const X &  func 
)
inline

Connect a function object.

.0

Parameters
[in]connectionTrackerA connection tracker which can be used to disconnect.
[in]funcThe function object to copy.

Definition at line 268 of file dali-signal.h.

void Dali::Signal< void() >::Connect ( ConnectionTrackerInterface connectionTracker,
FunctorDelegate delegate 
)
inline

Connect a function object using FunctorDelegate.

.0

Parameters
[in]connectionTrackerA connection tracker which can be used to disconnect.
[in]delegateA newly allocated FunctorDelegate (ownership is taken).

Definition at line 280 of file dali-signal.h.

void Dali::Signal< void() >::Disconnect ( void(*)()  func)
inline

Disconnect a function.

.0

Parameters
[in]funcThe function to disconnect.

Definition at line 203 of file dali-signal.h.

References Dali::MakeCallback().

Here is the call graph for this function:

template<class X >
void Dali::Signal< void() >::Disconnect ( X *  obj,
void(X::*)()  func 
)
inline

Disconnect a member function.

.0

Parameters
[in]objAn object which must implement the ConnectionTrackerInterface.
[in]funcThe member function to disconnect.

Definition at line 229 of file dali-signal.h.

References Dali::MakeCallback().

Here is the call graph for this function:

template<class X >
void Dali::Signal< void() >::Disconnect ( SlotDelegate< X > &  delegate,
void(X::*)()  func 
)
inline

Disconnect a member function.

.0

Parameters
[in]delegateA slot delegate.
[in]funcThe member function to disconnect.

Definition at line 255 of file dali-signal.h.

References Dali::SlotDelegate< Slot >::GetConnectionTracker(), Dali::SlotDelegate< Slot >::GetSlot(), and Dali::MakeCallback().

Here is the call graph for this function:

void Dali::Signal< void() >::Emit ( )
inline
bool Dali::Signal< void() >::Empty ( ) const
inline

Query whether there are any connected slots.

.0

Returns
True if there are any slots connected to the signal.

Definition at line 170 of file dali-signal.h.

std::size_t Dali::Signal< void() >::GetConnectionCount ( ) const
inline

Query the number of slots.

.0

Returns
The number of slots connected to this signal.

Definition at line 181 of file dali-signal.h.

Signal& Dali::Signal< void() >::operator= ( const Signal< void() > &  )
private

undefined assignment operator .0

Member Data Documentation

BaseSignal Dali::Signal< void() >::mImpl
private

The base signal implementation.

Definition at line 302 of file dali-signal.h.


The documentation for this class was generated from the following file:
Dali Docs Home
Read more about Dali