#include <pxl_pixellive.h>
Public Member Functions | |
| virtual AutoPtr< DocFactory > | getDefaultDocFactory ()=0 |
| virtual AutoPtr< DocFactory > | createDocFactory ()=0 |
| virtual AutoPtr< Doc > | load (Storage *inStorage, CredentialProvider *inCredentialProvider=NULL, HttpManager *inManager=NULL)=0 |
| virtual AutoPtr< Doc > | loadAlternativeDoc (Storage *inStorage)=0 |
| virtual void | enableLzwFunctions (bool inEnable=true)=0 |
| virtual bool | lzwFunctionsEnabled () const =0 |
Static Public Member Functions | |
| static AutoPtr< PixelLiveSystem > | create () |
Definition at line 27 of file pxl_pixellive.h.
| static AutoPtr<PixelLiveSystem> Celartem::PixelLiveSystem::create | ( | ) | [static] |
This function creates new PixelLiveSystem instance.
You should create a PixelLiveSystem instance before using any PixelLive related functions/classes.
| virtual AutoPtr<DocFactory> Celartem::PixelLiveSystem::getDefaultDocFactory | ( | ) | [pure virtual] |
This function returns the default DocFactory instance that can creates Doc instances from Storage instance. Although you can modify the DocFactory instance returned by this function, it is shared by all the functions/classes which are created from same PixelLiveSystem instance. If you don't share DocFactory instance with others, you can create your own DocFactory instance by createDocFactory function.
| virtual AutoPtr<DocFactory> Celartem::PixelLiveSystem::createDocFactory | ( | ) | [pure virtual] |
This function creates a new DocFactory instance that is used to load Doc instances from Storage instance. By default, no loader function is registered to the DocFactory instance.
| virtual AutoPtr<Doc> Celartem::PixelLiveSystem::load | ( | Storage * | inStorage, | |
| CredentialProvider * | inCredentialProvider = NULL, |
|||
| HttpManager * | inManager = NULL | |||
| ) | [pure virtual] |
This function directly load an Doc instance from the specified storage using the default DocFactory instance.
| inStorage | The storage which contains images. | |
| inCredentialProvider | If some authentication process is required to open the file, this instance provides the required credential information for it. For more information, see Open the Image Files that Requires Authentication. | |
| inManager | If the authentication process requires network connection, it should be specified. If no HttpManager instance is specified and the authentication requires network connection, this function create a HttpManager instance automatically. |
| virtual AutoPtr<Doc> Celartem::PixelLiveSystem::loadAlternativeDoc | ( | Storage * | inStorage | ) | [pure virtual] |
This function load an alternative Doc instance from the specified Storage instance if available. The function is usually used with PFZ files (or secure storage files) that contains unprotected information (that can be obtained without authentication).
Currently, only PFZ 2.4 files are supported and if the specified Storage instance does not contain PFZ file, this function throws an exception.
| inStorage | The storage which contains images. |
| virtual void Celartem::PixelLiveSystem::enableLzwFunctions | ( | bool | inEnable = true |
) | [pure virtual] |
This function enables the LZW functions of this library.
This function is provided only for the compatibility with the previous versions of the library.
| inEnable | true to enable, false to disable. |
| virtual bool Celartem::PixelLiveSystem::lzwFunctionsEnabled | ( | ) | const [pure virtual] |
This function returns the current status of the LZW functions.
This function is provided only for the compatibility with the previous versions of the library.
true if LZW functions are enabled, otherwise false.
