Akonadi::PartFetcher Class Reference

#include <partfetcher.h>

Inherits KJob.

Public Member Functions
	PartFetcher (const QModelIndex &index, const QByteArray &partName, QObject *parent=0)
virtual	~PartFetcher ()
QModelIndex	index () const
Item	item () const
QByteArray	partName () const
virtual void	start ()

Detailed Description

Convenience class for getting payload parts from an Akonadi Model.

This class can be used to retrieve individual payload parts from an EntityTreeModel, and fetch them asynchronously from the Akonadi storage if necessary.

The requested part is emitted though the partFetched signal.

Example:

const QModelIndex index = view->selectionModel()->currentIndex();

PartFetcher *fetcher = new PartFetcher( index, Akonadi::MessagePart::Envelope );
connect( fetcher, SIGNAL( result( KJob* ) ), SLOT( fetchResult( KJob* ) ) );
fetcher->start();

...

MyClass::fetchResult( KJob *job )
{
  if ( job->error() ) {
    qDebug() << job->errorText();
    return;
  }

  PartFetcher *fetcher = qobject_cast<PartFetcher*>( job );

  const Item item = fetcher->item();
  // do something with the item
}

Author

Stephen Kelly steve.nosp@m.ire@.nosp@m.gmail.nosp@m..com

Since

4.4

Definition at line 73 of file partfetcher.h.

Constructor & Destructor Documentation

PartFetcher::PartFetcher	(	const QModelIndex &	index,
		const QByteArray &	partName,
		QObject *	parent = 0
	)

Creates a new part fetcher.

Parameters

index	The index of the item to fetch the part from.
partName	The name of the payload part to fetch.
parent	The parent object.

Definition at line 103 of file partfetcher.cpp.

PartFetcher::~PartFetcher ( )

virtual

Destroys the part fetcher.

Definition at line 108 of file partfetcher.cpp.

Member Function Documentation

QModelIndex PartFetcher::index

(

)

const

Returns the index of the item the part was fetched from.

Definition at line 162 of file partfetcher.cpp.

Item PartFetcher::item

(

)

const

Returns the item that contains the fetched payload part.

Definition at line 176 of file partfetcher.cpp.

QByteArray PartFetcher::partName

(

)

const

Returns the name of the part that has been fetched.

Definition at line 169 of file partfetcher.cpp.

void PartFetcher::start ( )

virtual

Starts the fetch operation.

Definition at line 113 of file partfetcher.cpp.

---

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

• partfetcher.h
• partfetcher.cpp