pdftron::PDF::Annots::RubberStamp Class Reference

A RubberStamp annotation displays text or graphics intended to look as if they were stamped on the page with a rubber stamp. More...

#include <RubberStamp.h>

Inheritance diagram for pdftron::PDF::Annots::RubberStamp:

Inheritance graph
[legend]
Collaboration diagram for pdftron::PDF::Annots::RubberStamp:

Collaboration graph
[legend]

List of all members.

Public Types

enum  Icon {
  e_Approved, e_Experimental, e_NotApproved, e_AsIs,
  e_Expired, e_NotForPublicRelease, e_Confidential, e_Final,
  e_Sold, e_Departmental, e_ForComment, e_TopSecret,
  e_ForPublicRelease, e_Draft, e_Unknown
}
 This enum represents the Icon type of the RubberStamp annotation. More...

Public Member Functions

 RubberStamp (SDF::Obj d=0)
 Creates a RubberStamp annotation and initializes it using given Cos/SDF object.
 RubberStamp (const Annot &ann)
 Creates a RubberStamp annotation and initializes it using given annotation object.
Icon GetIcon () const
 Returns the type of the icon associated with the RubberStamp annotation.
void SetIcon (Icon type=e_Draft)
 Sets the type of the icon associated with the RubberStamp annotation.
const char * GetIconName () const
 Returns the name of the icon associated with the RubberStamp annotation.
void SetIcon (const char *icon)
 Sets the name of the icon associated with the RubberStamp annotation.

Static Public Member Functions

static RubberStamp Create (SDF::SDFDoc &doc, const Rect &pos, Icon icon=e_Draft)
 Creates a new RubberStamp annotation in the specified document.


Detailed Description

A RubberStamp annotation displays text or graphics intended to look as if they were stamped on the page with a rubber stamp.

Member Enumeration Documentation

This enum represents the Icon type of the RubberStamp annotation.

Enumerator:
e_Approved  a stamp with the text "Approved"
e_Experimental  a stamp with the text "Experimental"
e_NotApproved  a stamp with the text "Not Approved"
e_AsIs  a stamp with the text "As Is"
e_Expired  a stamp with the text "Expired"
e_NotForPublicRelease  a stamp with the text "Not For Public Release"
e_Confidential  a stamp with the text "Confidential"
e_Final  a stamp with the text "Final"
e_Sold  a stamp with the text "Sold"
e_Departmental  a stamp with the text "Departmental"
e_ForComment  a stamp with the text "For Comment"
e_TopSecret  a stamp with the text "Top Secret"
e_ForPublicRelease  a stamp with the text "For Public Release"
e_Draft  a stamp with the text "Draft"
e_Unknown  Non-standard or user defined stamp.


Constructor & Destructor Documentation

pdftron::PDF::Annots::RubberStamp::RubberStamp ( SDF::Obj  d = 0  ) 

Creates a RubberStamp annotation and initializes it using given Cos/SDF object.

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

pdftron::PDF::Annots::RubberStamp::RubberStamp ( const Annot ann  )  [inline]

Creates a RubberStamp annotation and initializes it using given annotation object.

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


Member Function Documentation

static RubberStamp pdftron::PDF::Annots::RubberStamp::Create ( SDF::SDFDoc doc,
const Rect pos,
Icon  icon = e_Draft 
) [static]

Creates a new RubberStamp annotation in the specified document.

Parameters:
doc A document to which the annotation is added.
pos A rectangle specifying the annotation's bounds in default user space units.
Returns:
A newly created blank RubberStamp annotation.

Icon pdftron::PDF::Annots::RubberStamp::GetIcon (  )  const

Returns the type of the icon associated with the RubberStamp annotation.

Returns:
A value of enum "Icon" that represents the type of icon associated with the annotation. Default value: e_Draft.

void pdftron::PDF::Annots::RubberStamp::SetIcon ( Icon  type = e_Draft  ) 

Sets the type of the icon associated with the RubberStamp annotation.

Parameters:
type A value of enum "Icon" type that represents the type of icon associated with the annotation. Default value: e_Draft.

const char* pdftron::PDF::Annots::RubberStamp::GetIconName (  )  const

Returns the name of the icon associated with the RubberStamp annotation.

Returns:
A string that is the name of the icon associated with the RubberStamp annotation.
Note:
The following icon names are equivalent to predefined icon types from the enum "Icon": "Approved" = e_Approved "Experimental" = e_Experimental "NotApproved" = e_NotApproved "AsIs" = e_AsIs "Expired" = e_Expired "NotForPublicRelease" = e_NotForPublicRelease "Confidential" = e_Confidential "Final" = e_Final "Sold" = e_Sold "Departmental" = e_Departmental "Format" = e_ForComment "TopSecret" = e_TopSecret "ForPublicRelease" = e_ForPublicRelease "Draft" = e_Draft "Unknown" = e_Unknown Names other than mentioned above do not have predefined icon appearances.

void pdftron::PDF::Annots::RubberStamp::SetIcon ( const char *  icon  ) 

Sets the name of the icon associated with the RubberStamp annotation.

Parameters:
iconstring the name of the icon associated with the RubberStamp annotation.
Note:
The following icon names are equivalent to predefined icon types from the enum "Icon": "Approved" = e_Approved "Experimental" = e_Experimental "NotApproved" = e_NotApproved "AsIs" = e_AsIs "Expired" = e_Expired "NotForPublicRelease" = e_NotForPublicRelease "Confidential" = e_Confidential "Final" = e_Final "Sold" = e_Sold "Departmental" = e_Departmental "Format" = e_ForComment "TopSecret" = e_TopSecret "ForPublicRelease" = e_ForPublicRelease "Draft" = e_Draft "Unknown" = e_Unknown Names other than mentioned above do not have predefined icon appearances.


© 2002-2010 PDFTron Systems Inc.