Telepathy::Client::ReadyObject Class Reference

#include <TelepathyQt4/Client/ReadyObject>

Inheritance diagram for Telepathy::Client::ReadyObject:

Inheritance graph
[legend]
Collaboration diagram for Telepathy::Client::ReadyObject:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 ReadyObject (QObject *object, const Feature &featureCore)
 ~ReadyObject ()
virtual bool isReady (const Features &features=Features()) const
virtual PendingReadybecomeReady (const Features &requestedFeatures=Features())
virtual Features requestedFeatures () const
virtual Features actualFeatures () const
virtual Features missingFeatures () const

Protected Member Functions

ReadinessHelperreadinessHelper () const

Friends

struct Private


Constructor & Destructor Documentation

Telepathy::Client::ReadyObject::ReadyObject ( QObject *  object,
const Feature featureCore 
)

Construct a new ReadyObject object.

Parameters:
object The QObject the object refers to.
featureCore The core feature of the object.

Telepathy::Client::ReadyObject::~ReadyObject (  ) 

Class destructor.


Member Function Documentation

Features Telepathy::Client::ReadyObject::actualFeatures (  )  const [virtual]

PendingReady * Telepathy::Client::ReadyObject::becomeReady ( const Features requestedFeatures = Features()  )  [virtual]

Return a pending operation which will succeed when this object finishes its initial setup, or will fail if a fatal error occurs during this initial setup.

If an empty set is used FeatureCore will be considered as the requested feature.

Parameters:
requestedFeatures The features which should be enabled
Returns:
A PendingReady object which will emit finished when this object has finished or failed initial setup for basic functionality plus the given features

bool Telepathy::Client::ReadyObject::isReady ( const Features features = Features()  )  const [virtual]

Return whether this object has finished its initial setup.

This is mostly useful as a sanity check, in code that shouldn't be run until the object is ready. To wait for the object to be ready, call becomeReady() and connect to the finished signal on the result.

Parameters:
features The features which should be tested
Returns:
true if the object has finished its initial setup for basic functionality plus the given features

Referenced by Telepathy::Client::Connection::allowedPresenceStatuses(), Telepathy::Client::Account::avatar(), Telepathy::Client::Channel::channelType(), Telepathy::Client::Connection::getContactAttributes(), Telepathy::Client::Channel::groupAddContacts(), Telepathy::Client::Channel::groupAddSelfHandle(), Telepathy::Client::Channel::groupAreHandleOwnersAvailable(), Telepathy::Client::Channel::groupCanAddContacts(), Telepathy::Client::Channel::groupCanRemoveContacts(), Telepathy::Client::Channel::groupCanRescindContacts(), Telepathy::Client::Channel::groupContacts(), Telepathy::Client::Channel::groupFlags(), Telepathy::Client::Channel::groupHandleOwners(), Telepathy::Client::Channel::groupIsSelfContactTracked(), Telepathy::Client::Channel::groupLocalPendingContactChangeInfo(), Telepathy::Client::Channel::groupLocalPendingContacts(), Telepathy::Client::Channel::groupRemotePendingContacts(), Telepathy::Client::Channel::groupRemoveContacts(), Telepathy::Client::Channel::groupSelfContact(), Telepathy::Client::Channel::groupSelfContactRemoveInfo(), Telepathy::Client::Channel::groupSelfHandleIsLocalPending(), Telepathy::Client::Channel::initiatorContact(), Telepathy::Client::Connection::interfaces(), Telepathy::Client::Channel::interfaces(), Telepathy::Client::Channel::isRequested(), Telepathy::Client::Account::protocolInfo(), Telepathy::Client::Connection::selfContact(), Telepathy::Client::StreamedMediaChannel::streams(), Telepathy::Client::StreamedMediaChannel::streamsForType(), Telepathy::Client::Channel::targetHandle(), and Telepathy::Client::Channel::targetHandleType().

Features Telepathy::Client::ReadyObject::missingFeatures (  )  const [virtual]

ReadinessHelper * Telepathy::Client::ReadyObject::readinessHelper (  )  const [protected]

Features Telepathy::Client::ReadyObject::requestedFeatures (  )  const [virtual]


Friends And Related Function Documentation

friend struct Private [friend]


Generated on Mon Mar 23 18:02:34 2009 for TelepathyQt4-0.1.2 by  doxygen 1.5.8