summaryrefslogtreecommitdiffabout
path: root/kabc/picture.h
blob: 714d1e25e4a02ba5acb99c9f8ac718f4af6019c0 (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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/*
    This file is part of libkabc.
    Copyright (c) 2002 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.
*/

/*
Enhanced Version of the file for platform independent KDE tools.
Copyright (c) 2004 Ulf Schenk

$Id$
*/

#ifndef KABC_PICTURE_H
#define KABC_PICTURE_H

#include <qimage.h>

namespace KABC {

class Picture
{
  friend QDataStream &operator<<( QDataStream &, const Picture & );
  friend QDataStream &operator>>( QDataStream &, Picture & );

public:

  /**
   * Consturctor. Creates an empty object.
   */
  Picture();

  /**
   * Consturctor.
   *
   * @param url  A URL that describes the position of the picture file.
   */
  Picture( const QString &url );

  /**
   * Consturctor.
   *
   * @param data  The raw data of the picture.
   */
  Picture( const QImage &data );

  /**
   * Destructor.
   */
  ~Picture();

  bool undefined() const;
  bool operator==( const Picture & ) const;
  bool operator!=( const Picture & ) const;

  /**
   * Sets a URL for the location of the picture file. When using this
   * function, @ref isIntern() will return 'false' until you use
   * @ref setData().
   *
   * @param url  The location URL of the picture file.
   */
  void setUrl( const QString &url );

  /**
   * Sets the raw data of the picture. When using this function,
   * @ref isIntern() will return 'true' until you use @ref setUrl().
   *
   * @param data  The raw data of the picture.
   */
  void setData( const QImage &data );

  /**
   * Sets the type of the picture.
   */
  void setType( const QString &type );

  /**
   * Returns whether the picture is described by a URL (extern) or
   * by the raw data (intern).
   * When this method returns 'true' you can use @ref data() to
   * get the raw data. Otherwise you can request the URL of this
   * picture by @ref url() and load the raw data from that location.
   */
  bool isIntern() const;

  /**
   * Returns the location URL of this picture.
   */
  QString url() const;

  /**
   * Returns the raw data of this picture.
   */
  QImage data() const;
  QPixmap pixmap() const;
  /**
   * Returns the type of this picture.
   */
  QString type() const;

  /**
   * Returns string representation of the picture.
   */
  QString asString() const;

private:
  QString mUrl;
  QString mType;
  QImage mData;
  bool mUndefined;

  int mIntern;
};

QDataStream &operator<<( QDataStream &, const Picture & );
QDataStream &operator>>( QDataStream &, Picture & );

}
#endif