WPSPageSpan Class Reference

#include <WPSPageSpan.h>

Public Types
enum	FormOrientation { PORTRAIT, LANDSCAPE }
enum	HeaderFooterType { HEADER, FOOTER }
enum	HeaderFooterOccurence { ODD, EVEN, ALL, NEVER }
enum	PageNumberPosition {   None = 0, TopLeft, TopCenter, TopRight,   TopLeftAndRight, TopInsideLeftAndRight, BottomLeft, BottomCenter,   BottomRight, BottomLeftAndRight, BottomInsideLeftAndRight }

Public Member Functions
	WPSPageSpan ()
virtual	~WPSPageSpan ()
double	getFormLength () const
double	getFormWidth () const
FormOrientation	getFormOrientation () const
double	getMarginLeft () const
double	getMarginRight () const
double	getMarginTop () const
double	getMarginBottom () const
PageNumberPosition	getPageNumberPosition () const
int	getPageNumber () const
libwps::NumberingType	getPageNumberingType () const
double	getPageNumberingFontSize () const
WPXString	getPageNumberingFontName () const
int	getPageSpan () const
const std::vector< WPSPageSpanInternal::HeaderFooterPtr > &	getHeaderFooterList () const
void	setHeaderFooter (const HeaderFooterType type, const HeaderFooterOccurence occurence, WPSSubDocumentPtr &subDocument)
void	setFormLength (const double formLength)
void	setFormWidth (const double formWidth)
void	setFormOrientation (const FormOrientation formOrientation)
void	setMarginLeft (const double marginLeft)
void	setMarginRight (const double marginRight)
void	setMarginTop (const double marginTop)
void	setMarginBottom (const double marginBottom)
void	setPageNumberPosition (const PageNumberPosition pageNumberPosition)
void	setPageNumber (const int pageNumber)
void	setPageNumberingType (const libwps::NumberingType pageNumberingType)
void	setPageNumberingFontSize (const double pageNumberingFontSize)
void	setPageNumberingFontName (const WPXString &pageNumberingFontName)
void	setPageSpan (const int pageSpan)
bool	operator== (shared_ptr< WPSPageSpan > const &pageSpan) const
bool	operator!= (shared_ptr< WPSPageSpan > const &pageSpan) const

Protected Member Functions
void	getPageProperty (WPXPropertyList &pList) const
void	sendHeaderFooters (WPSContentListener *listener, WPXDocumentInterface *documentInterface)
int	_getHeaderFooterPosition (HeaderFooterType type, HeaderFooterOccurence occurence)
void	_setHeaderFooter (HeaderFooterType type, HeaderFooterOccurence occurence, WPSSubDocumentPtr &doc)
void	_removeHeaderFooter (HeaderFooterType type, HeaderFooterOccurence occurence)
bool	_containsHeaderFooter (HeaderFooterType type, HeaderFooterOccurence occurence)
void	_insertPageNumberParagraph (WPXDocumentInterface *documentInterface)

Private Attributes
double	m_formLength
double	m_formWidth
FormOrientation	m_formOrientation
double	m_marginLeft
double	m_marginRight
double	m_marginTop
double	m_marginBottom
PageNumberPosition	m_pageNumberPosition
int	m_pageNumber
libwps::NumberingType	m_pageNumberingType
WPXString	m_pageNumberingFontName
double	m_pageNumberingFontSize
std::vector< WPSPageSpanInternal::HeaderFooterPtr >	m_headerFooterList
int	m_pageSpan

Friends
class	WPSContentListener

Member Enumeration Documentation

FormOrientation

enum WPSPageSpan::FormOrientation

Enumerator
PORTRAIT
LANDSCAPE

HeaderFooterOccurence

enum WPSPageSpan::HeaderFooterOccurence

Enumerator
ODD
EVEN
ALL
NEVER

HeaderFooterType

enum WPSPageSpan::HeaderFooterType

Enumerator
HEADER
FOOTER

PageNumberPosition

enum WPSPageSpan::PageNumberPosition

Enumerator
None
TopLeft
TopCenter
TopRight
TopLeftAndRight
TopInsideLeftAndRight
BottomLeft
BottomCenter
BottomRight
BottomLeftAndRight
BottomInsideLeftAndRight

Constructor & Destructor Documentation

