dbus-cxx logo

DBus::signal< T_return, T_arg1, T_arg2, T_arg3, nil, nil, nil, nil > Class Template Reference
[SignalsLocal Objects]

Subclass of the numbered sigc::signal templates. More...

#include <dbus_signal.h>

Inheritance diagram for DBus::signal< T_return, T_arg1, T_arg2, T_arg3, nil, nil, nil, nil >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef DBusCxxPointer< signalpointer

Public Member Functions

 signal (const std::string &interface, const std::string &name)
 signal (const std::string &path, const std::string &interface, const std::string &name)
 signal (const std::string &interface, const std::string &name, const signal &src)
 signal (const std::string &path, const std::string &interface, const std::string &name, const signal &src)
virtual signal_base::pointer clone ()
virtual std::string introspect (int space_depth=0) const
 Returns a DBus XML description of this interface.
virtual std::string arg_name (size_t i)
virtual void set_arg_name (size_t i, const std::string &name)

Static Public Member Functions

static pointer create (const std::string &interface, const std::string &name)
static pointer create (const std::string &path, const std::string &interface, const std::string &name)
static pointer create (const std::string &interface, const std::string &name, const signal &src)
static pointer create (const std::string &path, const std::string &interface, const std::string &name, const signal &src)

Protected Member Functions

T_return internal_callback (T_arg1 arg1, T_arg2 arg2, T_arg3 arg3)

Protected Attributes

std::string m_arg_names [3]
sigc::connection m_internal_callback_connection

Friends

class Interface

Detailed Description

template<class T_return, class T_arg1, class T_arg2, class T_arg3>
class DBus::signal< T_return, T_arg1, T_arg2, T_arg3, nil, nil, nil, nil >

Subclass of the numbered sigc::signal templates.

This class defines a subclass of the sigc::signal types and can be used as its parent. The key difference is that when the signal is emitted a DBus signal message is created using the parameters of the signal emission and transmitted via the dbus in addition to any local signal propagation that may take place.

Author:
Rick L Vinyard Jr <rvinyard@cs.nmsu.edu>

Member Typedef Documentation

template<class T_return , class T_arg1 , class T_arg2 , class T_arg3 >
typedef DBusCxxPointer<signal> DBus::signal< T_return, T_arg1, T_arg2, T_arg3, nil, nil, nil, nil >::pointer

Reimplemented from DBus::signal_base.


Constructor & Destructor Documentation

template<class T_return , class T_arg1 , class T_arg2 , class T_arg3 >
DBus::signal< T_return, T_arg1, T_arg2, T_arg3, nil, nil, nil, nil >::signal ( const std::string &  interface,
const std::string &  name 
) [inline]
template<class T_return , class T_arg1 , class T_arg2 , class T_arg3 >
DBus::signal< T_return, T_arg1, T_arg2, T_arg3, nil, nil, nil, nil >::signal ( const std::string &  path,
const std::string &  interface,
const std::string &  name 
) [inline]
template<class T_return , class T_arg1 , class T_arg2 , class T_arg3 >
DBus::signal< T_return, T_arg1, T_arg2, T_arg3, nil, nil, nil, nil >::signal ( const std::string &  interface,
const std::string &  name,
const signal< T_return, T_arg1, T_arg2, T_arg3, nil, nil, nil, nil > &  src 
) [inline]
template<class T_return , class T_arg1 , class T_arg2 , class T_arg3 >
DBus::signal< T_return, T_arg1, T_arg2, T_arg3, nil, nil, nil, nil >::signal ( const std::string &  path,
const std::string &  interface,
const std::string &  name,
const signal< T_return, T_arg1, T_arg2, T_arg3, nil, nil, nil, nil > &  src 
) [inline]

Member Function Documentation

template<class T_return , class T_arg1 , class T_arg2 , class T_arg3 >
virtual std::string DBus::signal< T_return, T_arg1, T_arg2, T_arg3, nil, nil, nil, nil >::arg_name ( size_t  i  )  [inline, virtual]
template<class T_return , class T_arg1 , class T_arg2 , class T_arg3 >
virtual signal_base::pointer DBus::signal< T_return, T_arg1, T_arg2, T_arg3, nil, nil, nil, nil >::clone (  )  [inline, virtual]
template<class T_return , class T_arg1 , class T_arg2 , class T_arg3 >
static pointer DBus::signal< T_return, T_arg1, T_arg2, T_arg3, nil, nil, nil, nil >::create ( const std::string &  path,
const std::string &  interface,
const std::string &  name,
const signal< T_return, T_arg1, T_arg2, T_arg3, nil, nil, nil, nil > &  src 
) [inline, static]
template<class T_return , class T_arg1 , class T_arg2 , class T_arg3 >
static pointer DBus::signal< T_return, T_arg1, T_arg2, T_arg3, nil, nil, nil, nil >::create ( const std::string &  interface,
const std::string &  name,
const signal< T_return, T_arg1, T_arg2, T_arg3, nil, nil, nil, nil > &  src 
) [inline, static]
template<class T_return , class T_arg1 , class T_arg2 , class T_arg3 >
static pointer DBus::signal< T_return, T_arg1, T_arg2, T_arg3, nil, nil, nil, nil >::create ( const std::string &  path,
const std::string &  interface,
const std::string &  name 
) [inline, static]
template<class T_return , class T_arg1 , class T_arg2 , class T_arg3 >
static pointer DBus::signal< T_return, T_arg1, T_arg2, T_arg3, nil, nil, nil, nil >::create ( const std::string &  interface,
const std::string &  name 
) [inline, static]
template<class T_return , class T_arg1 , class T_arg2 , class T_arg3 >
T_return DBus::signal< T_return, T_arg1, T_arg2, T_arg3, nil, nil, nil, nil >::internal_callback ( T_arg1  arg1,
T_arg2  arg2,
T_arg3  arg3 
) [inline, protected]
template<class T_return , class T_arg1 , class T_arg2 , class T_arg3 >
virtual std::string DBus::signal< T_return, T_arg1, T_arg2, T_arg3, nil, nil, nil, nil >::introspect ( int  space_depth = 0  )  const [inline, virtual]
template<class T_return , class T_arg1 , class T_arg2 , class T_arg3 >
virtual void DBus::signal< T_return, T_arg1, T_arg2, T_arg3, nil, nil, nil, nil >::set_arg_name ( size_t  i,
const std::string &  name 
) [inline, virtual]

Friends And Related Function Documentation

template<class T_return , class T_arg1 , class T_arg2 , class T_arg3 >
friend class Interface [friend]

Member Data Documentation

template<class T_return , class T_arg1 , class T_arg2 , class T_arg3 >
std::string DBus::signal< T_return, T_arg1, T_arg2, T_arg3, nil, nil, nil, nil >::m_arg_names[3] [protected]
template<class T_return , class T_arg1 , class T_arg2 , class T_arg3 >
sigc::connection DBus::signal< T_return, T_arg1, T_arg2, T_arg3, nil, nil, nil, nil >::m_internal_callback_connection [protected]

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

Generated on Wed Sep 30 11:15:16 2009 for dbus-cxx by doxygen 1.6.1