transportmanager.h

/*
    Copyright (c) 2006 - 2007 Volker Krause <vkrause@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 MAILTRANSPORT_TRANSPORTMANAGER_H
#define MAILTRANSPORT_TRANSPORTMANAGER_H

#include <mailtransport/mailtransport_export.h>
#include <mailtransport/transporttype.h>

#include <QtCore/QList>
#include <QtCore/QObject>

#include <akonadi/agenttype.h>

class KJob;

namespace KWallet {
  class Wallet;
}

namespace MailTransport {

class Transport;
class TransportJob;
class TransportManagerPrivate;

class MAILTRANSPORT_EXPORT TransportManager : public QObject
{
  Q_OBJECT
  Q_CLASSINFO( "D-Bus Interface", "org.kde.pim.TransportManager" )

  friend class Transport;
  friend class TransportManagerPrivate;

  public:

    virtual ~TransportManager();

    static TransportManager *self();

    void loadPasswordsAsync();

    Transport *transportById( int id, bool def = true ) const;

    Transport *transportByName( const QString &name, bool def = true ) const;

    QList<Transport *>transports() const;

    TransportType::List types() const;

    Transport *createTransport() const;

    void addTransport( Transport *transport );

    MAILTRANSPORT_DEPRECATED TransportJob *createTransportJob( int transportId );

    MAILTRANSPORT_DEPRECATED TransportJob *createTransportJob( const QString &transport );

    MAILTRANSPORT_DEPRECATED void schedule( TransportJob *job );

    void createDefaultTransport();

    enum ShowCondition {
      Always,              
      IfNoTransportExists  
    };

    bool showTransportCreationDialog( QWidget *parent, ShowCondition showCondition = Always );

    bool configureTransport( Transport *transport, QWidget *parent );

  public Q_SLOTS:
    Q_SCRIPTABLE bool isEmpty() const;

    Q_SCRIPTABLE QList<int> transportIds() const;

    Q_SCRIPTABLE QStringList transportNames() const;

    Q_SCRIPTABLE QString defaultTransportName() const;

    Q_SCRIPTABLE int defaultTransportId() const;

    Q_SCRIPTABLE void setDefaultTransport( int id );

    Q_SCRIPTABLE void removeTransport( int id );

  Q_SIGNALS:
    Q_SCRIPTABLE void transportsChanged();

    Q_SCRIPTABLE void changesCommitted();

    void passwordsChanged();

    void transportRemoved( int id, const QString &name );

    void transportRenamed( int id, const QString &oldName, const QString &newName );

  protected:
    KWallet::Wallet *wallet();

    void loadPasswords();

    TransportManager();

  private:

    // These are used by our friend, Transport
    void emitChangesCommitted();

  private:
    TransportManagerPrivate *const d;

    Q_PRIVATE_SLOT( d, void slotTransportsChanged() )
    Q_PRIVATE_SLOT( d, void slotWalletOpened( bool success ) )
    Q_PRIVATE_SLOT( d, void dbusServiceUnregistered() )
    Q_PRIVATE_SLOT( d, void agentTypeAdded( const Akonadi::AgentType &atype ) )
    Q_PRIVATE_SLOT( d, void agentTypeRemoved( const Akonadi::AgentType &atype ) )
    Q_PRIVATE_SLOT( d, void jobResult( KJob *job ) )
};

} // namespace MailTransport

#endif // MAILTRANSPORT_TRANSPORTMANAGER_H