Home · All Namespaces · All Classes · Grouped Classes · Modules · Functions

QPimContext Class Reference
[QtMessagingModule, QtPimModule, QtTelephonyModule, QtUiModule]

The QPimContext class represents a storage context of PIM data. More...

    #include <QPimContext>

Inherits QObject.

Inherited by QAppointmentContext, QContactContext, and QTaskContext.

• List of all members, including inherited members

Public Functions

• virtual QPimSource defaultSource () const = 0
• virtual QString description () const = 0
• virtual bool editable () const
• virtual bool editable ( const QUniqueId & id ) const
• virtual bool exists ( const QUniqueId & id ) const = 0
• virtual bool exists ( const QUniqueId & id, const QPimSource & source ) const
• virtual QIcon icon () const
• virtual QUuid id () const = 0
• virtual void setVisibleSources ( const QSet<QPimSource> & visible )
• virtual QPimSource source ( const QUniqueId & id ) const = 0
• virtual QSet<QPimSource> sources () const = 0
• virtual QString title () const = 0
• virtual QString title ( const QPimSource & source ) const
• virtual QSet<QPimSource> visibleSources () const

• 29 public functions inherited from QObject

Protected Functions

• QPimContext ( QObject * parent = 0 )

• 7 protected functions inherited from QObject

Additional Inherited Members

• 1 property inherited from QObject
• 1 public slot inherited from QObject
• 1 signal inherited from QObject
• 1 public type inherited from QObject
• 4 static public members inherited from QObject
• 2 protected variables inherited from QObject

Detailed Description

The QPimContext class represents a storage context of PIM data.

This includes storage such as SIM Card contacts or data stored on the device in the system PIM database. The class can be used to perform operations that relate to a specific context of PIM data.

QPimContext should not be instantiated directly. Instead, one of the data type specific contexts should be used. These are QContactContext, QTaskContext and QAppointmentContext.

Currently there is no way for applications to implement their own contexts. This feature is being considered for future versions of Qtopia.

See also QAppointmentModel, QContactModel, QTaskModel, and Pim Library.

Member Function Documentation

QPimContext::QPimContext ( QObject * parent = 0 )   [protected]

Constructs a QPimContext with parent parent.

QPimSource QPimContext::defaultSource () const   [pure virtual]

Returns the default PIM data source that is controlled by this context.

If there is no default PIM data source returns a null source.

QString QPimContext::description () const   [pure virtual]

Returns text describing the PIM context, in a format suitable for displaying to the user.

bool QPimContext::editable () const   [virtual]

Returns true if any PIM records stored by the context can be edited. The default implementation returns false.

bool QPimContext::editable ( const QUniqueId & id ) const   [virtual]

This is an overloaded member function, provided for convenience.

Returns true if the PIM record identified by id can be edited by this context, otherwise false.

bool QPimContext::exists ( const QUniqueId & id ) const   [pure virtual]

Returns true if the PIM record identified by id exists in a PIM data source controlled by this context. Otherwise returns false.

See also source().

bool QPimContext::exists ( const QUniqueId & id, const QPimSource & source ) const   [virtual]

This is an overloaded member function, provided for convenience.

Returns true if the contact identified by id exists in the PIM data source and the source is controlled by this context. Otherwise returns false.

See also source().

QIcon QPimContext::icon () const   [virtual]

Returns an icon associated with the context. The default implementation returns a null icon.

QUuid QPimContext::id () const   [pure virtual]

Returns a unique identifier for this context.

void QPimContext::setVisibleSources ( const QSet<QPimSource> & visible )   [virtual]

Filters the model that created this context to only show records for the sources that are contained in visible. Does not affect data from other contexts.

See also visibleSources().

QPimSource QPimContext::source ( const QUniqueId & id ) const   [pure virtual]

Returns the PIM data source identified by id where the record is stored, if it exists. Returns a null PIM data source if there is no record for id.

See also exists().

QSet<QPimSource> QPimContext::sources () const   [pure virtual]

Returns the list of PIM data sources that are controlled by this context.

QString QPimContext::title () const   [pure virtual]

Returns the title of the PIM context, in a format suitable for displaying to the user.

QString QPimContext::title ( const QPimSource & source ) const   [virtual]

This is an overloaded member function, provided for convenience.

Returns the title of the PIM data source, in a format suitable for displaying to the user. Returns the title for the context by default.

QSet<QPimSource> QPimContext::visibleSources () const   [virtual]

Returns the set of PIM data sources that are controlled by this context and are visible in the model that created the context.

See also setVisibleSources().