1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
/*
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
|