Home · All Classes · All Namespaces · Modules · Functions · Files
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Tp::BaseProtocolAddressingInterface Class Reference

Base class for implementations of Protocol.Interface.Addressing. More...

#include <TelepathyQt/BaseProtocolAddressingInterface>

Inheritance diagram for Tp::BaseProtocolAddressingInterface:
Inheritance graph
[legend]

Public Types

typedef Callback3< QString,
const QString &, const QString
&, DBusError * > 
NormalizeVCardAddressCallback
 
typedef Callback2< QString,
const QString &, DBusError * > 
NormalizeContactUriCallback
 

Public Member Functions

virtual ~BaseProtocolAddressingInterface ()
 
QVariantMap immutableProperties () const
 
QStringList addressableVCardFields () const
 
void setAddressableVCardFields (const QStringList &vcardFields)
 
QStringList addressableUriSchemes () const
 
void setAddressableUriSchemes (const QStringList &uriSchemes)
 
void setNormalizeVCardAddressCallback (const NormalizeVCardAddressCallback &cb)
 
QString normalizeVCardAddress (const QString &vcardField, const QString &vcardAddress, DBusError *error)
 
void setNormalizeContactUriCallback (const NormalizeContactUriCallback &cb)
 
QString normalizeContactUri (const QString &uri, DBusError *error)
 
- Public Member Functions inherited from Tp::AbstractProtocolInterface
 AbstractProtocolInterface (const QString &interfaceName)
 
virtual ~AbstractProtocolInterface ()
 
- Public Member Functions inherited from Tp::AbstractDBusServiceInterface
 AbstractDBusServiceInterface (const QString &interfaceName)
 
virtual ~AbstractDBusServiceInterface ()
 
QString interfaceName () const
 
DBusObjectdbusObject () const
 
bool isRegistered () const
 
- Public Member Functions inherited from Tp::Object
virtual ~Object ()
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
virtual  ~QObject ()
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
virtual const QMetaObjectmetaObject () const
 
QString objectName () const
 
void setObjectName (const QString &name)
 
bool isWidgetType () const
 
bool signalsBlocked () const
 
bool blockSignals (bool block)
 
QThreadthread () const
 
void moveToThread (QThread *targetThread)
 
int startTimer (int interval)
 
void killTimer (int id)
 
findChild (const QString &name) const
 
