pdftron::PDF::Struct::ContentItem Class Reference

Content items are graphical objects that exist in the document independently of the structure tree but are associated with structure elements. More...

#include <ContentItem.h>

List of all members.

Public Types

enum  Type { e_MCR, e_MCID, e_OBJR, e_Unknown }

Public Member Functions

 ContentItem (const ContentItem &)
 Copy constructor and assignment operator.
ContentItemoperator= (const ContentItem &)
Type GetType () const
class SElement GetParent ()
 Find the parent structure element.
Page GetPage ()
 The page on which the marked content is drawn, whether directly as part of page content or indirectly by being in a Form XObject or annotation drawn on that page.
SDF::Obj GetSDFObj () const
int GetMCID () const
SDF::Obj GetContainingStm () const
SDF::Obj GetStmOwner () const
SDF::Obj GetRefObj () const


Detailed Description

Content items are graphical objects that exist in the document independently of the structure tree but are associated with structure elements.

Content items are leaf nodes of the structure tree.


Member Enumeration Documentation

Enumerator:
e_MCR  marked-content reference.
e_MCID  marked-content identifier.
e_OBJR  object reference dictionary.
e_Unknown  unknown content type.


Constructor & Destructor Documentation

pdftron::PDF::Struct::ContentItem::ContentItem ( const ContentItem  ) 

Copy constructor and assignment operator.


Member Function Documentation

ContentItem& pdftron::PDF::Struct::ContentItem::operator= ( const ContentItem  ) 

Type pdftron::PDF::Struct::ContentItem::GetType (  )  const

Returns:
the content item type.

class SElement pdftron::PDF::Struct::ContentItem::GetParent (  ) 

Find the parent structure element.

Page pdftron::PDF::Struct::ContentItem::GetPage (  ) 

The page on which the marked content is drawn, whether directly as part of page content or indirectly by being in a Form XObject or annotation drawn on that page.

SDF::Obj pdftron::PDF::Struct::ContentItem::GetSDFObj (  )  const

Returns:
Pointer to the underlying SDF/Cos object.

int pdftron::PDF::Struct::ContentItem::GetMCID (  )  const

Returns:
mcid (marked-content identifier).
Note:
this method only applies to content items with types e_MCR or e_MCID.

SDF::Obj pdftron::PDF::Struct::ContentItem::GetContainingStm (  )  const

Returns:
The stream object that contains the marked-content sequence. The function will return a non-NULL object only if the marked-content sequence resides in a content stream other than the content stream for the page (e.g. in a form XObject).
Note:
this method only applies to content items with type e_MCR.

SDF::Obj pdftron::PDF::Struct::ContentItem::GetStmOwner (  )  const

Returns:
NULL or the PDF object owning the stream returned by GetContainingStm() (e.g. the annotation to which an appearance stream belongs).
Note:
this method only applies to content items with type e_MCR.

SDF::Obj pdftron::PDF::Struct::ContentItem::GetRefObj (  )  const

Returns:
The referenced object.
Note:
this method only applies to content items with type e_OBJR.


© 2002-2010 PDFTron Systems Inc.