src/versit/qversitdocument.h
changeset 0 876b1a06bc25
child 5 603d3f8b6302
equal deleted inserted replaced
-1:000000000000 0:876b1a06bc25
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the Qt Mobility Components.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    36 **
       
    37 **
       
    38 ** $QT_END_LICENSE$
       
    39 **
       
    40 ****************************************************************************/
       
    41 
       
    42 #ifndef QVERSITDOCUMENT_H
       
    43 #define QVERSITDOCUMENT_H
       
    44 
       
    45 #include "qmobilityglobal.h"
       
    46 
       
    47 #include <QList>
       
    48 #include <QSharedDataPointer>
       
    49 #include <QVariant>
       
    50 #include <QDebug>
       
    51 
       
    52 QT_BEGIN_NAMESPACE
       
    53 class QTextCodec;
       
    54 QT_END_NAMESPACE
       
    55 
       
    56 QTM_BEGIN_NAMESPACE
       
    57 
       
    58 class QVersitDocumentPrivate;
       
    59 class QVersitProperty;
       
    60 
       
    61 class Q_VERSIT_EXPORT QVersitDocument
       
    62 {
       
    63 public:
       
    64     enum VersitType {
       
    65         InvalidType,
       
    66         VCard21Type,   // vCard version 2.1
       
    67         VCard30Type    // vCard version 3.0 (RFC 2426)
       
    68     };
       
    69 
       
    70     QVersitDocument();
       
    71     QVersitDocument(const QVersitDocument& other);
       
    72     QVersitDocument(VersitType type);
       
    73     ~QVersitDocument();
       
    74 
       
    75     QVersitDocument& operator=(const QVersitDocument& other);
       
    76     bool operator==(const QVersitDocument& other) const;
       
    77     bool operator!=(const QVersitDocument& other) const;
       
    78 
       
    79     // metadata about the versit document itself.
       
    80     void setType(VersitType type);
       
    81     VersitType type() const;
       
    82 
       
    83     void addProperty(const QVersitProperty& property);
       
    84     void removeProperty(const QVersitProperty& property);
       
    85     void removeProperties(const QString& name);
       
    86     QList<QVersitProperty> properties() const;
       
    87 
       
    88     bool isEmpty() const;
       
    89     void clear();
       
    90 
       
    91 private:
       
    92 
       
    93     QSharedDataPointer<QVersitDocumentPrivate> d;
       
    94 };
       
    95 
       
    96 Q_VERSIT_EXPORT uint qHash(const QVersitDocument& key);
       
    97 #ifndef QT_NO_DEBUG_STREAM
       
    98 Q_VERSIT_EXPORT QDebug operator<<(QDebug dbg, const QVersitDocument& property);
       
    99 #endif
       
   100 
       
   101 QTM_END_NAMESPACE
       
   102 
       
   103 Q_DECLARE_METATYPE(QTM_PREPEND_NAMESPACE(QVersitDocument))
       
   104 
       
   105 #endif // QVERSITDOCUMENT_H