Akonadi

trashjob.h
1 /*
2  Copyright (c) 2011 Christian Mollekopf <[email protected]>
3 
4  This library is free software; you can redistribute it and/or modify it
5  under the terms of the GNU Library General Public License as published by
6  the Free Software Foundation; either version 2 of the License, or (at your
7  option) any later version.
8 
9  This library is distributed in the hope that it will be useful, but WITHOUT
10  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
12  License for more details.
13 
14  You should have received a copy of the GNU Library General Public License
15  along with this library; see the file COPYING.LIB. If not, write to the
16  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17  02110-1301, USA.
18 */
19 
20 #ifndef AKONADI_TRASHJOB_H
21 #define AKONADI_TRASHJOB_H
22 
23 #include "akonadicore_export.h"
24 #include "item.h"
25 #include "collection.h"
26 #include "job.h"
27 
28 namespace Akonadi
29 {
30 
65 class AKONADICORE_EXPORT TrashJob : public Job
66 {
67  Q_OBJECT
68 
69 public:
70 
79  explicit TrashJob(const Item &item, QObject *parent = nullptr);
80 
91  explicit TrashJob(const Item::List &items, QObject *parent = nullptr);
92 
102  explicit TrashJob(const Collection &collection, QObject *parent = nullptr);
103 
104  ~TrashJob() override;
105 
109  void keepTrashInCollection(bool enable);
110 
114  void setTrashCollection(const Collection &trashcollection);
115 
119  void deleteIfInTrash(bool enable);
120 
121  Q_REQUIRED_RESULT Item::List items() const;
122 
123 protected:
124  void doStart() override;
125 
126 private:
127  //@cond PRIVATE
128  class TrashJobPrivate;
129  Q_DECLARE_PRIVATE(TrashJob)
130  Q_PRIVATE_SLOT(d_func(), void selectResult(KJob *))
131  Q_PRIVATE_SLOT(d_func(), void setAttribute(const Akonadi::Collection::List &))
132  Q_PRIVATE_SLOT(d_func(), void setAttribute(const Akonadi::Item::List &))
133  Q_PRIVATE_SLOT(d_func(), void setAttribute(KJob *))
134  Q_PRIVATE_SLOT(d_func(), void collectionsReceived(const Akonadi::Collection::List &))
135  Q_PRIVATE_SLOT(d_func(), void itemsReceived(const Akonadi::Item::List &))
136  Q_PRIVATE_SLOT(d_func(), void parentCollectionReceived(const Akonadi::Collection::List &))
137  //@endcond
138 };
139 
140 }
141 
142 #endif
Represents a collection of PIM items.
Definition: collection.h:76
Base class for all actions in the Akonadi storage.
Definition: job.h:93
Job that moves items/collection to trash.
Definition: trashjob.h:65
Helper integration between Akonadi and Qt.
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed May 27 2020 22:43:41 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.