/usr/include/KF5/KIPI/kipi/imageinfo.h is in libkf5kipi-dev 4:16.08.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 | /** ===========================================================
* @file
*
* This file is a part of digiKam project
* <a href="http://www.digikam.org">http://www.digikam.org</a>
*
* @date 2004-07-22
* @brief image info
*
* @author Copyright (C) 2004-2016 by Gilles Caulier
* <a href="mailto:caulier dot gilles at gmail dot com">caulier dot gilles at gmail dot com</a>
* @author Copyright (C) 2004-2005 by Renchi Raju
* <a href="mailto:renchi dot raju at gmail dot com">renchi dot raju at gmail dot com</a>
* @author Copyright (C) 2004-2005 by Jesper K. Pedersen
* <a href="mailto:blackie at kde dot org">blackie at kde dot org</a>
* @author Copyright (C) 2004-2005 by Aurelien Gateau
* <a href="mailto:aurelien dot gateau at free dot fr">aurelien dot gateau at free dot fr</a>
*
* This program is free software; you can redistribute it
* and/or modify it under the terms of the GNU General
* Public License as published by the Free Software Foundation;
* either version 2, or (at your option)
* any later version.
*
* This program 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 General Public License for more details.
*
* ============================================================ */
#ifndef KIPI_IMAGEINFO_H
#define KIPI_IMAGEINFO_H
// Qt includes
#include <QtCore/QString>
#include <QtCore/QDateTime>
#include <QtCore/QMap>
#include <QtCore/QVariant>
#include <QtCore/QUrl>
// Local includes
#include "libkipi_export.h"
namespace KIPI
{
class ImageInfoShared;
/** @class ImageInfo
Holds info about an image from KIPI host application.
NOTE: If you want to manage item properties from kipi-plugins, use wrapper class KIPIPlugins::KPImageInfo,
not this class directly. See kipi-plugins/common/libkipi-plugins API for details.
IMPORTANT: this class must re-implemented in KIPI host application through KIPI::ImageInfoShared. This implementation
must be thread-safe, due to possible use into kipi plugins separated thread implementation in the future.
*/
class LIBKIPI_EXPORT ImageInfo
{
public:
/** Constructor and interface for host application.
*/
ImageInfo(ImageInfoShared* const);
ImageInfo(const ImageInfo&);
~ImageInfo();
/**
Returns a Map of attributes of the image.
In case the host application supports some special attributes of the image,
this function can be used to return them. Following attributes are supported:
<table><tr>
<th>ATTRIBUTES</th>
<th>VALUE RETURNED</th>
<th>COMMENTS</th>
</tr><tr>
<th>"name"</th>
<td>QString</td>
<td>Returns name of item (usually file name).</td>
</tr><tr>
<th>"comment"</th>
<td>QString</td>
<td>Returns default item comment.</td>
</tr><tr>
<th>"date"</th>
<td>QDateTime</td>
<td>Returns date of item (usually the creation date). In the case the application supports date ranges (like this image is from 1998-2000), this attribute always return the start of date range.</td>
</tr><tr>
<th>"dateto"</th>
<td>QDateTime</td>
<td>In the case the application supports date ranges (like this image is from 1998-2000), this attribute returns the end of date range.</td>
</tr><tr>
<th>"isexactdate"</th>
<td>bool value</td>
<td>In the case the application supports date ranges (like this image is from 1998-2000), this attribute returns true if the date is an exact specification, and thus not a range.</td>
</tr><tr>
<th>"orientation"</th>
<td>integer value</td>
<td>Returns orientation information. See ExifOrientation values for details).</td>
</tr><tr>
<th>"title"</th>
<td>QString</td>
<td>Returns default item title.</td>
</tr><tr>
<th>"rating"</th>
<td>integer value</td>
<td>Returns item starts 0 <= rate <= 5).</td>
</tr><tr>
<th>"colorlabel"</th>
<td>integer value</td>
<td>Return item color flag 0 <= colorlabel <= 10.</td>
</tr><tr>
<th>"picklabel"</th>
<td>integer value</td>
<td>Return item workflow flag 0 <= picklabel <= 4.</td>
</tr><tr>
<th>"latitude"</th>
<td>double value</td>
<td>Return item latitude in degrees (-90.0 >= lat <=90.0).</td>
</tr><tr>
<th>"longitude"</th>
<td>double value</td>
<td>Return item longitude in degrees (-180.0 >= long <=180.0).</td>
</tr><tr>
<th>"altitude"</th>
<td>double value</td>
<td>Return item altitude in meters.</td>
</tr><tr>
<th>"tagspath"</th>
<td>QStringList</td>
<td>Return all tags path list of item, formated as "Country/France/City/Paris" for ex.</td>
</tr><tr>
<th>"keywords"</th>
<td>QStringList</td>
<td>Return all tags name list (without path).</td>
</tr><tr>
<th>"filesize"</th>
<td>qlonglong value</td>
<td>Return item file size in bytes.</td>
</tr><tr>
<th>"creators"</th>
<td>QStringList</td>
<td>Return creators list of item.</td>
</tr><tr>
<th>"credit"</th>
<td>QString</td>
<td>Return credit of item.</td>
</tr><tr>
<th>"rights"</th>
<td>QString</td>
<td>Return rights of item.</td>
</tr><tr>
<th>"source"</th>
<td>QString</td>
<td>Return source of item.</td>
</tr><tr>
<th>"tags"</th>
<td>QStringList</td>
<td>For compatibility. DEPRECATED and replaced by "keywords" attribute.</td>
</tr><tr>
<th>"angle"</th>
<td>integer value</td>
<td>For compatibility. DEPRECATED and replaced by "orientation" attribute.</td>
</tr></table>
*/
QMap<QString, QVariant> attributes() const;
/** Set the attributes defined from the map to the image. Following keys/values are the same the attributes(),
* excepted "keywords", "filesize", and "isexactdate" properties which are read-only values.
*/
void addAttributes(const QMap<QString, QVariant>&);
/** Remove attributes listed from the image. Following values can be used:
<table><tr>
<th>ATTRIBUTES</th>
<th>COMMENTS</th>
</tr><tr>
<th>"comment"</th>
<td>Remove all comments.</td>
</tr><tr>
<th>"date"</th>
<td>Remove date info.</td>
</tr><tr>
<th>"orientation"</th>
<td>Remove orientation info.</td>
</tr><tr>
<th>"title"</th>
<td>Remove all titles.</td>
</tr><tr>
<th>"rating"</th>
<td>Remove rating info.</td>
</tr><tr>
<th>"colorlabel"</th>
<td>Remove color labels info.</td>
</tr><tr>
<th>"picklabel"</th>
<td>Remove pick labels info.</td>
</tr><tr>
<th>"gpslocation"</th>
<td>Return item altitude in meters.</td>
</tr><tr>
<th>"tagspath"</th>
<td>Remove all tags path.</td>
</tr><tr>
<th>"copyrights"</th>
<td>Remove all copyrights info.</td>
</tr><tr>
<th>"tags"</th>
<td>For compatibility. DEPRECATED and replaced by "keywords" attribute.</td>
</tr><tr>
<th>"angle"</th>
<td>For compatibility. DEPRECATED and replaced by "orientation" attribute.</td>
</tr></table>
*/
void delAttributes(const QStringList&);
/** Remove all attribute from the image. See delAttributes() for list of all attributes removed.
*/
void clearAttributes();
/** Copies all the attributes from the other imageinfo.
*/
void cloneData(const ImageInfo& other);
/** Return item url.
*/
QUrl url() const;
private:
ImageInfo(); /// Disable
ImageInfo& operator=(const ImageInfo&); /// Disable
private:
mutable ImageInfoShared* d;
};
} // namespace KIPI
#endif /* KIPI_IMAGEINFO_H */
|