agentmanager.h

/*
    Copyright (c) 2006-2008 Tobias Koenig <tokoe@kde.org>

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public License as published by
    the Free Software Foundation; either version 2 of the License, or (at your
    option) any later version.

    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 Library General Public
    License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to the
    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301, USA.
*/

#ifndef AKONADI_AGENTMANAGER_H
#define AKONADI_AGENTMANAGER_H

#include "akonadi_export.h"

#include <akonadi/agenttype.h>
#include <akonadi/agentinstance.h>

#include <QtCore/QObject>

namespace Akonadi {

class AgentManagerPrivate;
class Collection;

class AKONADI_EXPORT AgentManager : public QObject
{
  friend class AgentInstance;
  friend class AgentInstanceCreateJobPrivate;
  friend class AgentManagerPrivate;

  Q_OBJECT

  public:
    static AgentManager *self();

    ~AgentManager();

    AgentType::List types() const;

    AgentType type( const QString &identifier ) const;

    AgentInstance::List instances() const;

    AgentInstance instance( const QString &identifier ) const;

    void removeInstance( const AgentInstance &instance );

    void synchronizeCollection( const Collection &collection );

    void synchronizeCollection( const Collection &collection, bool recursive );

Q_SIGNALS:
    void typeAdded( const Akonadi::AgentType &type );

    void typeRemoved( const Akonadi::AgentType &type );

    void instanceAdded( const Akonadi::AgentInstance &instance );

    void instanceRemoved( const Akonadi::AgentInstance &instance );

    void instanceStatusChanged( const Akonadi::AgentInstance &instance );

    void instanceProgressChanged( const Akonadi::AgentInstance &instance );

    void instanceNameChanged( const Akonadi::AgentInstance &instance );

    void instanceError( const Akonadi::AgentInstance &instance, const QString &message );

    void instanceWarning( const Akonadi::AgentInstance &instance, const QString &message );

    void instanceOnline( const Akonadi::AgentInstance &instance, bool online );

  private:
    //@cond PRIVATE
    AgentManager();

    AgentManagerPrivate* const d;

    Q_PRIVATE_SLOT( d, void agentTypeAdded( const QString& ) )
    Q_PRIVATE_SLOT( d, void agentTypeRemoved( const QString& ) )
    Q_PRIVATE_SLOT( d, void agentInstanceAdded( const QString& ) )
    Q_PRIVATE_SLOT( d, void agentInstanceRemoved( const QString& ) )
    Q_PRIVATE_SLOT( d, void agentInstanceStatusChanged( const QString&, int, const QString& ) )
    Q_PRIVATE_SLOT( d, void agentInstanceProgressChanged( const QString&, uint, const QString& ) )
    Q_PRIVATE_SLOT( d, void agentInstanceNameChanged( const QString&, const QString& ) )
    Q_PRIVATE_SLOT( d, void agentInstanceWarning( const QString&, const QString& ) )
    Q_PRIVATE_SLOT( d, void agentInstanceError( const QString&, const QString& ) )
    Q_PRIVATE_SLOT( d, void agentInstanceOnlineChanged( const QString&, bool ) )
    Q_PRIVATE_SLOT( d, void serviceOwnerChanged( const QString&, const QString&, const QString& ) )
    //@endcond
};

}

#endif