provider.h

/* vi: set et sw=4 ts=4 cino=t0,(0: */
/*
 * This file is part of libaccounts-qt
 *
 * Copyright (C) 2009-2011 Nokia Corporation.
 * Copyright (C) 2012-2016 Canonical Ltd.
 *
 * Contact: Alberto Mardegan <alberto.mardegan@canonical.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * version 2.1 as published by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 */
#ifndef ACCOUNTS_PROVIDER_H
#define ACCOUNTS_PROVIDER_H
 
#include "Accounts/accountscommon.h"
 
#include <QStringList>
#include <QDomDocument>
 
extern "C"
{
    typedef struct _AgProvider AgProvider;
}
 
namespace Accounts
{
class Provider;
 
typedef QList<Provider> ProviderList;
 
class ACCOUNTS_EXPORT Provider
{
public:
    Provider();
    Provider(const Provider &other);
    Provider &operator=(const Provider &other);
    ~Provider();
 
    bool isValid() const;
 
    QString name() const;
    QString displayName() const;
    QString description() const;
    QString pluginName() const;
    QString trCatalog() const;
    QString iconName() const;
    QString domainsRegExp() const;
    bool isSingleAccount() const;
    const QDomDocument domDocument() const;
 
    friend inline bool operator==(const Accounts::Provider &p1,
                                  const Accounts::Provider &p2) {
        return p1.m_provider == p2.m_provider || p1.name() == p2.name();
    }
 
private:
    // \cond
    friend class Manager;
    Provider(AgProvider *provider, ReferenceMode mode = AddReference);
    AgProvider *provider() const;
    AgProvider *m_provider;
    // \endcond
};
 
} //namespace Accounts
 
#endif // ACCOUNTS_PROVIDER_H