Accounts.ServiceType
Representation of an account service type. More...
#include <Accounts/ServiceType>
Public Member Functions | |
ServiceType () | |
Construct an invalid serviceType. | |
ServiceType &other) | |
Copy constructor. More... | |
ServiceType &other) | |
bool | isValid () const |
Check whether this object represents a ServiceType. More... | |
QString | name () const |
Returns the name (ID) of the service type. | |
QString | displayName () const |
QString | trCatalog () const |
QString | iconName () const |
bool | hasTag (const QString &tag) const |
Check if this service type has a tag. More... | |
QSet< QString > | tags () const |
Return all tags of the service type as a set. More... | |
const QDomDocument | domDocument () const |
Friends | |
bool | operator== (const Accounts::ServiceType &s2) |
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 49 of file service-type.h.
Constructor & Destructor Documentation
ServiceType | ( | const ServiceType & | other | ) |
Copy constructor.
Copying a ServiceType object is very cheap, because the data is shared among copies.
Definition at line 69 of file service-type.cpp.
Member Function Documentation
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.
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 126 of file service-type.cpp.
const QDomDocument domDocument | ( | ) | const |
- Returns
- The DOM of the whole XML service file
Definition at line 192 of file service-type.cpp.
bool hasTag | ( | const QString & | tag | ) | const |
Check if this service type has a tag.
- Parameters
-
tag Tag to look for
- Returns
- Service type has the tag?
Definition at line 163 of file service-type.cpp.
QString iconName | ( | ) | const |
- Returns
- The icon name
Definition at line 151 of file service-type.cpp.
bool isValid | ( | ) | const |
Check whether this object represents a ServiceType.
- Returns
- true if the ServiceType is a valid one.
Definition at line 104 of file service-type.cpp.
Referenced by ServiceType::name().
QSet< QString > tags | ( | ) | const |
Return all tags of the service type as a set.
- Returns
- Set of tags
Definition at line 173 of file service-type.cpp.
QString trCatalog | ( | ) | const |
- Returns
- The name of the translation catalog, which can be used to translate the displayName()
Definition at line 143 of file service-type.cpp.