Celartem::DjVu::XML Struct Reference

#include <djv_xml.h>

List of all members.

Static Public Member Functions
static AutoPtr< Chunk >	deserialize (Storage *inStorage, ResourceBroker *inBroker=NULL)
static void	serialize (Storage *inStorage, const Chunk *inChunkToSerialize, bool inSideBySideLayout=false)

---

Detailed Description

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

---

Member Function Documentation

static AutoPtr<Chunk> Celartem::DjVu::XML::deserialize	(	Storage *	inStorage,
		ResourceBroker *	inBroker = NULL
	)			[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.

Returns:

Pointer to newly created Chunk instance.

static void Celartem::DjVu::XML::serialize	(	Storage *	inStorage,
		const Chunk *	inChunkToSerialize,
		bool	inSideBySideLayout = false
	)			[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.
	inSideBySideLayout	Determines whether the binary data in the DjVu is in the output XML file or not. If ture, the output XML file only referes files beside the XML file; otherwise (false), the binaries are inside the XML file and encoded using BASE64.

---

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

• djv_xml.h