Model Railroad System  2.2.2
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
FCFSupport::PDFFileStructures::PageLabelDictionary Class Reference

Page label dictionary. More...

#include <PDFPrinterSupport.h>

Inheritance diagram for FCFSupport::PDFFileStructures::PageLabelDictionary:
FCFSupport::PDFFileStructures::TypedDictionary FCFSupport::PDFFileStructures::Dictionary FCFSupport::PDFFileStructures::IndirectObject

Public Types

enum  NumberStyle {
  None = 0 , Decimal = 'D' , UpperRoman = 'R' , LowerRoman = 'r' ,
  UpperLetters = 'A' , LowerLetters = 'a'
}
 Numbering style. More...
 

Public Member Functions

 PageLabelDictionary (NumberStyle s=None, const string p="", int st=1, unsigned long int objNum=0L, unsigned short int genNum=0, CrossReferenceTable *tab=NULL)
 Constructor. More...
 
 ~PageLabelDictionary ()
 Destructor. More...
 
- Public Member Functions inherited from FCFSupport::PDFFileStructures::TypedDictionary
 TypedDictionary (string t, unsigned long int objNum=0L, unsigned short int genNum=0, CrossReferenceTable *tab=NULL)
 Constructor. More...
 
 ~TypedDictionary ()
 Destructor. More...
 
- Public Member Functions inherited from FCFSupport::PDFFileStructures::Dictionary
 Dictionary (unsigned long int objNum=0L, unsigned short int genNum=0, CrossReferenceTable *tab=NULL)
 Constructor. More...
 
virtual ~Dictionary ()
 Destructor. More...
 
virtual ostream & WriteDirect (ostream &stream) const
 Write an object directly. More...
 
- Public Member Functions inherited from FCFSupport::PDFFileStructures::IndirectObject
 IndirectObject (unsigned long int objNum=0L, unsigned short int genNum=0, CrossReferenceTable *tab=NULL)
 Constructor. More...
 
virtual ~IndirectObject ()
 Destructor. More...
 
ostream & WriteObjectToFile (ostream &stream)
 Write an object indirectly. More...
 
ostream & WriteIndirectReference (ostream &stream) const
 Write an object indirectly. More...
 
unsigned long int ObjectNumber () const
 Return this object's object number. More...
 
unsigned short int GenerationNumber () const
 Return this object's generation number. More...
 
streampos FileOffset () const
 Return this object's file offset. More...
 
bool HasOffset () const
 Does the object have a file offset? More...
 

Protected Member Functions

virtual ostream & WriteDictionaryElements (ostream &stream) const
 Write an object directly. More...
 
- Protected Member Functions inherited from FCFSupport::PDFFileStructures::TypedDictionary
ostream & WriteDictionaryType (ostream &stream) const
 Write the dictionary's type. More...
 

Private Attributes

NumberStyle style
 Page numbering style. More...
 
string prefix
 Prefix string. More...
 
int start
 Page numbering start. More...
 

Detailed Description

Page label dictionary.

Author
Robert Heller <heller@deepsoft.com>

Member Enumeration Documentation

◆ NumberStyle

Numbering style.

Enumerator
None 

None.

Decimal 

Decimal arabic numerals.

UpperRoman 

Uppercase roman numerals.

LowerRoman 

Lowercase roman numerals.

UpperLetters 

Uppercase letters.

LowerLetters 

Lowercase letters.

Constructor & Destructor Documentation

◆ PageLabelDictionary()

FCFSupport::PDFFileStructures::PageLabelDictionary::PageLabelDictionary ( NumberStyle  s = None,
const string  p = "",
int  st = 1,
unsigned long int  objNum = 0L,
unsigned short int  genNum = 0,
CrossReferenceTable tab = NULL 
)
inline

Constructor.

Create a fresh Pager object.

Parameters
sNumbering style.
pPage label prefix string.
stPage number starting value for this range.
objNumThe next object number.
genNumThe generation number.
tabThe cross reference table we are in.

References prefix, start, and style.

◆ ~PageLabelDictionary()

FCFSupport::PDFFileStructures::PageLabelDictionary::~PageLabelDictionary ( )
inline

Destructor.

Member Function Documentation

◆ WriteDictionaryElements()

virtual ostream& FCFSupport::PDFFileStructures::PageLabelDictionary::WriteDictionaryElements ( ostream &  stream) const
protectedvirtual

Write an object directly.

Parameters
streamThe output stream to write to.

Reimplemented from FCFSupport::PDFFileStructures::TypedDictionary.

Member Data Documentation

◆ prefix

string FCFSupport::PDFFileStructures::PageLabelDictionary::prefix
private

Prefix string.

Referenced by PageLabelDictionary().

◆ start

int FCFSupport::PDFFileStructures::PageLabelDictionary::start
private

Page numbering start.

Referenced by PageLabelDictionary().

◆ style

NumberStyle FCFSupport::PDFFileStructures::PageLabelDictionary::style
private

Page numbering style.

Referenced by PageLabelDictionary().