WPXPageSpan Class Reference documentation

Public Member Functions | Protected Member Functions | Private Attributes | List of all members
WPXPageSpan Class Reference

`#include <WPXPageSpan.h>`

## Public Member Functions
| WPXPageSpan ()
| WPXPageSpan (const WPXPageSpan &page, double paragraphMarginLeft, double paragraphMarginRight)
virtual | ~WPXPageSpan ()
bool | getPageNumberSuppression () const
bool | getHeaderFooterSuppression (const unsigned char headerFooterType) const
double | getFormLength () const
double | getFormWidth () const
WPXFormOrientation | getFormOrientation () const
double | getMarginLeft () const
double | getMarginRight () const
double | getMarginTop () const
double | getMarginBottom () const
WPXPageNumberPosition | getPageNumberPosition () const
bool | getPageNumberOverriden () const
int | getPageNumberOverride () const
WPXNumberingType | getPageNumberingType () const
double | getPageNumberingFontSize () const
librevenge::RVNGString | getPageNumberingFontName () const
int | getPageSpan () const
const std::vector< WPXHeaderFooter > & | getHeaderFooterList () const
void | setHeaderFooter (const WPXHeaderFooterType type, const unsigned char headerFooterType, const WPXHeaderFooterOccurrence occurrence, const std::shared_ptr< WPXSubDocument > &subDocument, WPXTableList tableList)
void | setPageNumberSuppression (const bool suppress)
void | setHeadFooterSuppression (const unsigned char headerFooterType, const bool suppress)
void | setFormLength (const double formLength)
void | setFormWidth (const double formWidth)
void | setFormOrientation (const WPXFormOrientation formOrientation)
void | setMarginLeft (const double marginLeft)
void | setMarginRight (const double marginRight)
void | setMarginTop (const double marginTop)
void | setMarginBottom (const double marginBottom)
void | setPageNumberPosition (const WPXPageNumberPosition pageNumberPosition)
void | setPageNumber (const int pageNumberOverride)
void | setPageNumberingType (const WPXNumberingType pageNumberingType)
void | setPageNumberingFontSize (const double pageNumberingFontSize)
void | setPageNumberingFontName (const librevenge::RVNGString &pageNumberingFontName)
void | setPageSpan (const int pageSpan)

## Protected Member Functions
void | _removeHeaderFooter (WPXHeaderFooterType type, WPXHeaderFooterOccurrence occurrence)
bool | _containsHeaderFooter (WPXHeaderFooterType type, WPXHeaderFooterOccurrence occurrence)

## Private Attributes
bool | m_isHeaderFooterSuppressed [WPX_NUM_HEADER_FOOTER_TYPES]
bool | m_isPageNumberSuppressed
double | m_formLength
double | m_formWidth
WPXFormOrientation | m_formOrientation
double | m_marginLeft
double | m_marginRight
double | m_marginTop
double | m_marginBottom
WPXPageNumberPosition | m_pageNumberPosition
bool | m_isPageNumberOverridden
int | m_pageNumberOverride
WPXNumberingType | m_pageNumberingType
librevenge::RVNGString | m_pageNumberingFontName
double | m_pageNumberingFontSize
std::vector< WPXHeaderFooter > | m_headerFooterList
int | m_pageSpan

## Constructor & Destructor Documentation

## ◆ WPXPageSpan() [1/2]

WPXPageSpan::WPXPageSpan | ( |  | ) |

## ◆ WPXPageSpan() [2/2]

WPXPageSpan::WPXPageSpan | ( | const WPXPageSpan & | page,
|  | double | paragraphMarginLeft,
|  | double | paragraphMarginRight
| ) |  |

## ◆ ~WPXPageSpan()

WPXPageSpan::~WPXPageSpan | ( |  | ) |
| virtual

## Member Function Documentation

## ◆ _containsHeaderFooter()

bool WPXPageSpan::_containsHeaderFooter | ( | WPXHeaderFooterType | type,
|  | WPXHeaderFooterOccurrence | occurrence
| ) |  |
| protected

Referenced by setHeaderFooter().

## ◆ _removeHeaderFooter()