QList< T > findChildren (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QObjectchild (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
void setParent (QObject *parent)
 
void installEventFilter (QObject *filterObj)
 
void removeEventFilter (QObject *obj)
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *receiver, const char *method)
 
void dumpObjectTree ()
 
void dumpObjectInfo ()
 
bool setProperty (const char *name, const QVariant &value)
 
QVariant property (const char *name) const
 
QList< QByteArraydynamicPropertyNames () const
 
void destroyed (QObject *obj)
 
QObjectparent () const
 
bool inherits (const char *className) const
 
void deleteLater ()
 
 QObject (QObject *parent, const char *name)
 
void insertChild (QObject *object)
 
void removeChild (QObject *object)
 
bool isA (const char *className) const
 
const char * className () const
 
const char * name () const
 
const char * name (const char *defaultName) const
 
void setName (const char *name)
 
- Public Member Functions inherited from Tp::RefCounted
 RefCounted ()
 
virtual ~RefCounted ()
 

Static Public Member Functions

static
BaseProtocolAddressingInterfacePtr 
create ()
 
template<typename BaseProtocolAddressingInterfaceSubclass >
static SharedPtr
< BaseProtocolAddressingInterfaceSubclass > 
create ()
 
- Static Public Member Functions inherited from QObject
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 

Protected Member Functions

 BaseProtocolAddressingInterface ()
 
- Protected Member Functions inherited from Tp::AbstractDBusServiceInterface
virtual bool registerInterface (DBusObject *dbusObject)
 
- Protected Member Functions inherited from Tp::Object
 Object ()
 
void notify (const char *propertyName)
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 
virtual void timerEvent (QTimerEvent *event)
 
virtual void childEvent (QChildEvent *event)
 
virtual void customEvent (QEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void disconnectNotify (const char *signal)
 
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 

Additional Inherited Members

- Signals inherited from Tp::Object
void propertyChanged (const QString &propertyName)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Base class for implementations of Protocol.Interface.Addressing.

Member Typedef Documentation

Constructor & Destructor Documentation

Tp::BaseProtocolAddressingInterface::~BaseProtocolAddressingInterface ( )
virtual

Class destructor.

Tp::BaseProtocolAddressingInterface::BaseProtocolAddressingInterface ( )
protected

Class constructor.

Member Function Documentation

static BaseProtocolAddressingInterfacePtr Tp::BaseProtocolAddressingInterface::create ( )
inlinestatic
template<typename BaseProtocolAddressingInterfaceSubclass >
static SharedPtr<BaseProtocolAddressingInterfaceSubclass> Tp::BaseProtocolAddressingInterface::create ( )
inlinestatic
QVariantMap Tp::BaseProtocolAddressingInterface::immutableProperties ( ) const
virtual

Return the immutable properties of this interface.

Immutable properties cannot change after the interface has been registered on a service on the bus with registerInterface().

Returns
The immutable properties of this interface.

Implements Tp::AbstractDBusServiceInterface.

QStringList Tp::BaseProtocolAddressingInterface::addressableVCardFields ( ) const

Return the list of addressable vcard fields that have been set with setAddressableVCardFields().

This list is exposed as the AddressableVCardFields property of this interface on the bus and represents the vcard fields that can be used to request a contact for this protocol, normalized to lower case.

Returns
The list of addressable vcard fields that have been set with setAddressableVCardFields().
See also
setAddressableVCardFields()
void Tp::BaseProtocolAddressingInterface::setAddressableVCardFields ( const QStringList vcardFields)

Set the list of vcard fields that can be used to request a contact for this protocol.

All the field names should be normalized to lower case.

Parameters
vcardFieldsThe list of vcard fields to set.
See also
addressableVCardFields()
QStringList Tp::BaseProtocolAddressingInterface::addressableUriSchemes ( ) const

Return the list of URI schemes that have been set with setAddressableUriSchemes().

This list is exposed as the AddressableURISchemes property of this interface on the bus and represents the URI schemes that are supported by this protocol, like "tel" or "sip".

Returns
The list of addressable URI schemes that have been set with setAddressableUriSchemes().
See also
setAddressableUriSchemes()
void Tp::BaseProtocolAddressingInterface::setAddressableUriSchemes ( const QStringList uriSchemes)

Set the list of URI schemes that are supported by this protocol.

Parameters
uriSchemesThe list of URI schemes to set.
See also
addressableUriSchemes()
void Tp::BaseProtocolAddressingInterface::setNormalizeVCardAddressCallback ( const NormalizeVCardAddressCallback cb)

Set a callback that will be called from a client to normalize a given vcard address.

This callback will be called when the NormalizeVCardAddress method on the Protocol.Interface.Addressing D-Bus interface has been called.

Parameters
cbThe callback to set.
See also
normalizeVCardAddress()
QString Tp::BaseProtocolAddressingInterface::normalizeVCardAddress ( const QString vcardField,
const QString vcardAddress,
DBusError error 
)

Return a normalized version of the given vcardAddress, which corresponds to the given vcardField, by calling the callback that has been set with setNormalizeVCardAddressCallback().

Parameters
vcardFieldThe vcard field of the address we are normalizing.
vcardAddressThe address to normalize, which is assumed to belong to a contact.
errorA pointer to a DBusError instance where any possible error will be stored.
Returns
A normalized version of the given vcardAddress, or an empty string if no callback to do the normalization has been set with setNormalizeVCardAddressCallback().
See also
setNormalizeVCardAddressCallback()
void Tp::BaseProtocolAddressingInterface::setNormalizeContactUriCallback ( const NormalizeContactUriCallback cb)

Set a callback that will be called from a client to normalize a given contact URI.

This callback will be called when the NormalizeContactURI method on the Protocol.Interface.Addressing D-Bus interface has been called.

Parameters
cbThe callback to set.
See also
normalizeContactUri()
QString Tp::BaseProtocolAddressingInterface::normalizeContactUri ( const QString uri,
DBusError error 
)

Return a normalized version of the given contact URI, uri, by calling the callback that has been set with setNormalizeContactUriCallback().

Parameters
uriThe contact URI to normalize.
errorA pointer to a DBusError instance where any possible error will be stored.
Returns
A normalized version of the given uri, or an empty string if no callback to do the normalization has been set with setNormalizeContactUriCallback().
See also
setNormalizeContactUriCallback()


Copyright © 2008-2011 Collabora Ltd. and Nokia Corporation
Telepathy-Qt 0.9.4