accounts-qt 0.31
Accounts::ServiceType Class Reference

Representation of an account service type. More...

#include <service-type.h>

List of all members.

Public Member Functions

QString name () const
 Returns the name (ID) of the service type.
QString displayName () const
 Returns the display name of the service type; this is a string that could be shown in the UI to describe the service type to the user.
QString trCatalog () const
 Returns the name of the translation catalog, which can be used to translate the displayName().
QString iconName () const
const QDomDocument domDocument () const
 Return the DOM of the whole XML service file.

Friends

class Manager

Detailed Description

Representation of an account service type.

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

Definition at line 51 of file service-type.h.


Member Function Documentation

QString ServiceType::displayName ( ) const

Returns the display name of the service type; this is a string that could be shown in the UI to describe the service type to the user.

The library attempts to translate this string by passing it to the qtTrId() function; in order for this to work you must make sure that the translation catalogue has been loaded before, if needed.

Definition at line 54 of file service-type.cpp.

const QDomDocument ServiceType::domDocument ( ) const

Return the DOM of the whole XML service file.

Definition at line 77 of file service-type.cpp.

QString ServiceType::iconName ( ) const
Returns:
the icon name.

Definition at line 72 of file service-type.cpp.

QString ServiceType::name ( ) const

Returns the name (ID) of the service type.

Definition at line 49 of file service-type.cpp.

QString ServiceType::trCatalog ( ) const

Returns the name of the translation catalog, which can be used to translate the displayName().

Definition at line 67 of file service-type.cpp.


Friends And Related Function Documentation

friend class Manager [friend]

Definition at line 88 of file service-type.h.


The documentation for this class was generated from the following files: