mirror of
https://bitbucket.org/smil3y/kde-playground.git
synced 2025-02-23 10:22:50 +00:00
131 lines
3.6 KiB
C++
131 lines
3.6 KiB
C++
/*
|
|
Copyright (c) 2008 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 AKONADI_AGENTINSTANCECREATEJOB_H
|
|
#define AKONADI_AGENTINSTANCECREATEJOB_H
|
|
|
|
#include "akonadi_export.h"
|
|
|
|
#include <akonadi/agenttype.h>
|
|
|
|
#include <kjob.h>
|
|
|
|
namespace Akonadi {
|
|
|
|
class AgentInstance;
|
|
class AgentInstanceCreateJobPrivate;
|
|
|
|
/**
|
|
* @short Job for creating new agent instances.
|
|
*
|
|
* This class encapsulates the procedure of creating a new agent instance
|
|
* and optionally configuring it immediately.
|
|
*
|
|
* @code
|
|
*
|
|
* MyClass::MyClass( QWidget *parent )
|
|
* : QWidget( parent )
|
|
* {
|
|
* // Get agent type object
|
|
* Akonadi::AgentType type = Akonadi::AgentManager::self()->type( "akonadi_vcard_resource" );
|
|
*
|
|
* Akonadi::AgentInstanceCreateJob *job = new Akonadi::AgentInstanceCreateJob( type );
|
|
* connect( job, SIGNAL(result(KJob*)),
|
|
* this, SLOT(slotCreated(KJob*)) );
|
|
*
|
|
* // use this widget as parent for the config dialog
|
|
* job->configure( this );
|
|
*
|
|
* job->start();
|
|
* }
|
|
*
|
|
* ...
|
|
*
|
|
* void MyClass::slotCreated( KJob *job )
|
|
* {
|
|
* Akonadi::AgentInstanceCreateJob *createJob = static_cast<Akonadi::AgentInstanceCreateJob*>( job );
|
|
*
|
|
* qDebug() << "Created agent instance:" << createJob->instance().identifier();
|
|
* }
|
|
*
|
|
* @endcode
|
|
*
|
|
* @author Volker Krause <vkrause@kde.org>
|
|
*/
|
|
class AKONADI_EXPORT AgentInstanceCreateJob : public KJob
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
/**
|
|
* Creates a new agent instance create job.
|
|
*
|
|
* @param type The type of the agent to create.
|
|
* @param parent The parent object.
|
|
*/
|
|
explicit AgentInstanceCreateJob(const AgentType &type, QObject *parent = 0);
|
|
|
|
/**
|
|
* Creates a new agent instance create job.
|
|
*
|
|
* @param typeId The identifier of type of the agent to create.
|
|
* @param parent The parent object.
|
|
* @since 4.5
|
|
*/
|
|
explicit AgentInstanceCreateJob(const QString &typeId, QObject *parent = 0);
|
|
|
|
/**
|
|
* Destroys the agent instance create job.
|
|
*/
|
|
~AgentInstanceCreateJob();
|
|
|
|
/**
|
|
* Setup the job to show agent configuration dialog once the agent instance
|
|
* has been successfully started.
|
|
* @param parent The parent window for the configuration dialog.
|
|
*/
|
|
void configure(QWidget *parent = 0);
|
|
|
|
/**
|
|
* Returns the AgentInstance object of the newly created agent instance.
|
|
*/
|
|
AgentInstance instance() const;
|
|
|
|
/**
|
|
* Starts the instance creation.
|
|
*/
|
|
void start();
|
|
|
|
private:
|
|
//@cond PRIVATE
|
|
friend class Akonadi::AgentInstanceCreateJobPrivate;
|
|
AgentInstanceCreateJobPrivate *const d;
|
|
|
|
Q_PRIVATE_SLOT(d, void agentInstanceAdded(const Akonadi::AgentInstance &))
|
|
Q_PRIVATE_SLOT(d, void doConfigure())
|
|
Q_PRIVATE_SLOT(d, void timeout())
|
|
Q_PRIVATE_SLOT(d, void emitResult())
|
|
Q_PRIVATE_SLOT(d, void configurationDialogAccepted())
|
|
Q_PRIVATE_SLOT(d, void configurationDialogRejected())
|
|
//@endcond
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|