Celartem::DjVu::JB2Dictionary Class Reference

#include <djv_jb2decoder.h>

Inheritance diagram for Celartem::DjVu::JB2Dictionary:

Public Member Functions
virtual Shape::Array &	getShapes ()=0
virtual const Shape::Array &	getShapes () const =0
virtual bool	isEmpty () const =0
virtual void	compact ()=0
virtual void	encodeDjbz (Stream *inStream) const =0
virtual AutoPtr< Chunk >	encodeDjbzChunk () const =0
Public Member Functions inherited from Celartem::Referable
	Referable ()
void	addRef () const
void	releaseRef () const
size_t	getReferenceCount () const

Static Public Member Functions
static AutoPtr< JB2Dictionary >	create (Stream *inDjbz)
static AutoPtr< JB2Dictionary >	create (const Chunk *inDjbz)
static AutoPtr< JB2Dictionary >	create ()
Static Public Member Functions inherited from Celartem::Referable
static void	dumpDbgAllRefCount ()

Detailed Description

This class defines JB2 Dictionary class.
A dictionary is referenced by several pages and vital to decode the pages.

Member Function Documentation

virtual void Celartem::DjVu::JB2Dictionary::compact ( )

pure virtual

Minimize the memory usage.

Implements Celartem::DjVu::JB2ShapeStore.

static AutoPtr<JB2Dictionary> Celartem::DjVu::JB2Dictionary::create ( Stream *  inDjbz )

static

Create a JB2Dictionary instance from the specified stream.

Parameters

inDjbz

A stream which contains the Djbz chunk.

Returns

Pointer to newly created JB2Dictionary instance.

static AutoPtr<JB2Dictionary> Celartem::DjVu::JB2Dictionary::create ( const Chunk *  inDjbz )

static

Create a JB2Dictionary instance from the specified chunk.

Parameters

inDjbz

Pointer to the Djbz chunk.

Returns

Pointer to newly created JB2Dictionary instance.

static AutoPtr<JB2Dictionary> Celartem::DjVu::JB2Dictionary::create ( )

static

Create an empty JB2Dictionary instance.

Returns

Pointer to newly created JB2Dictionary instance.

virtual void Celartem::DjVu::JB2Dictionary::encodeDjbz ( Stream *  inStream ) const

pure virtual

Encode dictionary (Djbz) to the specified stream.

Parameters

inStream

A stream to write to.

virtual AutoPtr<Chunk> Celartem::DjVu::JB2Dictionary::encodeDjbzChunk ( ) const

pure virtual

Encode dictionary (Djbz) chunk.

Returns

A newly create Djbz chunk, which contains the encoding result.

virtual Shape::Array& Celartem::DjVu::JB2Dictionary::getShapes ( )

pure virtual

Get the Shape::Array instance used by this instance.

Returns

Reference to the Shape::Array instance.

Implements Celartem::DjVu::JB2ShapeStore.

virtual const Shape::Array& Celartem::DjVu::JB2Dictionary::getShapes ( ) const

pure virtual

Get the Shape::Array instance used by this instance.

Returns

Reference to the Shape::Array instance.

Implements Celartem::DjVu::JB2ShapeStore.

virtual bool Celartem::DjVu::JB2Dictionary::isEmpty ( ) const

pure virtual

Determine whether the dictionary is empty or not.

Returns

true if the dictionary is empty (no shapes); otherwise false.

---

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

• djv_jb2decoder.h