pdftron::PDF::Struct::STree Class Reference

STree is the root of the structure tree, which is a central repository for information related to a PDF document's logical structure. More...

#include <STree.h>

List of all members.

Public Member Functions
	STree (SDF::Obj struct_dict)
	Initialize a STree using an existing low-leval Cos/SDF object.
	STree (const STree &)
STree &	operator= (const STree &)
bool	IsValid () const
	Returns: true if this is a valid STree object, false otherwise.
int	GetNumKids ()
	Returns: The number of kids of the structure tree root.
class SElement	GetKid (int index)
	Returns: The kid at an array index in the structure tree root.
class SElement	GetElement (const char *id_buf, int id_buf_sz)
	Returns: the element associated with the given ID.
RoleMap	GetRoleMap () const
	Returns: the RoleMap object from the structure tree root.
class ClassMap	GetClassMap () const
	Returns: the ClassMap object from the structure tree root.
SDF::Obj	GetSDFObj () const
	Returns: Pointer to the underlying SDF/Cos object.

---

Detailed Description

STree is the root of the structure tree, which is a central repository for information related to a PDF document's logical structure.

There is at most one structure tree in each document.

---

Constructor & Destructor Documentation

pdftron::PDF::Struct::STree::STree

(

SDF::Obj

struct_dict

)

Initialize a STree using an existing low-leval Cos/SDF object.

Parameters:

struct_dict

- a low-level (SDF/Cos) dictionary representing the .

Note:

This constructor does not copy any data, but is instead the logical equivalent of a type cast.

pdftron::PDF::Struct::STree::STree

(

const STree &

)

---

Member Function Documentation

STree& pdftron::PDF::Struct::STree::operator=

(

const STree &

)

bool pdftron::PDF::Struct::STree::IsValid

(

)

const

Returns:

true if this is a valid STree object, false otherwise.

int pdftron::PDF::Struct::STree::GetNumKids

(

)

Returns:

The number of kids of the structure tree root.

class SElement pdftron::PDF::Struct::STree::GetKid

(

int

index

)

Returns:

The kid at an array index in the structure tree root.

Parameters:

index

The index of the kid to obtain.

class SElement pdftron::PDF::Struct::STree::GetElement	(	const char *	id_buf,
		int	id_buf_sz
	)

Returns:

the element associated with the given ID.

Parameters:

	id_buf	A pointer to a buffer containing the ID to search for.
	id_buf_sz	The number of characters in id_buf.

RoleMap pdftron::PDF::Struct::STree::GetRoleMap

(

)

const

Returns:

the RoleMap object from the structure tree root.

class ClassMap pdftron::PDF::Struct::STree::GetClassMap

(

)

const

Returns:

the ClassMap object from the structure tree root.

SDF::Obj pdftron::PDF::Struct::STree::GetSDFObj

(

)

const

Returns:

Pointer to the underlying SDF/Cos object.

---

© 2002-2008 PDFTron Systems Inc.