WPSPageSpan()

WPSPageSpan::WPSPageSpan

(

)

~WPSPageSpan()

WPSPageSpan::~WPSPageSpan ( )

virtual

Member Function Documentation

_containsHeaderFooter()

bool WPSPageSpan::_containsHeaderFooter ( HeaderFooterType  type, HeaderFooterOccurence  occurence  )

protected

Referenced by setHeaderFooter().

_getHeaderFooterPosition()

int WPSPageSpan::_getHeaderFooterPosition ( HeaderFooterType  type, HeaderFooterOccurence  occurence  )

protected

Referenced by _containsHeaderFooter(), _removeHeaderFooter(), and _setHeaderFooter().

_insertPageNumberParagraph()

void WPSPageSpan::_insertPageNumberParagraph ( WPXDocumentInterface *  documentInterface )

protected

Referenced by sendHeaderFooters().

_removeHeaderFooter()

void WPSPageSpan::_removeHeaderFooter ( HeaderFooterType  type, HeaderFooterOccurence  occurence  )

protected

Referenced by setHeaderFooter().

_setHeaderFooter()

void WPSPageSpan::_setHeaderFooter ( HeaderFooterType  type, HeaderFooterOccurence  occurence, WPSSubDocumentPtr &  doc  )

protected

Referenced by setHeaderFooter().

getFormLength()

double WPSPageSpan::getFormLength ( ) const

inline

Referenced by WPSContentListener::_openPageSpan(), getPageProperty(), and WPS8Parser::readDocProperties().

getFormOrientation()

FormOrientation WPSPageSpan::getFormOrientation ( ) const

inline

Referenced by WPSContentListener::_openPageSpan(), and getPageProperty().

getFormWidth()

double WPSPageSpan::getFormWidth ( ) const

inline

Referenced by WPSContentListener::_openPageSpan(), getPageProperty(), and WPS8Parser::readDocProperties().

getHeaderFooterList()

const std::vector<WPSPageSpanInternal::HeaderFooterPtr>& WPSPageSpan::getHeaderFooterList ( ) const

inline

getMarginBottom()

double WPSPageSpan::getMarginBottom ( ) const

inline

Referenced by WPSContentListener::_openPageSpan(), getPageProperty(), and operator==().

getMarginLeft()

double WPSPageSpan::getMarginLeft ( ) const

inline

Referenced by WPSContentListener::_openPageSpan(), getPageProperty(), and operator==().

getMarginRight()

double WPSPageSpan::getMarginRight ( ) const

inline

Referenced by WPSContentListener::_openPageSpan(), getPageProperty(), and operator==().

getMarginTop()

double WPSPageSpan::getMarginTop ( ) const

inline

Referenced by WPSContentListener::_openPageSpan(), getPageProperty(), and operator==().

getPageNumber()

int WPSPageSpan::getPageNumber ( ) const

inline

Referenced by WPSContentListener::_appendParagraphProperties(), and operator==().

getPageNumberingFontName()

WPXString WPSPageSpan::getPageNumberingFontName ( ) const

inline

Referenced by operator==().

getPageNumberingFontSize()

double WPSPageSpan::getPageNumberingFontSize ( ) const

inline

Referenced by operator==().

getPageNumberingType()

libwps::NumberingType WPSPageSpan::getPageNumberingType ( ) const

inline

Referenced by operator==().

getPageNumberPosition()

PageNumberPosition WPSPageSpan::getPageNumberPosition ( ) const

inline

Referenced by operator==().

getPageProperty()

void WPSPageSpan::getPageProperty ( WPXPropertyList &  pList ) const

protected

Referenced by WPSContentListener::_openPageSpan().

getPageSpan()

int WPSPageSpan::getPageSpan ( ) const

inline

Referenced by WPSContentListener::_openPageSpan(), and getPageProperty().

operator!=()

bool WPSPageSpan::operator!= ( shared_ptr< WPSPageSpan > const &  pageSpan ) const

inline

operator==()

bool WPSPageSpan::operator==

(

shared_ptr< WPSPageSpan > const &

pageSpan

)

const

sendHeaderFooters()

void WPSPageSpan::sendHeaderFooters ( WPSContentListener *  listener, WPXDocumentInterface *  documentInterface  )

protected

