• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • TrashRestoreJob
Public Member Functions | Protected Member Functions | List of all members
Akonadi::TrashRestoreJob Class Reference

#include <trashrestorejob.h>

Inheritance diagram for Akonadi::TrashRestoreJob:
Akonadi::Job

Public Member Functions

 TrashRestoreJob (const Collection &collection, QObject *parent=0)
 
 TrashRestoreJob (const Item &item, QObject *parent=0)
 
 TrashRestoreJob (const Item::List &items, QObject *parent=0)
 
Item::List items () const
 
void setTargetCollection (const Collection collection)
 
- Public Member Functions inherited from Akonadi::Job
 Job (QObject *parent=0)
 
virtual ~Job ()
 
virtual QString errorString () const
 
void start ()
 

Protected Member Functions

virtual void doStart ()
 
- Protected Member Functions inherited from Akonadi::Job
virtual bool addSubjob (KJob *job)
 
virtual void doHandleResponse (const QByteArray &tag, const QByteArray &data)
 
virtual bool doKill ()
 
virtual void doStart ()=0
 
void emitWriteFinished ()
 
virtual bool removeSubjob (KJob *job)
 

Additional Inherited Members

- Public Types inherited from Akonadi::Job
enum  Error {
  ConnectionFailed = UserDefinedError , ProtocolVersionMismatch , UserCanceled , Unknown ,
  UserError = UserDefinedError + 42
}
 
typedef QList< Job * > List
 
- Signals inherited from Akonadi::Job
void aboutToStart (Akonadi::Job *job)
 
void writeFinished (Akonadi::Job *job)
 
- Protected Slots inherited from Akonadi::Job
virtual void slotResult (KJob *job)
 

Detailed Description

Job that restores entites from trash.

This job restores the given entites from trash. The EntityDeletedAttribute is removed and the item is restored to the stored restore collection.

If the stored restore collection is not available, the root collection of the original resource is used. If also this is not available, setTargetCollection has to be used to restore the item to a specific collection.

Example:

const Akonadi::Item::List items = ...
TrashRestoreJob *job = new TrashRestoreJob( items );
connect( job, SIGNAL(result(KJob*)), this, SLOT(restoreResult(KJob*)) );
Akonadi::TrashRestoreJob
Job that restores entites from trash.
Definition: trashrestorejob.h:57
Author
Christian Mollekopf chrig.nosp@m.i_1@.nosp@m.fastm.nosp@m.ail..nosp@m.fm
Since
4.8

Definition at line 56 of file trashrestorejob.h.

Constructor & Destructor Documentation

◆ TrashRestoreJob() [1/3]

TrashRestoreJob::TrashRestoreJob ( const Item &  item,
QObject *  parent = 0 
)
explicit

All items need to be from the same resource.

Definition at line 274 of file trashrestorejob.cpp.

◆ TrashRestoreJob() [2/3]

TrashRestoreJob::TrashRestoreJob ( const Item::List &  items,
QObject *  parent = 0 
)
explicit

Definition at line 281 of file trashrestorejob.cpp.

◆ TrashRestoreJob() [3/3]

TrashRestoreJob::TrashRestoreJob ( const Collection &  collection,
QObject *  parent = 0 
)
explicit

Definition at line 288 of file trashrestorejob.cpp.

◆ ~TrashRestoreJob()

TrashRestoreJob::~TrashRestoreJob ( )

Definition at line 295 of file trashrestorejob.cpp.

Member Function Documentation

◆ doStart()

void TrashRestoreJob::doStart ( )
protectedvirtual

This method must be reimplemented in the concrete jobs.

It will be called after the job has been started and a connection to the Akonadi backend has been established.

Implements Akonadi::Job.

Definition at line 311 of file trashrestorejob.cpp.

◆ items()

Item::List TrashRestoreJob::items ( ) const

Definition at line 305 of file trashrestorejob.cpp.

◆ setTargetCollection()

void TrashRestoreJob::setTargetCollection ( const Collection  collection)

Sets the target collection, where the item is moved to.

If not set the item will be restored in the collection saved in the EntityDeletedAttribute.

Parameters
collectionthe collection to set as target

Definition at line 299 of file trashrestorejob.cpp.


The documentation for this class was generated from the following files:
  • trashrestorejob.h
  • trashrestorejob.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Modules
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal