| Exiv2

Loading...
Searching...
No Matches
gifimage.hpp
1// SPDX-License-Identifier: GPL-2.0-or-later
2
3#ifndef GIFIMAGE_HPP_
4#define GIFIMAGE_HPP_
5
6// *****************************************************************************
7#include "exiv2lib_export.h"
8
9// included header files
10#include "image.hpp"
11
12// *****************************************************************************
13// namespace extensions
14 namespace Exiv2 {
15// *****************************************************************************
16// class definitions
17
22 class EXIV2API GifImage : public Image {
23 public:
25
26
38 explicit GifImage(BasicIo::UniquePtr io);
40
42
43 void readMetadata() override;
48 void writeMetadata() override;
53 void setExifData(const ExifData& exifData) override;
58 void setIptcData(const IptcData& iptcData) override;
63 void setComment(const std::string&) override;
65
67
68 [[nodiscard]] std::string mimeType() const override;
70
71}; // class GifImage
72
73// *****************************************************************************
74// template, inline and free functions
75
76// These could be static private functions on Image subclasses but then
77// ImageFactory needs to be made a friend.
83EXIV2API Image::UniquePtr newGifInstance(BasicIo::UniquePtr io, bool create);
84
86EXIV2API bool isGifType(BasicIo& iIo, bool advance);
87
88} // namespace Exiv2
89
90#endif // #ifndef GIFIMAGE_HPP_
Exiv2::BasicIo
An interface for simple binary IO.
Definition basicio.hpp:35
Exiv2::BasicIo::UniquePtr
std::unique_ptr< BasicIo > UniquePtr
BasicIo auto_ptr type.
Definition basicio.hpp:38
Exiv2::ExifData
A container for Exif data. This is a top-level class of the Exiv2 library. The container holds Exifda...
Definition exif.hpp:379
Exiv2::GifImage::setIptcData
void setIptcData(const IptcData &iptcData) override
Todo: Not supported yet(?). Calling this function will throw an instance of Error(ErrorCode::kerInval...
Definition gifimage.cpp:27
Exiv2::GifImage::readMetadata
void readMetadata() override
Read all metadata supported by a specific image format from the image. Before this method is called,...
Definition gifimage.cpp:37
Exiv2::GifImage::mimeType
std::string mimeType() const override
Return the MIME type of the image.
Definition gifimage.cpp:18
Exiv2::GifImage::setComment
void setComment(const std::string &) override
Not supported. Calling this function will throw an instance of Error(ErrorCode::kerInvalidSettingForI...
Definition gifimage.cpp:32
Exiv2::GifImage::setExifData
void setExifData(const ExifData &exifData) override
Todo: Not supported yet(?). Calling this function will throw an instance of Error(ErrorCode::kerInval...
Definition gifimage.cpp:22
Exiv2::GifImage::writeMetadata
void writeMetadata() override
Todo: Write metadata back to the image. This method is not yet(?) implemented. Calling it will throw ...
Definition gifimage.cpp:60
Exiv2::GifImage::GifImage
GifImage(BasicIo::UniquePtr io)
Constructor to open a GIF image. Since the constructor can not return a result, callers should check ...
Definition gifimage.cpp:15
Exiv2::Image::Image
Image(ImageType type, uint16_t supportedMetadata, BasicIo::UniquePtr io)
Constructor taking the image type, a bitmap of the supported metadata types and an auto-pointer that ...
Definition image.cpp:132
Exiv2::Image::io
virtual BasicIo & io() const
Return a reference to the BasicIo instance being used for Io.
Definition image.cpp:696
Exiv2::Image::iptcData
virtual IptcData & iptcData()
Returns an IptcData instance containing currently buffered IPTC data.
Definition image.cpp:536
Exiv2::Image::exifData
virtual ExifData & exifData()
Returns an ExifData instance containing currently buffered Exif data.
Definition image.cpp:532
Exiv2::Image::UniquePtr
std::unique_ptr< Image > UniquePtr
Image auto_ptr type.
Definition image.hpp:53
Exiv2::IptcData
A container for IPTC data. This is a top-level class of the Exiv2 library.
Definition iptc.hpp:153
Exiv2
Class CrwImage to access Canon CRW images. References: The Canon RAW (CRW) File Format by Phil Harv...
Definition asfvideo.hpp:15
Exiv2::isGifType
EXIV2API bool isGifType(BasicIo &iIo, bool advance)
Check if the file iIo is a GIF image.
Definition gifimage.cpp:75
Exiv2::newGifInstance
EXIV2API Image::UniquePtr newGifInstance(BasicIo::UniquePtr io, bool create)
Create a new GifImage instance and return an auto-pointer to it. Caller owns the returned object and ...
Definition gifimage.cpp:67