A structure used to defined the page properties. More...
#include <MWAWPageSpan.hxx>
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 | |
MWAWPageSpan () | |
constructor More... | |
virtual | ~MWAWPageSpan () |
destructor More... | |
double | getFormLength () const |
returns the page length More... | |
double | getFormWidth () const |
returns the page width More... | |
FormOrientation | getFormOrientation () const |
returns the page orientation More... | |
double | getMarginLeft () const |
returns the left margin More... | |
double | getMarginRight () const |
returns the right margin More... | |
double | getMarginTop () const |
returns the top margin More... | |
double | getMarginBottom () const |
returns the bottom margin More... | |
MWAWColor | backgroundColor () const |
returns the background color More... | |
PageNumberPosition | getPageNumberPosition () const |
int | getPageNumber () const |
libmwaw::NumberingType | getPageNumberingType () const |
double | getPageNumberingFontSize () const |
WPXString | getPageNumberingFontName () const |
int | getPageSpan () const |
const std::vector < MWAWPageSpanInternal::HeaderFooterPtr > & | getHeaderFooterList () const |
void | setHeaderFooter (const HeaderFooterType type, const HeaderFooterOccurence occurence, MWAWSubDocumentPtr &subDocument) |
add a header/footer on some page More... | |
void | setFormLength (const double formLength) |
set the total page length More... | |
void | setFormWidth (const double formWidth) |
set the total page width More... | |
void | setFormOrientation (const FormOrientation formOrientation) |
set the form orientation More... | |
void | setMarginLeft (const double marginLeft) |
set the page left margin More... | |
void | setMarginRight (const double marginRight) |
set the page right margin More... | |
void | setMarginTop (const double marginTop) |
set the page top margin More... | |
void | setMarginBottom (const double marginBottom) |
set the page bottom margin More... | |
void | checkMargins () |
check if the page margins are consistent with the page dimension, if not update them More... | |
void | setBackgroundColor (MWAWColor color=MWAWColor::white()) |
set the background color More... | |
void | setPageNumberPosition (const PageNumberPosition pageNumberPosition) |
void | setPageNumber (const int pageNumber) |
void | setPageNumberingType (const libmwaw::NumberingType pageNumberingType) |
void | setPageNumberingFontSize (const double pageNumberingFontSize) |
void | setPageNumberingFontName (const WPXString &pageNumberingFontName) |
void | setPageSpan (const int pageSpan) |
bool | operator== (shared_ptr< MWAWPageSpan > const &pageSpan) const |
bool | operator!= (shared_ptr< MWAWPageSpan > const &pageSpan) const |
Protected Member Functions | |
void | getPageProperty (WPXPropertyList &pList) const |
void | sendHeaderFooters (MWAWContentListener *listener, WPXDocumentInterface *documentInterface) |
int | _getHeaderFooterPosition (HeaderFooterType type, HeaderFooterOccurence occurence) |
void | _setHeaderFooter (HeaderFooterType type, HeaderFooterOccurence occurence, MWAWSubDocumentPtr &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 |
MWAWColor | m_backgroundColor |
PageNumberPosition | m_pageNumberPosition |
int | m_pageNumber |
libmwaw::NumberingType | m_pageNumberingType |
WPXString | m_pageNumberingFontName |
double | m_pageNumberingFontSize |
std::vector < MWAWPageSpanInternal::HeaderFooterPtr > | m_headerFooterList |
int | m_pageSpan |
Friends | |
class | MWAWContentListener |
A structure used to defined the page properties.
MWAWPageSpan::MWAWPageSpan | ( | ) |
constructor
|
virtual |
destructor
|
protected |
Referenced by setHeaderFooter().
|
protected |
Referenced by _containsHeaderFooter(), _removeHeaderFooter(), and _setHeaderFooter().
|
protected |
Referenced by sendHeaderFooters().
|
protected |
Referenced by setHeaderFooter().
|
protected |
Referenced by setHeaderFooter().
|
inline |
returns the background color
Referenced by operator==().
void MWAWPageSpan::checkMargins | ( | ) |
check if the page margins are consistent with the page dimension, if not update them
Referenced by MRWParser::readPrintInfo().
|
inline |
returns the page length
Referenced by MWAWContentListener::_openPageSpan(), getPageProperty(), LWParser::pageHeight(), MSW1Parser::pageHeight(), NSParser::pageHeight(), MSK3Parser::pageHeight(), WNParser::pageHeight(), ZWParser::pageHeight(), MSK4Zone::pageHeight(), MWProParser::pageHeight(), MWParser::pageHeight(), HMWJParser::pageHeight(), MDWParser::pageHeight(), WPParser::pageHeight(), CWParser::pageHeight(), FWParser::pageHeight(), MRWParser::pageHeight(), MSWParser::pageHeight(), and HMWKParser::pageHeight().
|
inline |
returns the page orientation
Referenced by MWAWContentListener::_openPageSpan(), and getPageProperty().
|
inline |
returns the page width
Referenced by MWAWContentListener::_openPageSpan(), getPageProperty(), EDParser::pageWidth(), LWParser::pageWidth(), MSW1Parser::pageWidth(), NSParser::pageWidth(), MSK3Parser::pageWidth(), WNParser::pageWidth(), ZWParser::pageWidth(), MSK4Zone::pageWidth(), MWProParser::pageWidth(), MWParser::pageWidth(), HMWJParser::pageWidth(), WPParser::pageWidth(), MDWParser::pageWidth(), CWParser::pageWidth(), FWParser::pageWidth(), MRWParser::pageWidth(), MSWParser::pageWidth(), and HMWKParser::pageWidth().
|
inline |
|
inline |
returns the bottom margin
Referenced by MWAWContentListener::_openPageSpan(), getPageProperty(), operator==(), LWParser::pageHeight(), MSW1Parser::pageHeight(), NSParser::pageHeight(), MSK3Parser::pageHeight(), WNParser::pageHeight(), ZWParser::pageHeight(), MSK4Zone::pageHeight(), MWProParser::pageHeight(), MWParser::pageHeight(), HMWJParser::pageHeight(), MDWParser::pageHeight(), WPParser::pageHeight(), CWParser::pageHeight(), FWParser::pageHeight(), MRWParser::pageHeight(), MSWParser::pageHeight(), and HMWKParser::pageHeight().
|
inline |
returns the left margin
Referenced by MWAWContentListener::_openPageSpan(), LWParser::getPageLeftTop(), NSParser::getPageLeftTop(), ZWParser::getPageLeftTop(), HMWJParser::getPageLeftTop(), CWParser::getPageLeftTop(), MRWParser::getPageLeftTop(), HMWKParser::getPageLeftTop(), getPageProperty(), MSK3Parser::getPageTopLeft(), MSK4Zone::getPageTopLeft(), WPParser::getParagraph(), operator==(), EDParser::pageWidth(), LWParser::pageWidth(), MSW1Parser::pageWidth(), NSParser::pageWidth(), MSK3Parser::pageWidth(), WNParser::pageWidth(), ZWParser::pageWidth(), MSK4Zone::pageWidth(), MWProParser::pageWidth(), MWParser::pageWidth(), HMWJParser::pageWidth(), WPParser::pageWidth(), MDWParser::pageWidth(), CWParser::pageWidth(), FWParser::pageWidth(), MRWParser::pageWidth(), MSWParser::pageWidth(), HMWKParser::pageWidth(), and WPParser::readTable().
|
inline |
returns the right margin
Referenced by MWAWContentListener::_openPageSpan(), getPageProperty(), operator==(), EDParser::pageWidth(), LWParser::pageWidth(), MSW1Parser::pageWidth(), NSParser::pageWidth(), MSK3Parser::pageWidth(), WNParser::pageWidth(), ZWParser::pageWidth(), MSK4Zone::pageWidth(), MWProParser::pageWidth(), MWParser::pageWidth(), HMWJParser::pageWidth(), WPParser::pageWidth(), MDWParser::pageWidth(), CWParser::pageWidth(), FWParser::pageWidth(), MRWParser::pageWidth(), MSWParser::pageWidth(), and HMWKParser::pageWidth().
|
inline |
returns the top margin
Referenced by MWAWContentListener::_openPageSpan(), LWParser::getPageLeftTop(), NSParser::getPageLeftTop(), ZWParser::getPageLeftTop(), HMWJParser::getPageLeftTop(), CWParser::getPageLeftTop(), MRWParser::getPageLeftTop(), HMWKParser::getPageLeftTop(), getPageProperty(), MSK3Parser::getPageTopLeft(), MSK4Zone::getPageTopLeft(), operator==(), LWParser::pageHeight(), MSW1Parser::pageHeight(), NSParser::pageHeight(), MSK3Parser::pageHeight(), WNParser::pageHeight(), ZWParser::pageHeight(), MSK4Zone::pageHeight(), MWProParser::pageHeight(), MWParser::pageHeight(), HMWJParser::pageHeight(), MDWParser::pageHeight(), WPParser::pageHeight(), CWParser::pageHeight(), FWParser::pageHeight(), MRWParser::pageHeight(), MSWParser::pageHeight(), and HMWKParser::pageHeight().
|
inline |
Referenced by MWAWContentListener::_appendParagraphProperties(), and operator==().
|
inline |
Referenced by operator==().
|
inline |
Referenced by operator==().
|
inline |
Referenced by operator==().
|
inline |
Referenced by operator==().
|
protected |
Referenced by MWAWContentListener::_openPageSpan().
|
inline |
Referenced by MWAWContentListener::_openPageSpan(), and getPageProperty().
|
inline |
bool MWAWPageSpan::operator== | ( | shared_ptr< MWAWPageSpan > const & | pageSpan | ) | const |
Referenced by operator!=().
|
protected |
Referenced by MWAWContentListener::_openPageSpan().
|
inline |
set the background color
Referenced by MRWParser::createDocument(), and DMText::updatePageSpanList().
|
inline |
set the total page length
Referenced by MWProParser::readDocHeader(), CWParser::readDocHeader(), MSW1Parser::readDocInfo(), LWParser::readDocument(), MSWParser::readDocumentInfo(), MSWParser::readHeaderEndV3(), EDParser::readInfo(), NSParser::readPageLimit(), MWParser::readPrintInfo(), WPParser::readPrintInfo(), LWParser::readPrintInfo(), MDWParser::readPrintInfo(), NSParser::readPrintInfo(), MSWParser::readPrintInfo(), MSK3Parser::readPrintInfo(), CWParser::readPrintInfo(), WNParser::readPrintInfo(), MWProParser::readPrintInfo(), HMWJParser::readPrintInfo(), FWParser::readPrintInfo(), MRWParser::readPrintInfo(), HMWKParser::readPrintInfo(), and MSK4Zone::readPRNT().
|
inline |
set the form orientation
Referenced by MSWParser::readHeaderEndV3(), NSParser::readPageLimit(), MSWParser::readPrintInfo(), and MSK4Zone::readPRNT().
|
inline |
set the total page width
Referenced by MWProParser::readDocHeader(), CWParser::readDocHeader(), MSW1Parser::readDocInfo(), LWParser::readDocument(), MSWParser::readDocumentInfo(), MSWParser::readHeaderEndV3(), EDParser::readInfo(), NSParser::readPageLimit(), MWParser::readPrintInfo(), WPParser::readPrintInfo(), LWParser::readPrintInfo(), MDWParser::readPrintInfo(), NSParser::readPrintInfo(), MSWParser::readPrintInfo(), MSK3Parser::readPrintInfo(), CWParser::readPrintInfo(), WNParser::readPrintInfo(), MWProParser::readPrintInfo(), HMWJParser::readPrintInfo(), FWParser::readPrintInfo(), MRWParser::readPrintInfo(), HMWKParser::readPrintInfo(), and MSK4Zone::readPRNT().
void MWAWPageSpan::setHeaderFooter | ( | const HeaderFooterType | type, |
const HeaderFooterOccurence | occurence, | ||
MWAWSubDocumentPtr & | subDocument | ||
) |
add a header/footer on some page
Referenced by MSW1Parser::createDocument(), LWParser::createDocument(), NSParser::createDocument(), MWParser::createDocument(), MSK3Parser::createDocument(), MDWParser::createDocument(), WPParser::createDocument(), WNParser::createDocument(), MWProParser::createDocument(), ZWParser::createDocument(), CWParser::createDocument(), MSWParser::createDocument(), HMWJParser::createDocument(), MRWParser::createDocument(), HMWKParser::createDocument(), MSK4Zone::createListener(), and DMText::updatePageSpanList().
|
inline |
set the page bottom margin
Referenced by EDParser::init(), TTParser::init(), MSW1Parser::init(), LWParser::init(), MWParser::init(), NSParser::init(), MDWParser::init(), MSK3Parser::init(), WPParser::init(), WNParser::init(), MWProParser::init(), ZWParser::init(), CWParser::init(), MSWParser::init(), HMWJParser::init(), FWParser::init(), MRWParser::init(), HMWKParser::init(), MWProParser::readDocHeader(), CWParser::readDocHeader(), MRWParser::readDocInfo(), LWParser::readDocument(), MSWParser::readDocumentInfo(), MSWParser::readHeaderEndV3(), NSParser::readPageLimit(), MWParser::readPrintInfo(), WPParser::readPrintInfo(), LWParser::readPrintInfo(), MDWParser::readPrintInfo(), NSParser::readPrintInfo(), MSWParser::readPrintInfo(), ZWParser::readPrintInfo(), MSK3Parser::readPrintInfo(), CWParser::readPrintInfo(), WNParser::readPrintInfo(), MWProParser::readPrintInfo(), HMWJParser::readPrintInfo(), FWParser::readPrintInfo(), MRWParser::readPrintInfo(), HMWKParser::readPrintInfo(), MSK4Zone::readPRNT(), and DMText::updatePageSpanList().
|
inline |
set the page left margin
Referenced by EDParser::init(), TTParser::init(), MSW1Parser::init(), LWParser::init(), MWParser::init(), NSParser::init(), MDWParser::init(), MSK3Parser::init(), WPParser::init(), WNParser::init(), MWProParser::init(), ZWParser::init(), CWParser::init(), MSWParser::init(), HMWJParser::init(), FWParser::init(), MRWParser::init(), HMWKParser::init(), MWProParser::readDocHeader(), CWParser::readDocHeader(), MSW1Parser::readDocInfo(), MRWParser::readDocInfo(), LWParser::readDocument(), MSWParser::readDocumentInfo(), MSWParser::readHeaderEndV3(), NSParser::readPageLimit(), MWParser::readPrintInfo(), WPParser::readPrintInfo(), LWParser::readPrintInfo(), MDWParser::readPrintInfo(), NSParser::readPrintInfo(), MSWParser::readPrintInfo(), ZWParser::readPrintInfo(), MSK3Parser::readPrintInfo(), CWParser::readPrintInfo(), WNParser::readPrintInfo(), MWProParser::readPrintInfo(), HMWJParser::readPrintInfo(), FWParser::readPrintInfo(), MRWParser::readPrintInfo(), HMWKParser::readPrintInfo(), MSK4Zone::readPRNT(), and DMText::updatePageSpanList().
|
inline |
set the page right margin
Referenced by EDParser::init(), TTParser::init(), MSW1Parser::init(), LWParser::init(), MWParser::init(), NSParser::init(), MDWParser::init(), MSK3Parser::init(), WPParser::init(), WNParser::init(), MWProParser::init(), ZWParser::init(), CWParser::init(), MSWParser::init(), HMWJParser::init(), FWParser::init(), MRWParser::init(), HMWKParser::init(), MWProParser::readDocHeader(), CWParser::readDocHeader(), MRWParser::readDocInfo(), LWParser::readDocument(), MSWParser::readDocumentInfo(), MSWParser::readHeaderEndV3(), NSParser::readPageLimit(), MWParser::readPrintInfo(), WPParser::readPrintInfo(), LWParser::readPrintInfo(), MDWParser::readPrintInfo(), NSParser::readPrintInfo(), MSWParser::readPrintInfo(), ZWParser::readPrintInfo(), MSK3Parser::readPrintInfo(), CWParser::readPrintInfo(), WNParser::readPrintInfo(), MWProParser::readPrintInfo(), HMWJParser::readPrintInfo(), FWParser::readPrintInfo(), MRWParser::readPrintInfo(), HMWKParser::readPrintInfo(), MSK4Zone::readPRNT(), and DMText::updatePageSpanList().
|
inline |
set the page top margin
Referenced by EDParser::init(), TTParser::init(), MSW1Parser::init(), LWParser::init(), MWParser::init(), NSParser::init(), MDWParser::init(), MSK3Parser::init(), WPParser::init(), WNParser::init(), MWProParser::init(), ZWParser::init(), CWParser::init(), MSWParser::init(), HMWJParser::init(), FWParser::init(), MRWParser::init(), HMWKParser::init(), MWProParser::readDocHeader(), CWParser::readDocHeader(), MSW1Parser::readDocInfo(), MRWParser::readDocInfo(), LWParser::readDocument(), MSWParser::readDocumentInfo(), MSWParser::readHeaderEndV3(), NSParser::readPageLimit(), MWParser::readPrintInfo(), WPParser::readPrintInfo(), LWParser::readPrintInfo(), MDWParser::readPrintInfo(), NSParser::readPrintInfo(), MSWParser::readPrintInfo(), ZWParser::readPrintInfo(), MSK3Parser::readPrintInfo(), CWParser::readPrintInfo(), WNParser::readPrintInfo(), MWProParser::readPrintInfo(), HMWJParser::readPrintInfo(), FWParser::readPrintInfo(), MRWParser::readPrintInfo(), HMWKParser::readPrintInfo(), MSK4Zone::readPRNT(), and DMText::updatePageSpanList().
|
inline |
Referenced by DMText::updatePageSpanList().
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
friend |
|
private |
Referenced by backgroundColor(), getPageProperty(), and setBackgroundColor().
|
private |
Referenced by checkMargins(), getFormLength(), operator==(), and setFormLength().
|
private |
Referenced by getFormOrientation(), operator==(), and setFormOrientation().
|
private |
Referenced by checkMargins(), getFormWidth(), operator==(), and setFormWidth().
|
private |
|
private |
Referenced by checkMargins(), getMarginBottom(), and setMarginBottom().
|
private |
Referenced by checkMargins(), getMarginLeft(), and setMarginLeft().
|
private |
Referenced by checkMargins(), getMarginRight(), and setMarginRight().
|
private |
Referenced by checkMargins(), getMarginTop(), and setMarginTop().
|
private |
Referenced by getPageNumber(), and setPageNumber().
|
private |
Referenced by _insertPageNumberParagraph(), getPageNumberingFontName(), and setPageNumberingFontName().
|
private |
Referenced by _insertPageNumberParagraph(), getPageNumberingFontSize(), and setPageNumberingFontSize().
|
private |
Referenced by _insertPageNumberParagraph(), getPageNumberingType(), and setPageNumberingType().
|
private |
Referenced by _insertPageNumberParagraph(), getPageNumberPosition(), sendHeaderFooters(), and setPageNumberPosition().
|
private |
Referenced by getPageSpan(), and setPageSpan().