DjVuAnno Class Reference

This is a top-level class containing annotations of a DjVu document (or just a page). More...

#include <DjVuAnno.h>

Inheritance diagram for DjVuAnno:

[legend]

List of all members.

Public Member Functions
GP< DjVuAnno >	copy (void) const
void	decode (const GP< ByteStream > &bs)
void	encode (const GP< ByteStream > &bs)
unsigned int	get_memory_usage () const
GUTF8String	get_paramtags (void) const
GUTF8String	get_xmlmap (const GUTF8String &name, const int height) const
void	merge (const GP< DjVuAnno > &anno)
void	writeMap (ByteStream &bs, const GUTF8String &name, const int height) const
void	writeParam (ByteStream &out_str) const
Static Public Member Functions
static GP< DjVuAnno >	create (void)
Public Attributes
GP< DjVuANT >	ant
Protected Member Functions
	DjVuAnno (void)

---

Detailed Description

This is a top-level class containing annotations of a DjVu document (or just a page).

It has only two functions: {encode}() and {decode}(). Both of them work with a sequence of annotation chunks from FORM:ANNO# form. Basing on the name of the chunks they call encode()# and decode()# functions of the proper annotation structure (like {ANT}). The real work of encoding and decoding is done by lower-level classes.

Definition at line 235 of file DjVuAnno.h.

---

Constructor & Destructor Documentation

DjVuAnno::DjVuAnno

(

void

)

[inline, protected]

Definition at line 238 of file DjVuAnno.h.

---

Member Function Documentation

GP< DjVuAnno > DjVuAnno::copy

(

void

)

const

Returns a copy of this object.

Definition at line 1485 of file DjVuAnno.cpp.

static GP<DjVuAnno> DjVuAnno::create

(

void

)

[inline, static]

Creation method.

Definition at line 241 of file DjVuAnno.h.

void DjVuAnno::decode

(

const GP< ByteStream > &

bs

)

Decodes a sequence of annotation chunks and merges contents of every chunk with previously decoded information.

This function should be called right after applying {IFFByteStream::get_chunk}() to data from FORM:ANNO#.

Definition at line 1428 of file DjVuAnno.cpp.

void DjVuAnno::encode

(

const GP< ByteStream > &

bs

)

Encodes all annotations back into a sequence of chunks to be put inside a FORM:ANNO#.

Definition at line 1460 of file DjVuAnno.cpp.

unsigned int DjVuAnno::get_memory_usage

(

)

const [inline]

Returns the number of bytes needed by this data structure.

It's used by caching routines to estimate the size of a {DjVuImage}.

Definition at line 282 of file DjVuAnno.h.

GUTF8String DjVuAnno::get_paramtags

(

void

)

const

Obtain the XML flags for the default specifications.

Definition at line 1413 of file DjVuAnno.cpp.

GUTF8String DjVuAnno::get_xmlmap	(	const GUTF8String &	name,
		const int	height
	)			const

Obtain the <MAP></MAP> tag for these annotations.

Definition at line 1393 of file DjVuAnno.cpp.

void DjVuAnno::merge

(

const GP< DjVuAnno > &

anno

)

Merged the contents of this class and of annotations pointed by anno# pointer.

Definition at line 1496 of file DjVuAnno.cpp.

void DjVuAnno::writeMap	(	ByteStream &	bs,
		const GUTF8String &	name,
		const int	height
	)			const

Write the <MAP></MAP> tag for these annotations.

Definition at line 1401 of file DjVuAnno.cpp.

void DjVuAnno::writeParam

(

ByteStream &

out_str

)

const

Write the XML flags for the default specifications.

Definition at line 1421 of file DjVuAnno.cpp.

---

Member Data Documentation

GP<DjVuANT> DjVuAnno::ant

Definition at line 243 of file DjVuAnno.h.

---

The documentation for this class was generated from the following files:

• DjVuAnno.h
• DjVuAnno.cpp