agentinstance.h

/*
    Copyright (c) 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_AGENTINSTANCE_H
#define AKONADI_AGENTINSTANCE_H

#include "akonadi_export.h"

#include <QtCore/QList>
#include <QtCore/QMetaType>
#include <QtCore/QSharedDataPointer>

class QString;
class QStringList;
class QWidget;

namespace Akonadi
{

class AgentType;

class AKONADI_EXPORT AgentInstance
{
  friend class AgentManager;
  friend class AgentManagerPrivate;

  public:
    typedef QList<AgentInstance> List;

    enum Status {
      Idle = 0, 
      Running,  
      Broken,    
      NotConfigured  
    };

    AgentInstance();

    AgentInstance( const AgentInstance &other );

    ~AgentInstance();

    bool isValid() const;

    AgentType type() const;

    QString identifier() const;

    QString name() const;

    void setName( const QString &name );

    Status status() const;

    QString statusMessage() const;

    int progress() const;

    bool isOnline() const;

    void setIsOnline( bool online );

    void configure( QWidget *parent = 0 );

    void synchronize();

    void synchronizeCollectionTree();

    AgentInstance& operator=( const AgentInstance &other );

    bool operator==( const AgentInstance &other ) const;

    void abortCurrentTask() const;

    void reconfigure() const;

    void restart() const;

  private:
    //@cond PRIVATE
    class Private;
    QSharedDataPointer<Private> d;
    //@endcond
};

}

Q_DECLARE_TYPEINFO( Akonadi::AgentInstance, Q_MOVABLE_TYPE );

Q_DECLARE_METATYPE( Akonadi::AgentInstance )

#endif