accounts-qt  1.16
Public Member Functions | Friends | List of all members
Provider Class Reference

Representation of an account provider. More...

#include <Accounts/Provider>

Public Member Functions

 Provider ()
 Construct an invalid provider.
 
 Provider (const Provider &other)
 Copy constructor. More...
 
Provider & operator= (const Provider &other)
 
bool isValid () const
 Check whether this object represents a Provider. More...
 
QString name () const
 Get the name of the provider. More...
 
QString displayName () const
 Get the display name of the provider, untranslated. More...
 
QString description () const
 Get the description of the provider, untranslated. More...
 
QString pluginName () const
 Get the name of the account plugin associated with the provider. More...
 
QString trCatalog () const
 
QString iconName () const
 
QString domainsRegExp () const
 
bool isSingleAccount () const
 
const QDomDocument domDocument () const
 

Friends

bool operator== (const Accounts::Provider &p1, const Accounts::Provider &p2)
 

Detailed Description

Representation of an account provider.

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

Definition at line 48 of file provider.h.

Constructor & Destructor Documentation

◆ Provider()

Provider ( const Provider &  other)

Copy constructor.

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

Definition at line 65 of file provider.cpp.

Member Function Documentation

◆ description()

QString description ( ) const

Get the description of the provider, untranslated.

Returns
The description of the provider.

Definition at line 124 of file provider.cpp.

◆ displayName()

QString displayName ( ) const

Get the display name of the provider, untranslated.

Returns
The display name of the provider.

Definition at line 115 of file provider.cpp.

◆ domainsRegExp()

QString domainsRegExp ( ) const
Returns
A regular expression pattern which matches all the internet domains in which this type of account can be used.

Definition at line 161 of file provider.cpp.

◆ domDocument()

const QDomDocument domDocument ( ) const
Returns
The DOM of the whole XML provider file.

Definition at line 177 of file provider.cpp.

◆ iconName()

QString iconName ( ) const
Returns
The provider icon name.

Definition at line 152 of file provider.cpp.

◆ isSingleAccount()

bool isSingleAccount ( ) const
Returns
Whether the provider supports creating one account at most.

Definition at line 169 of file provider.cpp.

◆ isValid()

bool isValid ( ) const

Check whether this object represents a Provider.

Returns
true if the Provider is a valid one.

Definition at line 95 of file provider.cpp.

Referenced by Provider::name().

◆ name()

QString name ( ) const

Get the name of the provider.

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

Returns
The unique name of the provider.

Definition at line 105 of file provider.cpp.

References Provider::isValid().

◆ pluginName()

QString pluginName ( ) const

Get the name of the account plugin associated with the provider.

Some platforms might find it useful to store plugin names in the provider XML files, especially when the same plugin can work for different providers.

Returns
The plugin name.

Definition at line 135 of file provider.cpp.

◆ trCatalog()

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

Definition at line 144 of file provider.cpp.

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