Home · Modules · All Classes · All Namespaces
Public Member Functions | Protected Member Functions | List of all members
Tp::AbstractDBusServiceInterface Class Referenceabstract

Base class for D-Bus service interfaces. More...

#include <TelepathyQt/AbstractDBusServiceInterface>

Inherits Tp::Object.

Inherited by Tp::AbstractCallContentInterface, Tp::AbstractChannelInterface, Tp::AbstractConnectionInterface, and Tp::AbstractProtocolInterface.

Public Member Functions

 AbstractDBusServiceInterface (const QString &interfaceName)
virtual ~AbstractDBusServiceInterface ()
QString interfaceName () const
virtual QVariantMap immutableProperties () const
DBusObjectdbusObject () const
bool isRegistered () const
bool notifyPropertyChanged (const QString &propertyName, const QVariant &propertyValue)
- Public Member Functions inherited from Tp::Object
virtual ~Object ()
- Public Member Functions inherited from Tp::RefCounted
 RefCounted ()
virtual ~RefCounted ()

Protected Member Functions

virtual bool registerInterface (DBusObject *dbusObject)
virtual void createAdaptor ()=0
- Protected Member Functions inherited from Tp::Object
 Object ()
void notify (const char *propertyName)

Additional Inherited Members

- Signals inherited from Tp::Object
void propertyChanged (const QString &propertyName)

Detailed Description

Base class for D-Bus service interfaces.

This class serves as a base for all the classes that are used to implement interfaces that sit on top of D-Bus services.

Constructor & Destructor Documentation

◆ AbstractDBusServiceInterface()

Tp::AbstractDBusServiceInterface::AbstractDBusServiceInterface ( const QString &  interfaceName)

Construct an AbstractDBusServiceInterface that implements the interface with the given interfaceName.

interfaceNameThe name of the interface that this class implements.

◆ ~AbstractDBusServiceInterface()

Tp::AbstractDBusServiceInterface::~AbstractDBusServiceInterface ( )

Class destructor.

Member Function Documentation

◆ interfaceName()

QString Tp::AbstractDBusServiceInterface::interfaceName ( ) const

Return the name of the interface that this class implements, as given on the constructor.

The name of the interface that this class implements.

◆ immutableProperties()

QVariantMap Tp::AbstractDBusServiceInterface::immutableProperties ( ) const

◆ dbusObject()

DBusObject * Tp::AbstractDBusServiceInterface::dbusObject ( ) const

Return the DBusObject on which the adaptor of this interface is plugged.

This is only accessible after the interface has been registered with registerInterface().

a pointer to the DBusObject on which the adaptor of this interface is plugged.
See also

◆ isRegistered()

bool Tp::AbstractDBusServiceInterface::isRegistered ( ) const

Return whether this interface has been registered.

true if the service has been registered, or false otherwise.
See also

◆ registerInterface()

bool Tp::AbstractDBusServiceInterface::registerInterface ( DBusObject dbusObject)

Registers this interface by plugging its adaptor on the given dbusObject.

dbusObjectThe object on which to plug the adaptor.
false if the interface has already been registered, or true otherwise.
See also

◆ createAdaptor()

void Tp::AbstractDBusServiceInterface::createAdaptor ( )
protectedpure virtual

Create the adaptor for this interface.

Subclasses should reimplement this appropriately.

◆ notifyPropertyChanged()

bool Tp::AbstractDBusServiceInterface::notifyPropertyChanged ( const QString &  propertyName,
const QVariant &  propertyValue 

Emit PropertiesChanged signal on object org.freedesktop.DBus.Properties interface with the property propertyName.

propertyNameThe name of the changed property.
propertyValueThe actual value of the changed property.
false if the signal can not be emmited or true otherwise.