void WPXPageSpan::_removeHeaderFooter | ( | WPXHeaderFooterType | type,
|  | WPXHeaderFooterOccurrence | occurrence
| ) |  |
| protected

Referenced by setHeaderFooter().

## ◆ getFormLength()

double WPXPageSpan::getFormLength | ( |  | ) | const
| inline

Referenced by WPXContentListener::_openPageSpan().

## ◆ getFormOrientation()

WPXFormOrientation WPXPageSpan::getFormOrientation | ( |  | ) | const
| inline

Referenced by WPXContentListener::_openPageSpan().

## ◆ getFormWidth()

double WPXPageSpan::getFormWidth | ( |  | ) | const
| inline

Referenced by WPXContentListener::_openPageSpan().

## ◆ getHeaderFooterList()

const std::vector< WPXHeaderFooter > & WPXPageSpan::getHeaderFooterList | ( |  | ) | const
| inline

Referenced by WPXContentListener::_openPageSpan(), WP1StylesListener::insertBreak(), WP42StylesListener::insertBreak(), WP5StylesListener::insertBreak(), and operator==().

## ◆ getHeaderFooterSuppression()

bool WPXPageSpan::getHeaderFooterSuppression | ( | const unsigned char | headerFooterType | ) | const
| inline

Referenced by WPXContentListener::_openPageSpan(), and operator==().

## ◆ getMarginBottom()

double WPXPageSpan::getMarginBottom | ( |  | ) | const
| inline

Referenced by WPXContentListener::_openPageSpan(), and operator==().

## ◆ getMarginLeft()

double WPXPageSpan::getMarginLeft | ( |  | ) | const
| inline

Referenced by WPXContentListener::_openPageSpan(), WP6StylesListener::marginChange(), WP3StylesListener::marginChange(), WP5StylesListener::marginChange(), WP1StylesListener::marginReset(), and operator==().

## ◆ getMarginRight()

double WPXPageSpan::getMarginRight | ( |  | ) | const
| inline

Referenced by WPXContentListener::_openPageSpan(), WP6StylesListener::marginChange(), WP3StylesListener::marginChange(), WP5StylesListener::marginChange(), WP1StylesListener::marginReset(), and operator==().

## ◆ getMarginTop()

double WPXPageSpan::getMarginTop | ( |  | ) | const
| inline

Referenced by WPXContentListener::_openPageSpan(), and operator==().

## ◆ getPageNumberingFontName()

librevenge::RVNGString WPXPageSpan::getPageNumberingFontName | ( |  | ) | const
| inline

Referenced by WPXContentListener::_openPageSpan(), and operator==().

## ◆ getPageNumberingFontSize()

double WPXPageSpan::getPageNumberingFontSize | ( |  | ) | const
| inline

Referenced by WPXContentListener::_openPageSpan(), and operator==().

## ◆ getPageNumberingType()

WPXNumberingType WPXPageSpan::getPageNumberingType | ( |  | ) | const
| inline

Referenced by WPXContentListener::_openPageSpan(), and operator==().

## ◆ getPageNumberOverride()

int WPXPageSpan::getPageNumberOverride | ( |  | ) | const
| inline

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

## ◆ getPageNumberOverriden()

bool WPXPageSpan::getPageNumberOverriden | ( |  | ) | const
| inline

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

## ◆ getPageNumberPosition()

WPXPageNumberPosition WPXPageSpan::getPageNumberPosition | ( |  | ) | const
| inline

Referenced by WPXContentListener::_openPageSpan(), and operator==().

## ◆ getPageNumberSuppression()

bool WPXPageSpan::getPageNumberSuppression | ( |  | ) | const
| inline

Referenced by WPXContentListener::_openPageSpan(), and operator==().

## ◆ getPageSpan()

int WPXPageSpan::getPageSpan | ( |  | ) | const
| inline

Referenced by WPXContentListener::_openPageSpan().

## ◆ setFormLength()

void WPXPageSpan::setFormLength | ( | const double | formLength | ) |
| inline

Referenced by WP6StylesListener::pageFormChange(), WP3StylesListener::pageFormChange(), and WP5StylesListener::pageFormChange().

