Celartem::DjVu::Bookmark Class Reference

#include <djv_bookmark.h>

Inheritance diagram for Celartem::DjVu::Bookmark:

List of all members.

Public Types
typedef SimpleArray< AutoPtr < Bookmark > >	Array
Public Member Functions
virtual void	encode (Stream *inStream) const =0
virtual AutoPtr< Chunk >	encodeNAVMChunk () const =0
Static Public Member Functions
static AutoPtr< Bookmark >	create (const String &inText=NullString, const Link &inLink=NullString)
static AutoPtr< Bookmark >	decode (Stream *inStream)
static AutoPtr< Bookmark >	decode (const Chunk *inChunk)
Public Attributes
Array	children
String	text
	Text shown in the outline pane.
Link	link
	Link to another resource.

---

Detailed Description

This structure retains information about a bookmark entry.

---

Member Typedef Documentation

typedef SimpleArray< AutoPtr<Bookmark> > Celartem::DjVu::Bookmark::Array

Definition for the array of Bookmark.

---

Member Function Documentation

static AutoPtr<Bookmark> Celartem::DjVu::Bookmark::create	(	const String &	inText = NullString,
		const Link &	inLink = NullString
	)			[static]

Creates an instance.

Parameters:

	inText	Text shown in the outline pane.
	inLink	Link to a resource.

static AutoPtr<Bookmark> Celartem::DjVu::Bookmark::decode

(

Stream *

inStream

)

[static]

Creates an instance by decoding NAVM chunk.

Parameters:

inStream

Stream which contains the data to load.

static AutoPtr<Bookmark> Celartem::DjVu::Bookmark::decode

(

const Chunk *

inChunk

)

[static]

Creates an instance by decoding NAVM chunk.

Parameters:

inChunk

Chunk which contains the data to load.

virtual void Celartem::DjVu::Bookmark::encode

(

Stream *

inStream

)

const [pure virtual]

Encodes the instance to the DjVu's NAVM chunk. This method is for advanced purpose and for normal purpose, you had better use encodeNAVMChunk.

Parameters:

inStream

The stream to write on.

virtual AutoPtr<Chunk> Celartem::DjVu::Bookmark::encodeNAVMChunk

(

)

const [pure virtual]

Encodes the instance to the DjVu's NAVM chunk.

Returns:

NAVM Chunk.

---

Member Data Documentation

Array Celartem::DjVu::Bookmark::children

The child elements if exist.

Link Celartem::DjVu::Bookmark::link

Link to another resource.

String Celartem::DjVu::Bookmark::text

Text shown in the outline pane.

---

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

• djv_bookmark.h