KExiv2
kexiv2.h
55 /** The image metadata writing mode, between image file metadata and XMP sidecar file, depending on the context.
190 * If image file path do not include a file name or is empty, this function return a null string.
224 /** Load all metadata (Exif, Iptc, Xmp, and JFIF Comments) from a picture (JPEG, RAW, TIFF, PNG,
327 /** Return the image orientation set in Exif metadata. The makernotes of image are also parsed to
337 /** Return the image color-space set in Exif metadata. The makernotes of image are also parsed to
352 /** Set the Exif and Iptc time stamp. If 'setDateTimeDigitized' parameter is true, the 'Digitalized'
358 /** Return the digitization time stamp of the image. First Exif information is checked, then IPTC.
477 /** Adds a JPEG thumbnail to a TIFF images. Use this instead of setExifThumbnail for TIFF images. */
485 /** Set the Exif user comments from image. Look Exif specification for more details about this tag.
497 bool setExifTagString(const char* exifTagName, const QString& value, bool setProgramName=true) const;
515 bool getExifTagRational(const char* exifTagName, long int& num, long int& den, int component=0) const;
521 bool setExifTagRational(const char* exifTagName, long int num, long int den, bool setProgramName=true) const;
530 bool setExifTagData(const char* exifTagName, const QByteArray& data, bool setProgramName=true) const;
536 Rationals will be returned as QVariant::List with two integer QVariants (numerator, denominator)
538 An exif tag of numerical type may contain more than one value; set component to the desired index.
540 QVariant getExifTagVariant(const char* exifTagName, bool rationalAsListOfInts=true, bool escapeCR=true, int component=0) const;
545 For the meaning of rationalWantSmallDenominator, see the documentation of the convertToRational methods.
564 /** Takes a QVariant value as it could have been retrieved by getExifTagVariant with the given exifTagName,
569 QString createExifUserStringFromValue(const char* exifTagName, const QVariant& val, bool escapeCR=true);
591 KExiv2::MetaDataMap getExifTagsDataList(const QStringList& exifKeysFilter=QStringList(), bool invertSelection=false) const;
633 bool setIptcTagString(const char* iptcTagName, const QString& value, bool setProgramName=true) const;
635 /** Returns a strings list with of multiple Iptc tags from the image. Return an empty list if no tag is found. */
658 bool setIptcTagData(const char* iptcTagName, const QByteArray& data, bool setProgramName=true) const;
691 KExiv2::MetaDataMap getIptcTagsDataList(const QStringList& iptcKeysFilter=QStringList(), bool invertSelection=false) const;
693 /** Return a strings list of Iptc keywords from image. Return an empty list if no keyword are set.
697 /** Set Iptc keywords using a list of strings defined by 'newKeywords' parameter. Use 'getImageKeywords()'
698 method to set 'oldKeywords' parameter with existing keywords from image. The method will compare
699 all new keywords with all old keywords to prevent duplicate entries in image. Return true if keywords
705 /** Return a strings list of Iptc subjects from image. Return an empty list if no subject are set.
709 /** Set Iptc subjects using a list of strings defined by 'newSubjects' parameter. Use 'getImageSubjects()'
710 method to set 'oldSubjects' parameter with existing subjects from image. The method will compare
711 all new subjects with all old subjects to prevent duplicate entries in image. Return true if subjects
717 /** Return a strings list of Iptc sub-categories from image. Return an empty list if no sub-category
722 /** Set Iptc sub-categories using a list of strings defined by 'newSubCategories' parameter. Use
723 'getImageSubCategories()' method to set 'oldSubCategories' parameter with existing sub-categories
724 from image. The method will compare all new sub-categories with all old sub-categories to prevent
727 bool setIptcSubCategories(const QStringList& oldSubCategories, const QStringList& newSubCategories,
805 KExiv2::MetaDataMap getXmpTagsDataList(const QStringList& xmpKeysFilter=QStringList(), bool invertSelection=false) const;
812 KExiv2::AltLangMap getXmpTagStringListLangAlt(const char* xmpTagName, bool escapeCR=true) const;
826 QString getXmpTagStringLangAlt(const char* xmpTagName, const QString& langAlt, bool escapeCR) const;
828 /** Set a Xmp tag content using a string with an alternative language header. 'langAlt' contain the
836 /** Get a Xmp tag content like a sequence of strings. If 'escapeCR' parameter is true, the CR characters
847 /** Get a Xmp tag content like a bag of strings. If 'escapeCR' parameter is true, the CR characters
866 /** Remove those Xmp tag entries that are listed in entriesToRemove from the entries in metadata.
877 Rationals will be returned as QVariant::List with two integer QVariants (numerator, denominator)
883 QVariant getXmpTagVariant(const char* xmpTagName, bool rationalAsListOfInts=true, bool stringEscapeCR=true) const;
885 /** Return a strings list of Xmp keywords from image. Return an empty list if no keyword are set.
896 /** Remove those Xmp keywords that are listed in keywordsToRemove from the keywords in metadata.
901 /** Return a strings list of Xmp subjects from image. Return an empty list if no subject are set.
912 /** Remove those Xmp subjects that are listed in subjectsToRemove from the subjects in metadata.
917 /** Return a strings list of Xmp sub-categories from image. Return an empty list if no sub-category
924 all new sub-categories with all already existing sub-categories to prevent duplicate entries in image.
929 /** Remove those Xmp sub-categories that are listed in categoriesToRemove from the sub-categories in metadata.
966 as described in the XMP specification. Returns a null string in the information cannot be found.
971 /** Get GPS location information set in the image, as a double floating point number as in degrees
978 /** Get GPS altitude information, in meters, relative to sea level (positive sign above sea level)
985 bool setGPSInfo(const double altitude, const double latitude, const double longitude, const bool setProgramName=true);
990 bool setGPSInfo(const double* const altitude, const double latitude, const double longitude, const bool setProgramName=true);
995 bool setGPSInfo(const double altitude, const QString &latitude, const QString &longitude, const bool setProgramName=true);
997 /** Remove all Exif tags relevant of GPS location information. Return true if all tags have been
1023 static QString convertToGPSCoordinateString(const long int numeratorDegrees, const long int denominatorDegrees,
1028 /** Converts a GPS position stored as double floating point number in degrees to the form described
1033 /** Converts a GPSCoordinate string as defined by XMP to three rationals and the direction reference.
1035 If minutes is given in the fractional form, a denominator of 1000000 for the minutes will be used.
1043 /** Convert a GPSCoordinate string as defined by XMP to a double floating point number in degrees
1047 static bool convertFromGPSCoordinateString(const QString& gpsString, double* const coordinate);
1049 /** Converts a GPSCoordinate string to user presentable numbers, integer degrees and minutes and
1056 /** Converts a double floating point number to user presentable numbers, integer degrees and minutes and
QMap< QString, QString > AltLangMap
A map used to store a list of Alternative Language values.
Definition kexiv2.h:118
MetadataWritingMode
The image metadata writing mode, between image file metadata and XMP sidecar file,...
Definition kexiv2.h:59
QMap< QString, QStringList > TagsMap
A map used to store Tags Key and a list of Tags properties :
Definition kexiv2.h:125
QMap< QString, QString > MetaDataMap
A map used to store Tags Key and Tags Value.
Definition kexiv2.h:112
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 17:03:27 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 17:03:27 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.