Accounts.Service

Representation of an account service. More...

#include <Accounts/Service>

Public Member Functions

 Service ()
 Construct an invalid service.
 
 Service &other)
 Copy constructor. More...
 
Service &other)
 
bool isValid () const
 Check whether this object represents a Service. More...
 
QString name () const
 Get the name of the service. More...
 
QString displayName () const
 Get the display name of the service, untranslated. More...
 
QString trCatalog () const
 
QString serviceType () const
 Get the service type ID of the service. More...
 
QString provider () const
 Get the provider ID of the service. More...
 
QString iconName () const
 Get the icon name for this service. More...
 
bool hasTag (const QString &tag) const
 Check if this service has a tag. More...
 
QSet< QString > tags () const
 Return all tags of the service as a set. More...
 
const QDomDocument domDocument () const
 Get the contents of the service XML file. More...
 

Friends

bool operator== (const Accounts::Service &s2)
 

Detailed Description

Representation of an account service.

The Service object represents an account service. It can be used to retrieve some basic properties of the service (such as name, type and provider) and to get access to the contents of the XML file which defines it.

Definition at line 48 of file service.h.

Constructor & Destructor Documentation

Service ( const Service other)

Copy constructor.

Copying a Service object is very cheap, because the data is shared among copies.

Definition at line 69 of file service.cpp.

Member Function Documentation

QString displayName ( ) const

Get the display name of the service, untranslated.

Returns
The display name of the service.

Definition at line 124 of file service.cpp.

const QDomDocument domDocument ( ) const

Get the contents of the service XML file.

Returns
The DOM of the whole XML service file

Definition at line 201 of file service.cpp.

bool hasTag ( const QString &  tag) const

Check if this service has a tag.

Parameters
tagTag to look for
Returns
Service has the tag?

Definition at line 171 of file service.cpp.

QString iconName ( ) const

Get the icon name for this service.

Returns
The icon name.

Definition at line 159 of file service.cpp.

bool isValid ( ) const

Check whether this object represents a Service.

Returns
true if the Service is a valid one.

Definition at line 104 of file service.cpp.

Referenced by Service::name().

QString name ( ) const

Get the name of the service.

This can be used as a unique identifier for this service.

Returns
The unique name of the service.

Definition at line 114 of file service.cpp.

References Service::isValid().

QString provider ( ) const

Get the provider ID of the service.

Returns
The provider of the service.

Definition at line 150 of file service.cpp.

QString serviceType ( ) const

Get the service type ID of the service.

Returns
The service type of the service.

Definition at line 133 of file service.cpp.

QSet< QString > tags ( ) const

Return all tags of the service as a set.

Returns
Set of tags

Definition at line 181 of file service.cpp.

QString trCatalog ( ) const
Returns
The translation catalog of the service.

Definition at line 141 of file service.cpp.