Akonadi::AgentInstanceCreateJob Class Reference

#include <agentinstancecreatejob.h>

Inherits KJob.

List of all members.

Public Member Functions
	AgentInstanceCreateJob (const AgentType &type, QObject *parent=0)
	AgentInstanceCreateJob (const QString &typeId, QObject *parent=0)
	~AgentInstanceCreateJob ()
void	configure (QWidget *parent=0)
AgentInstance	instance () const
void	start ()

---

Detailed Description

Job for creating new agent instances.

This class encapsulates the procedure of creating a new agent instance and optionally configuring it immediately.

 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();
 }

Author:

Volker Krause <vkrause@kde.org>

---

Constructor & Destructor Documentation

AgentInstanceCreateJob::AgentInstanceCreateJob	(	const AgentType &	type,
		QObject *	parent = 0
	)		[explicit]

Creates a new agent instance create job.

Parameters:

type	The type of the agent to create.
parent	The parent object.

Definition at line 145 of file agentinstancecreatejob.cpp.

AgentInstanceCreateJob::AgentInstanceCreateJob	(	const QString &	typeId,
		QObject *	parent = 0
	)		[explicit]

Creates a new agent instance create job.

Parameters:

typeId	The identifier of type of the agent to create.
parent	The parent object.

Since:

4.5

Definition at line 152 of file agentinstancecreatejob.cpp.

AgentInstanceCreateJob::~AgentInstanceCreateJob

(

)

Destroys the agent instance create job.

Definition at line 159 of file agentinstancecreatejob.cpp.

---

Member Function Documentation

void AgentInstanceCreateJob::configure

(

QWidget *

parent = 0

)

Setup the job to show agent configuration dialog once the agent instance has been successfully started.

Parameters:

parent

The parent window for the configuration dialog.

Definition at line 164 of file agentinstancecreatejob.cpp.

AgentInstance AgentInstanceCreateJob::instance

(

)

const

Returns the AgentInstance object of the newly created agent instance.

Definition at line 170 of file agentinstancecreatejob.cpp.

void AgentInstanceCreateJob::start

(

)

Starts the instance creation.

Definition at line 175 of file agentinstancecreatejob.cpp.

---

The documentation for this class was generated from the following files:

• agentinstancecreatejob.h
• agentinstancecreatejob.cpp