summaryrefslogtreecommitdiffabout
path: root/kabc/vcardparser/vcard.h
blob: 85b50e4bd32547b452502eeb6e37002c50f6449f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/*
    This file is part of libkabc.
    Copyright (c) 2003 Tobias Koenig <tokoe@kde.org>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
    Boston, MA 02111-1307, USA.
*/

#ifndef VCARDPARSER_VCARD_H
#define VCARDPARSER_VCARD_H

#include "vcardline.h"
#include <qmap.h>
#include <qstringlist.h>
#include <q3valuelist.h>

namespace KABC {

class VCard
{
  public:
    typedef Q3ValueList<VCard> List;
    typedef QMap< QString, VCardLine::List > LineMap;

    enum Version { v2_1, v3_0 };

    VCard();
    VCard( const VCard& );

    ~VCard();

    VCard& operator=( const VCard& );

    /**
     * Removes all lines from the vCard.
     */
    void clear();

    /**
     * Returns a list of all identifiers that exists in the
     * vCard.
     */
    QStringList identifiers() const;

    /**
     * Adds a VCardLine to the VCard
     */
    void addLine( const VCardLine& line );

    /**
     * Returns all lines of the vcard with a special identifier.
     */
    VCardLine::List lines( const QString& identifier ) const;

    /**
     * Returns only the first line of the vcard with a special identifier.
     */
    VCardLine line( const QString& identifier ) const;

    /**
     * Set the version of the vCard.
     */
    void setVersion( Version version );

    /**
     * Returns the version of this vCard.
     */
    Version version() const;

  private:
    LineMap mLineMap;

    class VCardPrivate;
    VCardPrivate *d;
};

}

#endif