/usr/include/akonadi/trashjob.h is in kdepimlibs5-dev 4:4.13.0-0ubuntu1.
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 | /*
Copyright (c) 2011 Christian Mollekopf <chrigi_1@fastmail.fm>
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_TRASHJOB_H
#define AKONADI_TRASHJOB_H
#include "akonadi_export.h"
#include <akonadi/item.h>
#include <akonadi/collection.h>
#include <akonadi/job.h>
namespace Akonadi
{
/**
* @short Job that moves items/collection to trash.
*
* This job marks the given entites as trash and moves them to a given trash collection, if available.
*
* Priorities of trash collections are the following:
* 1. keepTrashInCollection()
* 2. setTrashCollection()
* 3. configured collection in TrashSettings
* 4. keep in collection if nothing is configured
*
* If the item is already marked as trash, it will be deleted instead
* only if deleteIfInTrash() is set.
* The entity is marked as trash with the EntityDeletedAttribute.
*
* The restore collection in the EntityDeletedAttribute is set the following way:
* -If entites are not moved to trash -> no restore collection
* -If collection is deleted -> also subentites get collection.parentCollection as restore collection
* -If multiple items are deleted -> all items get their parentCollection as restore collection
*
* Example:
*
* @code
*
* const Akonadi::Item::List items = ...
*
* TrashJob *job = new TrashJob( items );
* connect( job, SIGNAL( result( KJob* ) ), this, SLOT( deletionResult( KJob* ) ) );
*
* @endcode
*
* @author Christian Mollekopf <chrigi_1@fastmail.fm>
* @since 4.8
*/
class AKONADI_EXPORT TrashJob : public Job
{
Q_OBJECT
public:
/**
* Creates a new trash job that marks @p item as trash, and moves it to the configured trash collection.
*
* If @p keepTrashInCollection is set, the item will not be moved to the configured trash collection.
*
* @param item The item to mark as trash.
* @param parent The parent object.
*/
explicit TrashJob( const Item &item, QObject *parent = 0 );
/**
* Creates a new trash job that marks all items in the list
* @p items as trash, and moves it to the configured trash collection.
* The items can be in different collections/resources and will still be moved to the correct trash colleciton.
*
* If @p keepTrashInCollection is set, the item will not be moved to the configured trash collection.
*
* @param items The items to mark as trash.
* @param parent The parent object.
*/
explicit TrashJob( const Item::List &items, QObject *parent = 0 );
/**
* Creates a new trash job that marks @p collection as trash, and moves it to the configured trash collection.
* The subentities of the collection are also marked as trash.
*
* If @p keepTrashInCollection is set, the item will not be moved to the configured trash collection.
*
* @param collection The collection to mark as trash.
* @param parent The parent object.
*/
explicit TrashJob( const Collection &collection, QObject *parent = 0 );
~TrashJob();
/**
* Ignore configured Trash collections and keep all items local
*/
void keepTrashInCollection( bool enable );
/**
* Moves all entities to the give collection
*/
void setTrashCollection( const Collection &trashcollection );
/**
* Delete Items which are already in trash, instead of ignoring them
*/
void deleteIfInTrash( bool enable );
Item::List items() const;
protected:
virtual void doStart();
private:
//@cond PRIVATE
class TrashJobPrivate;
Q_DECLARE_PRIVATE( TrashJob )
Q_PRIVATE_SLOT( d_func(), void selectResult( KJob* ) )
Q_PRIVATE_SLOT( d_func(), void setAttribute( const Akonadi::Collection::List & ) )
Q_PRIVATE_SLOT( d_func(), void setAttribute( const Akonadi::Item::List & ) )
Q_PRIVATE_SLOT( d_func(), void setAttribute( KJob* ) )
Q_PRIVATE_SLOT( d_func(), void collectionsReceived( const Akonadi::Collection::List & ) )
Q_PRIVATE_SLOT( d_func(), void itemsReceived( const Akonadi::Item::List & ) )
Q_PRIVATE_SLOT( d_func(), void parentCollectionReceived( const Akonadi::Collection::List & ) )
//@endcond
};
}
#endif
|