## ◆ setFormOrientation()

void WPXPageSpan::setFormOrientation | ( | const WPXFormOrientation | formOrientation | ) |
| inline

Referenced by WP6StylesListener::pageFormChange(), WP3StylesListener::pageFormChange(), and WP5StylesListener::pageFormChange().

## ◆ setFormWidth()

void WPXPageSpan::setFormWidth | ( | const double | formWidth | ) |
| inline

Referenced by WP6StylesListener::pageFormChange(), WP3StylesListener::pageFormChange(), and WP5StylesListener::pageFormChange().

## ◆ setHeaderFooter()

void WPXPageSpan::setHeaderFooter | ( | const WPXHeaderFooterType | type,
|  | const unsigned char | headerFooterType,
|  | const WPXHeaderFooterOccurrence | occurrence,
|  | const std::shared_ptr< WPXSubDocument > & | subDocument,
|  | WPXTableList | tableList
| ) |  |

Referenced by WP6StylesListener::headerFooterGroup(), WP1StylesListener::headerFooterGroup(), WP42StylesListener::headerFooterGroup(), WP3StylesListener::headerFooterGroup(), WP5StylesListener::headerFooterGroup(), WP1StylesListener::insertBreak(), WP42StylesListener::insertBreak(), and WP5StylesListener::insertBreak().

## ◆ setHeadFooterSuppression()

void WPXPageSpan::setHeadFooterSuppression | ( | const unsigned char | headerFooterType,
|  | const bool | suppress
| ) |  |
| inline

Referenced by WP3StylesListener::suppressPage(), WP6StylesListener::suppressPageCharacteristics(), WP1StylesListener::suppressPageCharacteristics(), WP42StylesListener::suppressPageCharacteristics(), and WP5StylesListener::suppressPageCharacteristics().

## ◆ setMarginBottom()

void WPXPageSpan::setMarginBottom | ( | const double | marginBottom | ) |
| inline

Referenced by WP1StylesListener::bottomMarginSet(), WP6StylesListener::pageMarginChange(), WP3StylesListener::pageMarginChange(), and WP5StylesListener::pageMarginChange().

## ◆ setMarginLeft()

void WPXPageSpan::setMarginLeft | ( | const double | marginLeft | ) |
| inline

Referenced by WP6StylesListener::insertBreak(), WP1StylesListener::insertBreak(), WP3StylesListener::insertBreak(), WP42StylesListener::insertBreak(), WP5StylesListener::insertBreak(), WP6StylesListener::marginChange(), WP3StylesListener::marginChange(), WP5StylesListener::marginChange(), and WP1StylesListener::marginReset().

## ◆ setMarginRight()

void WPXPageSpan::setMarginRight | ( | const double | marginRight | ) |
| inline

Referenced by WP6StylesListener::insertBreak(), WP1StylesListener::insertBreak(), WP3StylesListener::insertBreak(), WP42StylesListener::insertBreak(), WP5StylesListener::insertBreak(), WP6StylesListener::marginChange(), WP3StylesListener::marginChange(), WP5StylesListener::marginChange(), and WP1StylesListener::marginReset().

## ◆ setMarginTop()

void WPXPageSpan::setMarginTop | ( | const double | marginTop | ) |
| inline

Referenced by WP6StylesListener::pageMarginChange(), WP3StylesListener::pageMarginChange(), WP5StylesListener::pageMarginChange(), and WP1StylesListener::topMarginSet().

## ◆ setPageNumber()

void WPXPageSpan::setPageNumber | ( | const int | pageNumberOverride | ) |
| inline

Referenced by WP6StylesListener::setPageNumber().

## ◆ setPageNumberingFontName()

void WPXPageSpan::setPageNumberingFontName | ( | const librevenge::RVNGString & | pageNumberingFontName | ) |
| inline

Referenced by WP6StylesListener::pageNumberingChange().

## ◆ setPageNumberingFontSize()

void WPXPageSpan::setPageNumberingFontSize | ( | const double | pageNumberingFontSize | ) |
| inline

Referenced by WP6StylesListener::pageNumberingChange().

## ◆ setPageNumberingType()

void WPXPageSpan::setPageNumberingType | ( | const WPXNumberingType | pageNumberingType | ) |
| inline

Referenced by WP6StylesListener::setPageNumberingType().

## ◆ setPageNumberPosition()

void WPXPageSpan::setPageNumberPosition | ( | const WPXPageNumberPosition | pageNumberPosition | ) |
| inline

Referenced by WP6StylesListener::pageNumberingChange().

## ◆ setPageNumberSuppression()

void WPXPageSpan::setPageNumberSuppression | ( | const bool | suppress | ) |
| inline

Referenced by WP6StylesListener::suppressPageCharacteristics().

## ◆ setPageSpan()

void WPXPageSpan::setPageSpan | ( | const int | pageSpan | ) |
| inline

Referenced by WP6StylesListener::insertBreak(), WP1StylesListener::insertBreak(), WP3StylesListener::insertBreak(), WP42StylesListener::insertBreak(), and WP5StylesListener::insertBreak().

## Member Data Documentation

## ◆ m_formLength

double WPXPageSpan::m_formLength
| private

Referenced by getFormLength(), and setFormLength().

## ◆ m_formOrientation

WPXFormOrientation WPXPageSpan::m_formOrientation
| private

Referenced by getFormOrientation(), and setFormOrientation().

## ◆ m_formWidth

double WPXPageSpan::m_formWidth
| private

Referenced by getFormWidth(), and setFormWidth().

## ◆ m_headerFooterList

std::vector<WPXHeaderFooter> WPXPageSpan::m_headerFooterList
| private

Referenced by _containsHeaderFooter(), _removeHeaderFooter(), getHeaderFooterList(), and setHeaderFooter().

## ◆ m_isHeaderFooterSuppressed

bool WPXPageSpan::m_isHeaderFooterSuppressed[WPX_NUM_HEADER_FOOTER_TYPES]
| private

Referenced by getHeaderFooterSuppression(), setHeadFooterSuppression(), and WPXPageSpan().

## ◆ m_isPageNumberOverridden

bool WPXPageSpan::m_isPageNumberOverridden
| private

Referenced by getPageNumberOverriden(), and setPageNumber().

## ◆ m_isPageNumberSuppressed

bool WPXPageSpan::m_isPageNumberSuppressed
| private

Referenced by getPageNumberSuppression(), and setPageNumberSuppression().

## ◆ m_marginBottom

double WPXPageSpan::m_marginBottom
| private

Referenced by getMarginBottom(), and setMarginBottom().

## ◆ m_marginLeft

double WPXPageSpan::m_marginLeft
| private

Referenced by getMarginLeft(), and setMarginLeft().

## ◆ m_marginRight

double WPXPageSpan::m_marginRight
| private

Referenced by getMarginRight(), and setMarginRight().

## ◆ m_marginTop

double WPXPageSpan::m_marginTop
| private

Referenced by getMarginTop(), and setMarginTop().

## ◆ m_pageNumberingFontName

librevenge::RVNGString WPXPageSpan::m_pageNumberingFontName
| private

Referenced by getPageNumberingFontName(), and setPageNumberingFontName().

## ◆ m_pageNumberingFontSize

double WPXPageSpan::m_pageNumberingFontSize
| private

Referenced by getPageNumberingFontSize(), and setPageNumberingFontSize().

## ◆ m_pageNumberingType

WPXNumberingType WPXPageSpan::m_pageNumberingType
| private

Referenced by getPageNumberingType(), and setPageNumberingType().

## ◆ m_pageNumberOverride

int WPXPageSpan::m_pageNumberOverride
| private

Referenced by getPageNumberOverride(), and setPageNumber().

## ◆ m_pageNumberPosition

WPXPageNumberPosition WPXPageSpan::m_pageNumberPosition
| private

Referenced by getPageNumberPosition(), and setPageNumberPosition().

## ◆ m_pageSpan

int WPXPageSpan::m_pageSpan
| private

Referenced by getPageSpan(), and setPageSpan().

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

- WPXPageSpan.h
- WPXPageSpan.cpp