Class to access raw Photoshop images. More...
#include <psdimage.hpp>
Public Member Functions | |
Creators | |
PsdImage (BasicIo::AutoPtr io) | |
Constructor to open a Photoshop image. Since the constructor can not return a result, callers should check the good() method after object construction to determine success or failure. | |
Manipulators | |
| |
void | readMetadata () |
Read all metadata supported by a specific image format from the image. Before this method is called, the image metadata will be cleared. | |
void | writeMetadata () |
Write metadata back to the image. | |
void | setComment (const std::string &comment) |
Not supported. Calling this function will throw an Error(32). | |
Accessors | |
| |
std::string | mimeType () const |
Return the MIME type of the image. |
Class to access raw Photoshop images.
Exiv2::PsdImage::PsdImage | ( | BasicIo::AutoPtr | io | ) |
Constructor to open a Photoshop image. Since the constructor can not return a result, callers should check the good() method after object construction to determine success or failure.
io | An auto-pointer that owns a BasicIo instance used for reading and writing image metadata. Important: The constructor takes ownership of the passed in BasicIo instance through the auto-pointer. Callers should not continue to use the BasicIo instance after it is passed to this method. Use the Image::io() method to get a temporary reference. |
std::string Exiv2::PsdImage::mimeType | ( | ) | const [virtual] |
Return the MIME type of the image.
The MIME type returned for Photoshop images is "image/x-photoshop".
Implements Exiv2::Image.
void Exiv2::PsdImage::readMetadata | ( | ) | [virtual] |
Read all metadata supported by a specific image format from the image. Before this method is called, the image metadata will be cleared.
This method returns success even if no metadata is found in the image. Callers must therefore check the size of individual metadata types before accessing the data.
Error | if opening or reading of the file fails or the image data is not valid (does not look like data of the specific image type). |
Implements Exiv2::Image.
References Exiv2::Image::clearMetadata(), Exiv2::getLong(), Exiv2::getULong(), Exiv2::getUShort(), Exiv2::Image::io_, Exiv2::isPsdType(), Exiv2::Image::pixelHeight_, Exiv2::Image::pixelWidth_, and Exiv2::strError().
void Exiv2::PsdImage::writeMetadata | ( | ) | [virtual] |
Write metadata back to the image.
All existing metadata sections in the image are either created, replaced, or erased. If values for a given metadata type have been assigned, a section for that metadata type will either be created or replaced. If no values have been assigned to a given metadata type, any exists section for that metadata type will be removed from the image.
Error | if the operation fails |
Implements Exiv2::Image.
References Exiv2::Image::io_, and Exiv2::strError().