Referenced by WPSContentListener::_openPageSpan().

setFormLength()

void WPSPageSpan::setFormLength ( const double  formLength )

inline

Referenced by WPS4Parser::readDocDim(), and WPS8Parser::readDocProperties().

setFormOrientation()

void WPSPageSpan::setFormOrientation ( const FormOrientation  formOrientation )

inline

Referenced by WPS4Parser::readDocDim(), and WPS8Parser::readDocProperties().

setFormWidth()

void WPSPageSpan::setFormWidth ( const double  formWidth )

inline

Referenced by WPS4Parser::readDocDim(), and WPS8Parser::readDocProperties().

setHeaderFooter()

void WPSPageSpan::setHeaderFooter	(	const HeaderFooterType	type,
		const HeaderFooterOccurence	occurence,
		WPSSubDocumentPtr &	subDocument
	)

Referenced by WPS8Parser::createListener(), and WPS4Parser::createListener().

setMarginBottom()

void WPSPageSpan::setMarginBottom ( const double  marginBottom )

inline

Referenced by WPS4Parser::readDocDim(), and WPS8Parser::readDocProperties().

setMarginLeft()

void WPSPageSpan::setMarginLeft ( const double  marginLeft )

inline

Referenced by WPS4Parser::readDocDim(), and WPS8Parser::readDocProperties().

setMarginRight()

void WPSPageSpan::setMarginRight ( const double  marginRight )

inline

Referenced by WPS4Parser::readDocDim(), and WPS8Parser::readDocProperties().

setMarginTop()

void WPSPageSpan::setMarginTop ( const double  marginTop )

inline

Referenced by WPS4Parser::readDocDim(), and WPS8Parser::readDocProperties().

setPageNumber()

void WPSPageSpan::setPageNumber ( const int  pageNumber )

inline

setPageNumberingFontName()

void WPSPageSpan::setPageNumberingFontName ( const WPXString &  pageNumberingFontName )

inline

setPageNumberingFontSize()

void WPSPageSpan::setPageNumberingFontSize ( const double  pageNumberingFontSize )

inline

setPageNumberingType()

void WPSPageSpan::setPageNumberingType ( const libwps::NumberingType  pageNumberingType )

inline

setPageNumberPosition()

void WPSPageSpan::setPageNumberPosition ( const PageNumberPosition  pageNumberPosition )

inline

setPageSpan()

void WPSPageSpan::setPageSpan ( const int  pageSpan )

inline

Friends And Related Function Documentation

WPSContentListener

friend class WPSContentListener

friend

Member Data Documentation

m_formLength

double WPSPageSpan::m_formLength

private

Referenced by operator==().

m_formOrientation

FormOrientation WPSPageSpan::m_formOrientation

private

Referenced by operator==().

m_formWidth

double WPSPageSpan::m_formWidth

private

Referenced by operator==().

m_headerFooterList

std::vector<WPSPageSpanInternal::HeaderFooterPtr> WPSPageSpan::m_headerFooterList

private

Referenced by _containsHeaderFooter(), _getHeaderFooterPosition(), _removeHeaderFooter(), _setHeaderFooter(), operator==(), and sendHeaderFooters().

m_marginBottom

double WPSPageSpan::m_marginBottom

private

m_marginLeft

double WPSPageSpan::m_marginLeft

private

m_marginRight

double WPSPageSpan::m_marginRight

private

m_marginTop

double WPSPageSpan::m_marginTop

private

m_pageNumber

int WPSPageSpan::m_pageNumber

private

m_pageNumberingFontName

WPXString WPSPageSpan::m_pageNumberingFontName

private

Referenced by _insertPageNumberParagraph().

m_pageNumberingFontSize

double WPSPageSpan::m_pageNumberingFontSize

private

Referenced by _insertPageNumberParagraph().

m_pageNumberingType

libwps::NumberingType WPSPageSpan::m_pageNumberingType

private

Referenced by _insertPageNumberParagraph().

m_pageNumberPosition

PageNumberPosition WPSPageSpan::m_pageNumberPosition

private

Referenced by _insertPageNumberParagraph(), and sendHeaderFooters().

m_pageSpan

int WPSPageSpan::m_pageSpan

private

---

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

• WPSPageSpan.h
• WPSPageSpan.cpp