#include <djv_xml.h>

Public Types
enum	DeserializationFlags

enum	SerializationFlags { xsf_DjVuSatellites = 1, xsf_XmlSatellites = 2, xsf_IndexOnly = 4, xsf_DontResolveINCLs = 8 }

Static Public Member Functions
static AutoPtr< Chunk >	deserialize (Storage inStorage, ResourceBroker inBroker=NULL, u32 inFlags=0)

static void	serialize (Storage inStorage, const Chunk inChunkToSerialize, StorageLocator *inStorageLocator=NULL, u32 inFlags=0)

Detailed Description

This struct provides the functions to access XML structured DjVu files.

Member Enumeration Documentation

enum Celartem::DjVu::XML::DeserializationFlags

Flags to control the behavior of deserialize method.

enum Celartem::DjVu::XML::SerializationFlags

Flags to control the behavior of serialize method.

Enumerator
xsf_DjVuSatellites	Pages/resources as satellite DjVu files. The output is like indirect index DjVu files. All the pages/resources are placed around the index file. It cannot be combined with xsf_XmlSatellites or xsf_NoSatellites.
xsf_XmlSatellites	Pages/resources as satellite XML files. The output is like indirect index DjVu files but all in XML file. All the pages/resources are placed around the index file. It cannot be combined with xsf_DjVuSatellites or xsf_NoSatellites.
xsf_IndexOnly	Don't generate page/resource files. Don't generate any actual satellite files; this is useful when only generating indirect index XML. This option can be combined with xsf_DjVuSatellites or xsf_XmlSatellites to specify satellite format.
xsf_DontResolveINCLs	Reserved.

Member Function Documentation

static AutoPtr<Chunk> Celartem::DjVu::XML::deserialize	(	Storage *	inStorage,
		ResourceBroker *	inBroker = `NULL`,
		u32	inFlags = `0`
	)

static

Deserialize a Chunk which contains DjVu document from a XML structured DjVu file.

Parameters

inStorage	A Storage instance which contains DjVu document.
inBroker	An optional parameter which specifies a ResourceBroker instance to locate any satellite files.
inFlags	Reserved. Must be 0.

Returns: Pointer to newly created Chunk instance.

static void Celartem::DjVu::XML::serialize	(	Storage *	inStorage,
		const Chunk *	inChunkToSerialize,
		StorageLocator *	inStorageLocator = `NULL`,
		u32	inFlags = `0`
	)

static

Serialize a Chunk which contains DjVu document to a XML structured DjVu file.
If you want to overwrite the original file (A.K.A. Save As), you had better call preload method of the chunk to be serialized.

Parameters

inStorage	A Storage instance to serialize to.
inChunkToSerialize	A Chunk instance to be serialized.
inStorageLocator	Pointer to a StorageLocator instance which is used when create Storage instance for satellite files. It can be `NULL` if you want to use StorageLocator instance initialized with the index name which is returned by inStorage->getStorageId().
inFlags	Controls the way to deserialize the actual content. This should be a valid combination of SerializationFlags enumeration values.

The documentation for this struct was generated from the following file:

djv_xml.h

Public Types

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation