JawsMako::IPageLabel Class Reference

Interface class representing a PDF page label. More...

#include <pagelabels.h>

Inheritance diagram for JawsMako::IPageLabel:

Public Types
enum	eLabelStyle {   eNone = 0 , eDecimal , eRomanUppercase , eRomanLowercase ,   eLetterUppercase , eLetterLowercase }
	Page label numbering styles. More...

Public Member Functions
virtual eLabelStyle	getStyle ()=0
	Get the page label numbering style. Returns the numbering style to be used for the numeric portion of the page label. The default is eNone, which specifies that the label has no numeric portion.
virtual void	setStyle (eLabelStyle style)=0
	Set the page label numbering style.
virtual U8String	getPrefix ()=0
	Get the page label prefix. Returns the prefix to be used for the page label. The default is an empty string, which specifies that the label has no prefix.
virtual void	setPrefix (const U8String &prefix)=0
	Set the page label prefix.
virtual uint32	getNumber ()=0
	Get the page label number. Returns the value of the numeric portion to be used for the page label. The default is 1.
virtual void	setNumber (uint32 number)=0
	Set the page label number.
virtual IPageLabelPtr	clone ()=0
	Clone the page label.
Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.

Static Public Member Functions
static JAWSMAKO_API IPageLabelPtr	create (const IJawsMakoPtr &jawsMako)
	Create an IPageLabel.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

Interface class representing a PDF page label.

Member Enumeration Documentation

eLabelStyle

enum JawsMako::IPageLabel::eLabelStyle

Page label numbering styles.

Enumerator
eNone	No style.
eDecimal	Decimal Arabic Numerals.
eRomanUppercase	Uppercase Roman Numerals.
eRomanLowercase	Lowercase Roman Numerals.
eLetterUppercase	Uppercase letters.
eLetterLowercase	Lowercase letters.

Member Function Documentation

clone()

virtual IPageLabelPtr JawsMako::IPageLabel::clone ( )

pure virtual

Clone the page label.

Returns

IPageLabelPtr A smart pointer to the cloned IPageLabel object.

create()

static JAWSMAKO_API IPageLabelPtr JawsMako::IPageLabel::create ( const IJawsMakoPtr & jawsMako )

static

Create an IPageLabel.

Parameters

jawsMako

A smart pointer to the JawsMako instance.

Returns

IPageLabelPtr A smart pointer to the IPageLabel object.

getNumber()

virtual uint32 JawsMako::IPageLabel::getNumber ( )

pure virtual

Get the page label number. Returns the value of the numeric portion to be used for the page label. The default is 1.

Returns

uint32 The label number.

getPrefix()

virtual U8String JawsMako::IPageLabel::getPrefix ( )

pure virtual

Get the page label prefix. Returns the prefix to be used for the page label. The default is an empty string, which specifies that the label has no prefix.

Returns

U8String The label prefix.

getStyle()

virtual eLabelStyle JawsMako::IPageLabel::getStyle ( )

pure virtual

Get the page label numbering style. Returns the numbering style to be used for the numeric portion of the page label. The default is eNone, which specifies that the label has no numeric portion.

Returns

eLabelStyle The label numbering style.

setNumber()

virtual void JawsMako::IPageLabel::setNumber ( uint32 number )

pure virtual

Set the page label number.

Parameters

number

The label number, which must be greater than or equal to 1.

setPrefix()

virtual void JawsMako::IPageLabel::setPrefix ( const U8String & prefix )

pure virtual

Set the page label prefix.

Parameters

prefix

The label prefix to set.

setStyle()

virtual void JawsMako::IPageLabel::setStyle ( eLabelStyle style )

pure virtual

Set the page label numbering style.

Parameters

style

The label numbering style to set.

---

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

• pagelabels.h