← Back to branch summary

~chris.gagnon/+junk/qtpim-coverage

« back to all changes in this revision

Viewing changes to src/versit/doc/src/versit-index.qdoc

  • Committer: chris.gagnon
  • Date: 2013-12-10 23:09:37 UTC
  • Revision ID: chris.gagnon@canonical.com-20131210230937-2akf1ft1edcttk87
first post

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/versit/doc/src/versit-index.qdoc
 
1
/****************************************************************************
 
2
**
 
3
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
 
4
** Contact: http://www.qt-project.org/legal
 
5
**
 
6
** This file is part of the documentation of the Qt Toolkit.
 
7
**
 
8
** $QT_BEGIN_LICENSE:FDL$
 
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 Digia.  For licensing terms and
 
14
** conditions see http://qt.digia.com/licensing.  For further information
 
15
** use the contact form at http://qt.digia.com/contact-us.
 
16
**
 
17
** GNU Free Documentation License Usage
 
18
** Alternatively, this file may be used under the terms of the GNU Free
 
19
** Documentation License version 1.3 as published by the Free Software
 
20
** Foundation and appearing in the file included in the packaging of
 
21
** this file.  Please review the following information to ensure
 
22
** the GNU Free Documentation License version 1.3 requirements
 
23
** will be met: http://www.gnu.org/copyleft/fdl.html.
 
24
** $QT_END_LICENSE$
 
25
**
 
26
****************************************************************************/
 
27
 
 
28
/*!
 
29
    \page qtversit-index.html
 
30
    \title Qt Versit
 
31
    \brief Qt Versit enables clients to import and export contact and calendar
 
32
    information in vCard and iCalendar formats.
 
33
 
 
34
    Most of the time your contacts do not remain in isolation in a single
 
35
    device, but coexist on various mobile phones, computers, and servers. A
 
36
    standard way to exchange the contacts is through the Versit \reg documents.
 
37
 
 
38
    The Qt Versit API enables you to import calendar or contact information in
 
39
    VCard and iCalendar format to the Qt Organizer and Qt Contact API, and to
 
40
    store the information on the current platform. Alternatively, you can
 
41
    export organizer and contact information to VCal or iCalendar files which
 
42
    you can then import into other calendars and contact storages, or easily
 
43
    share through Bluetooth or email, for example.
 
44
 
 
45
    The \l{Qt Organizer} module has information about supported
 
46
    \l{Supported iCalendar Features}{iCalendar features}.
 
47
 
 
48
    \section1 Getting Started
 
49
 
 
50
    To include the definitions of the module's classes, use the following
 
51
    directives. The generic Qt Versit is used in the contacts use case, and it
 
52
    is extended with Qt Organizer:
 
53
 
 
54
    \snippet doc_src_qtversit.cpp versit include
 
55
    \snippet doc_src_qtversit.cpp versit organizer include
 
56
 
 
57
    To use the C++ library in your application, add the following configuration
 
58
    option to your \c .pro file:
 
59
 
 
60
    \snippet doc_src_qtversit.pro versit project modifications
 
61
 
 
62
    \section1 Related Information
 
63
 
 
64
        \section2 Guides
 
65
        \list
 
66
        \li \l{Supported vCard Features}
 
67
        \li \l{Qt Versit Overview}
 
68
        \li \l{Qt Versit Plugins}
 
69
        \endlist
 
70
 
 
71
        \section2 References
 
72
 
 
73
        \list
 
74
        \li \l{Qt Versit C++ Classes}
 
75
        \endlist
 
76
*/