1/****************************************************************************
2**
3** Copyright (C) 2015 The Qt Company Ltd.
4** Contact: http://www.qt.io/licensing/
5**
6** This file is part of the QtVersitOrganizer module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL21$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see http://www.qt.io/terms-conditions. For further
15** information use the contact form at http://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 2.1 or version 3 as published by the Free
20** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22** following information to ensure the GNU Lesser General Public License
23** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25**
26** As a special exception, The Qt Company gives you certain additional
27** rights. These rights are described in The Qt Company LGPL Exception
28** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29**
30** $QT_END_LICENSE$
31**
32****************************************************************************/
33
34#include "qversitorganizerhandler.h"
35
36QT_BEGIN_NAMESPACE_VERSITORGANIZER
37
38/*!
39 \class QVersitOrganizerHandler
40 \brief The QVersitOrganizerHandler class is a union of the
41 QVersitOrganizerImporterPropertyHandlerV2 and QVersitOrganizerExporterDetailHandlerV2 interfaces.
42 \ingroup versit-extension
43 \inmodule QtVersit
44 */
45
46/*!
47 \class QVersitOrganizerHandlerFactory
48 \brief The QVersitOrganizerHandlerFactory class provides the interface for Versit plugins.
49 \ingroup versit-extension
50 \inmodule QtVersit
51
52 This class provides a simple interface for the creation of QVersitOrganizerHandler instances.
53 Implement this interface to write a Versit plugin. For more details, see \l{Qt Versit Plugins}.
54 */
55
56/*!
57 \fn static const QString QVersitOrganizerHandlerFactory::ProfileSync()
58
59 The constant string signifying a plugin that is relevant to import and export in a
60 synchronization context.
61 \sa QVersitOrganizerHandlerFactory::profiles(), QVersitOrganizerImporter, QVersitOrganizerExporter
62 */
63
64/*!
65 \fn static const QString QVersitOrganizerHandlerFactory::ProfileBackup()
66
67 The constant string signifying a plugin that is relevant to import and export in a backup/restore
68 context.
69 \sa profiles(),
70 QVersitOrganizerImporter::QVersitOrganizerImporter(),
71 QVersitOrganizerExporter::QVersitOrganizerExporter()
72 */
73
74/*!
75 \fn QVersitOrganizerHandlerFactory::~QVersitOrganizerHandlerFactory()
76 This frees any memory used by the QVersitOrganizerHandlerFactory.
77 */
78
79/*!
80 \fn QSet<QString> QVersitOrganizerHandlerFactory::profiles() const
81 This function can be overridden to allow a plugin to report which profiles it is to be active
82 under. If this (as in the default case) returns the empty set, it indicates that the plugin
83 should be loaded under all profiles. If it returns a non-empty set, it will only be loaded for
84 those profiles that are specified by the importer/exporter class.
85 */
86
87/*!
88 \fn QString QVersitOrganizerHandlerFactory::name() const
89 This function should return a unique string that identifies the handlers provided by this factory.
90 Typically, this will be of the form "org.qt-project.Qt.SampleVersitOrganizerHandler" with the
91 appropriate domain and handler name substituted.
92 */
93
94/*!
95 \fn int QVersitOrganizerHandlerFactory::index() const
96 This function should return an index that helps with determining the order in which to run the
97 plugins. Plugins are run in the following order:
98 \list
99 \li Positively-indexed, ascending
100 \li Zero-indexed
101 \li Negatively-indexed, ascending
102 \endlist
103 For example, plugins with an index of 1 are run first and plugins of index -1 are run last.
104 If more than one plugin share an index, the order of execution between them is undefined.
105
106 By default, this returns 0, which is recommended for plugins with no special ordering
107 requirements.
108 */
109
110/*!
111 \fn QVersitOrganizerHandlerFactory::createHandler() const
112 This function is called by the Versit importer or exporter class to create an instance of the
113 handler provided by this factory.
114 */
115
116/*!
117 \fn QVersitOrganizerHandler::~QVersitOrganizerHandler()
118 Destroys this QVersitOrganizerHandler.
119 */
120
121QT_END_NAMESPACE_VERSITORGANIZER
122

source code of qtpim/src/versitorganizer/qversitorganizerhandler.cpp