#include <pxl_imagedoc.h>
Public Member Functions | |
| virtual size_t | getWidth () const =0 |
| virtual size_t | getHeight () const =0 |
| virtual Photometric | getPhotometric () const =0 |
| virtual AutoPtr< Doc > | getNext () const =0 |
| virtual AutoPtr< Doc > | getChild (size_t inIndex) const =0 |
| virtual size_t | getChildCount () const =0 |
| virtual AutoPtr< const DataStore > | getMetadata () const =0 |
| virtual AutoPtr< Image > | createImage (size_t inBytesAvailable=(size_t)-1)=0 |
| virtual String | getLocation () const =0 |
| virtual String | getFileType () const =0 |
Static Public Member Functions | |
| static AutoPtr< Doc > | createFakeDoc (const Image *inImage) |
// This code creates a Doc instance directly from PixelLiveSystem // instance. // AutoPtr<PixelLiveSystem> sys = PixelLiveSystem::create(); AutoPtr<Doc> doc = sys->load(storage);
You can access to the multiple images (multiple pages or multiple resolution) in a file, see Supporting Multiple Images in a File.
A Doc instance also manages metadata and you can access to them using Doc::getMetadata function or Image::getMetadata function. For more detail information of how to handle metadata, see Metadata Handling.
Definition at line 45 of file pxl_imagedoc.h.
| virtual size_t Celartem::Doc::getWidth | ( | ) | const [pure virtual] |
This function returns the width of the primary image in the Doc instance. It may differ from the width obtained by Image::getWidth function when the Doc instance manages some image format that can preserve images of the multiple resoultion.
| virtual size_t Celartem::Doc::getHeight | ( | ) | const [pure virtual] |
This function returns the height of the primary image in the Doc instance. It may differ from the height obtained by Image::getWidth function when the Doc instance manages some image format that can preserve images of the multiple resoultion.
| virtual Photometric Celartem::Doc::getPhotometric | ( | ) | const [pure virtual] |
This function returns the Photometric of the primary image in the Doc instance.
This function returns the next Doc instance if available.
For supporting multiple images in a file, see Supporting Multiple Images in a File.
This function returns the child instance of the specified index if available.
For supporting multiple images in a file, see Supporting Multiple Images in a File.
| virtual size_t Celartem::Doc::getChildCount | ( | ) | const [pure virtual] |
This function returns the number of the child Doc instances.
For supporting multiple images in a file, see Supporting Multiple Images in a File.
This function returns the metadata associated to this Doc instance. The metdata returned by this function is only for read purpose and you could not modify them. You can also get a changable copy of the metadata by Image::getMetadata function.
For more information about metadata handling, see Metadata Handling.
| virtual AutoPtr<Image> Celartem::Doc::createImage | ( | size_t | inBytesAvailable = (size_t)-1 |
) | [pure virtual] |
This function creates an Image instance from the primary image in this Doc instance.
| inBytesAvailable | The memory that can be assigned to the Image instance. Please note that some Image types do not support this parameter. |
| virtual String Celartem::Doc::getLocation | ( | ) | const [pure virtual] |
This function returns the location. The location is file path or URI that indicates the actual location of the resource.
| virtual String Celartem::Doc::getFileType | ( | ) | const [pure virtual] |
This function returns the type of the file format in String. For details, see the table shown below.
| File Format | String returned |
|---|---|
| MrSID | "MrSID" |
| JPEG 2000 | "JPEG2000" |
| VFZ | "VFZ" |
| PFZ | "PFZ" |
| TIFF | "TIFF" |
| JPEG | "JPEG" |
| PNG | "PNG" |
| Windows Bitmap | "Windows Bitmap" |
