Akonadi

collectionpropertiespage.h
1 /*
2  Copyright (c) 2008 Volker Krause <[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_COLLECTIONPROPERTIESPAGE_H
21 #define AKONADI_COLLECTIONPROPERTIESPAGE_H
22 
23 #include "akonadiwidgets_export.h"
24 
25 #include <QWidget>
26 
27 namespace Akonadi
28 {
29 
30 class Collection;
31 
100 class AKONADIWIDGETS_EXPORT CollectionPropertiesPage : public QWidget
101 {
102  Q_OBJECT
103 public:
109  explicit CollectionPropertiesPage(QWidget *parent = nullptr);
110 
115 
121  virtual void load(const Collection &collection) = 0;
122 
128  virtual void save(Collection &collection) = 0;
129 
138  virtual bool canHandle(const Collection &collection) const;
139 
145  void setPageTitle(const QString &title);
146 
150  QString pageTitle() const;
151 
152 private:
153  //@cond PRIVATE
154  class Private;
155  Private *const d;
156  //@endcond
157 };
158 
169 class AKONADIWIDGETS_EXPORT CollectionPropertiesPageFactory
170 {
171 public:
176 
182  virtual CollectionPropertiesPage *createWidget(QWidget *parent = nullptr) const = 0;
183 };
184 
208 #define AKONADI_COLLECTION_PROPERTIES_PAGE_FACTORY(factoryName, className) \
209  class factoryName : public Akonadi::CollectionPropertiesPageFactory \
210  { \
211  public: \
212  inline Akonadi::CollectionPropertiesPage *createWidget( QWidget *parent = nullptr ) const override \
213  { \
214  return new className( parent ); \
215  } \
216  };
217 
218 }
219 
220 #endif
A factory class for collection properties dialog pages.
Represents a collection of PIM items.
Definition: collection.h:76
A single page in a collection properties dialog.
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:37 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.