/usr/include/akonadi/itemdeletejob.h is in kdepimlibs5-dev 4:4.14.10-7+b2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 | /*
Copyright (c) 2006 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_ITEMDELETEJOB_H
#define AKONADI_ITEMDELETEJOB_H
#include "akonadi_export.h"
#include <akonadi/item.h>
#include <akonadi/job.h>
namespace Akonadi {
class Collection;
class ItemDeleteJobPrivate;
/**
* @short Job that deletes items from the Akonadi storage.
*
* This job removes the given items from the Akonadi storage.
*
* Example:
*
* @code
*
* const Akonadi::Item item = ...
*
* ItemDeleteJob *job = new ItemDeleteJob(item);
* connect(job, SIGNAL(result(KJob*)), this, SLOT(deletionResult(KJob*)));
*
* @endcode
*
* Example:
*
* @code
*
* const Akonadi::Item::List items = ...
*
* ItemDeleteJob *job = new ItemDeleteJob(items);
* connect(job, SIGNAL(result(KJob*)), this, SLOT(deletionResult(KJob*)));
*
* @endcode
*
* @author Volker Krause <vkrause@kde.org>
*/
class AKONADI_EXPORT ItemDeleteJob : public Job
{
Q_OBJECT
public:
/**
* Creates a new item delete job that deletes @p item. The item
* needs to have a unique identifier set.
*
* @internal
* For internal use only, the item may have a remote identifier set instead
* of a unique identifier. In this case, a collection or resource context
* needs to be selected using CollectionSelectJob or ResourceSelectJob.
* @endinternal
*
* @param item The item to delete.
* @param parent The parent object.
*/
explicit ItemDeleteJob(const Item &item, QObject *parent = 0);
/**
* Creates a new item delete job that deletes all items in the list
* @p items. Each item needs to have a unique identifier set. These items
* can be located in any collection.
*
* @internal
* For internal use only, the items may have remote identifiers set instead
* of unique identifiers. In this case, a collection or resource context
* needs to be selected using CollectionSelectJob or ResourceSelectJob.
* @endinternal
*
* @param items The items to delete.
* @param parent The parent object.
*
* @since 4.3
*/
explicit ItemDeleteJob(const Item::List &items, QObject *parent = 0);
/**
* Creates a new item delete job that deletes all items in the collection
* @p collection. The collection needs to have a unique identifier set.
*
* @internal
* For internal use only, the collection may have a remote identifier set
* instead of a unique identifier. In this case, a resource context needs
* to be selected using ResourceSelectJob.
* @endinternal
*
* @param collection The collection which content should be deleted.
* @param parent The parent object.
*
* @since 4.3
*/
explicit ItemDeleteJob(const Collection &collection, QObject *parent = 0);
/**
* Creates a new item delete job that deletes all items that have assigned
* the tag @p tag.
*
* @param tag The tag which content should be deleted.
* @param parent The parent object.
*
* @since 4.14
*/
explicit ItemDeleteJob(const Tag &tag, QObject *parent = 0);
/**
* Destroys the item delete job.
*/
~ItemDeleteJob();
/**
* Returns the items passed on in the constructor.
* @since 4.4
*/
Item::List deletedItems() const;
protected:
virtual void doStart();
private:
//@cond PRIVATE
Q_DECLARE_PRIVATE(ItemDeleteJob)
//@endcond
};
}
#endif
|