MWAWPageSpan Class Reference

A class which defines the page properties. More...

#include <MWAWPageSpan.hxx>

Public Types

enum  FormOrientation { PORTRAIT, LANDSCAPE }
 the page orientation More...
 
enum  PageNumberPosition {
  None = 0, TopLeft, TopCenter, TopRight,
  BottomLeft, BottomCenter, BottomRight
}
 a fixed page number position More...
 

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...
 
double getPageLength () const
 returns the page length (form width without margin ) More...
 
double getPageWidth () const
 returns the page width (form width without margin ) More...
 
MWAWColor backgroundColor () const
 returns the background color More...
 
int getPageNumber () const
 
int getPageSpan () const
 
void setHeaderFooter (MWAWHeaderFooter const &headerFooter)
 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 setMargins (double margin, int wh=libmwaw::LeftBit|libmwaw::RightBit|libmwaw::TopBit|libmwaw::BottomBit)
 set all the margins More...
 
void checkMargins ()
 check if the page margins are consistent with the page dimension, if not update them More...
 
void setPageName (librevenge::RVNGString const &name)
 set the page name More...
 
bool hasPageName () const
 return true if the page has a name More...
 
librevenge::RVNGString const & getPageName () const
 return the page name More...
 
void setMasterPageName (librevenge::RVNGString const &name)
 set the page master name More...
 
bool hasMasterPageName () const
 return true if the masterPage has a name More...
 
librevenge::RVNGString const & getMasterPageName () const
 return the page master name More...
 
void setBackgroundColor (MWAWColor color=MWAWColor::white())
 set the background color More...
 
void setPageNumber (const int pageNumber)
 set the page number More...
 
void setPageSpan (const int pageSpan)
 set the page span ( default 1) More...
 
bool operator== (shared_ptr< MWAWPageSpan > const &pageSpan) const
 operator== More...
 
bool operator!= (shared_ptr< MWAWPageSpan > const &pageSpan) const
 operator!= More...
 
void getPageProperty (librevenge::RVNGPropertyList &pList) const
 add the page properties in pList More...
 
void sendHeaderFooters (MWAWListener *listener) const
 send the page's headers/footers if some exists More...
 
void sendHeaderFooters (MWAWListener *listener, MWAWHeaderFooter::Occurrence occurrence) const
 send the page's headers/footers corresponding to an occurrence if some exists More...
 

Protected Member Functions

int getHeaderFooterPosition (MWAWHeaderFooter::Type type, MWAWHeaderFooter::Occurrence occurrence)
 return the header footer positions in m_headerFooterList More...
 
void removeHeaderFooter (MWAWHeaderFooter::Type type, MWAWHeaderFooter::Occurrence occurrence)
 remove a header footer More...
 
bool containsHeaderFooter (MWAWHeaderFooter::Type type, MWAWHeaderFooter::Occurrence occurrence)
 return true if we have a header footer in this position More...
 

Private Attributes

double m_formLength
 the form length More...
 
double m_formWidth
 the form width More...
 
FormOrientation m_formOrientation
 the form orientation More...
 
double m_margins [4]
 the margins: libmwaw::Left, ... More...
 
librevenge::RVNGString m_name
 the page name More...
 
librevenge::RVNGString m_masterName
 the page master name More...
 
MWAWColor m_backgroundColor
 the page background color: default white More...
 
int m_pageNumber
 the page number ( or -1) More...
 
std::vector< MWAWHeaderFooterm_headerFooterList
 the list of header More...
 
int m_pageSpan
 the number of page More...
 

Detailed Description

A class which defines the page properties.

Member Enumeration Documentation

the page orientation

Enumerator
PORTRAIT 
LANDSCAPE 

a fixed page number position

Enumerator
None 
TopLeft 
TopCenter 
TopRight 
BottomLeft 
BottomCenter 
BottomRight 

Constructor & Destructor Documentation

MWAWPageSpan::MWAWPageSpan ( )

constructor

MWAWPageSpan::~MWAWPageSpan ( )
virtual

destructor

Member Function Documentation

MWAWColor MWAWPageSpan::backgroundColor ( ) const
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 MarinerWrtParser::readPrintInfo().

bool MWAWPageSpan::containsHeaderFooter ( MWAWHeaderFooter::Type  type,
MWAWHeaderFooter::Occurrence  occurrence 
)
protected

return true if we have a header footer in this position

Referenced by setHeaderFooter().

FormOrientation MWAWPageSpan::getFormOrientation ( ) const
inline

returns the page orientation

Referenced by getPageProperty().

int MWAWPageSpan::getHeaderFooterPosition ( MWAWHeaderFooter::Type  type,
MWAWHeaderFooter::Occurrence  occurrence 
)
protected

return the header footer positions in m_headerFooterList

Referenced by containsHeaderFooter(), removeHeaderFooter(), and setHeaderFooter().

double MWAWPageSpan::getMarginBottom ( ) const
inline

returns the bottom margin

Referenced by ClarisWksDocument::getFinalPageSpan(), getPageProperty(), and operator==().

double MWAWPageSpan::getMarginTop ( ) const
inline

returns the top margin

Referenced by getPageProperty(), operator==(), and GreatWksGraph::sendFrame().

librevenge::RVNGString const& MWAWPageSpan::getMasterPageName ( ) const
inline

return the page master name

Referenced by getPageProperty(), and operator==().

double MWAWPageSpan::getPageLength ( ) const
inline
librevenge::RVNGString const& MWAWPageSpan::getPageName ( ) const
inline

return the page name

Referenced by getPageProperty(), and operator==().

int MWAWPageSpan::getPageNumber ( ) const
inline

Referenced by operator==().

double MWAWPageSpan::getPageWidth ( ) const
inline
bool MWAWPageSpan::hasMasterPageName ( ) const
inline

return true if the masterPage has a name

Referenced by getPageProperty().

bool MWAWPageSpan::hasPageName ( ) const
inline

return true if the page has a name

Referenced by getPageProperty().

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

operator!=

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

operator==

Referenced by operator!=().

void MWAWPageSpan::removeHeaderFooter ( MWAWHeaderFooter::Type  type,
MWAWHeaderFooter::Occurrence  occurrence 
)
protected

remove a header footer

Referenced by setHeaderFooter().

void MWAWPageSpan::sendHeaderFooters ( MWAWListener listener) const
void MWAWPageSpan::sendHeaderFooters ( MWAWListener listener,
MWAWHeaderFooter::Occurrence  occurrence 
) const

send the page's headers/footers corresponding to an occurrence if some exists

void MWAWPageSpan::setBackgroundColor ( MWAWColor  color = MWAWColor::white())
inline
void MWAWPageSpan::setFormLength ( const double  formLength)
inline

set the total page length

Referenced by MacDrawProParser::computeLayersAndLibrariesBoundingBox(), MacDocParser::createZones(), MWAWGraphicListener::MWAWGraphicListener(), MWAWSpreadsheetListener::MWAWSpreadsheetListener(), MacDraftParser::readDocHeader(), ClarisDrawParser::readDocHeader(), MacWrtProParser::readDocHeader(), ClarisWksDocument::readDocHeader(), MsWrd1Parser::readDocInfo(), FullWrtParser::readDocInfo(), LightWayTxtParser::readDocument(), MoreParser::readDocumentInfo(), MsWrdParser::readDocumentInfo(), MsWks4Zone::readDOP(), MsWrdParser::readHeaderEndV3(), EDocParser::readInfo(), NisusWrtParser::readPageLimit(), SuperPaintParser::readPrintInfo(), MacDrawParser::readPrintInfo(), WingzParser::readPrintInfo(), MacWrtParser::readPrintInfo(), WriterPlsParser::readPrintInfo(), MacDrawProParser::readPrintInfo(), ActaParser::readPrintInfo(), LightWayTxtParser::readPrintInfo(), ClarisDrawParser::readPrintInfo(), MindWrtParser::readPrintInfo(), BeagleWksDBParser::readPrintInfo(), BeagleWksBMParser::readPrintInfo(), BeagleWksParser::readPrintInfo(), NisusWrtParser::readPrintInfo(), BeagleWksSSParser::readPrintInfo(), MoreParser::readPrintInfo(), FullWrtParser::readPrintInfo(), MsWrdParser::readPrintInfo(), GreatWksDocument::readPrintInfo(), BeagleWksDRParser::readPrintInfo(), WriteNowParser::readPrintInfo(), MacWrtProParser::readPrintInfo(), RagTimeParser::readPrintInfo(), HanMacWrdJParser::readPrintInfo(), ClarisWksDocument::readPrintInfo(), MarinerWrtParser::readPrintInfo(), HanMacWrdKParser::readPrintInfo(), MsWks4Zone::readPRNT(), and ClarisWksDocument::updateChildPositions().

void MWAWPageSpan::setFormOrientation ( const FormOrientation  formOrientation)
inline
void MWAWPageSpan::setFormWidth ( const double  formWidth)
inline

set the total page width

Referenced by MacDrawProParser::computeLayersAndLibrariesBoundingBox(), MacDocParser::createZones(), MWAWGraphicListener::MWAWGraphicListener(), MWAWSpreadsheetListener::MWAWSpreadsheetListener(), MacDraftParser::readDocHeader(), ClarisDrawParser::readDocHeader(), MacWrtProParser::readDocHeader(), ClarisWksDocument::readDocHeader(), MsWrd1Parser::readDocInfo(), FullWrtParser::readDocInfo(), LightWayTxtParser::readDocument(), MoreParser::readDocumentInfo(), MsWrdParser::readDocumentInfo(), MsWks4Zone::readDOP(), MsWrdParser::readHeaderEndV3(), EDocParser::readInfo(), NisusWrtParser::readPageLimit(), SuperPaintParser::readPrintInfo(), MacDrawParser::readPrintInfo(), WingzParser::readPrintInfo(), MacWrtParser::readPrintInfo(), WriterPlsParser::readPrintInfo(), MacDrawProParser::readPrintInfo(), ActaParser::readPrintInfo(), LightWayTxtParser::readPrintInfo(), ClarisDrawParser::readPrintInfo(), MindWrtParser::readPrintInfo(), BeagleWksDBParser::readPrintInfo(), BeagleWksBMParser::readPrintInfo(), BeagleWksParser::readPrintInfo(), NisusWrtParser::readPrintInfo(), BeagleWksSSParser::readPrintInfo(), MoreParser::readPrintInfo(), FullWrtParser::readPrintInfo(), MsWrdParser::readPrintInfo(), GreatWksDocument::readPrintInfo(), BeagleWksDRParser::readPrintInfo(), WriteNowParser::readPrintInfo(), MacWrtProParser::readPrintInfo(), RagTimeParser::readPrintInfo(), HanMacWrdJParser::readPrintInfo(), ClarisWksDocument::readPrintInfo(), MarinerWrtParser::readPrintInfo(), HanMacWrdKParser::readPrintInfo(), MsWks4Zone::readPRNT(), and ClarisWksDocument::updateChildPositions().

void MWAWPageSpan::setMarginBottom ( const double  marginBottom)
inline

set the page bottom margin

Referenced by ClarisWksDocument::getFinalPageSpan(), HanMacWrdKParser::init(), ClarisDrawParser::readDocHeader(), MacWrtProParser::readDocHeader(), ClarisWksDocument::readDocHeader(), GreatWksParser::readDocInfo(), FullWrtParser::readDocInfo(), MarinerWrtParser::readDocInfo(), LightWayTxtParser::readDocument(), BeagleWksStructManager::readDocumentInfo(), MoreParser::readDocumentInfo(), MsWrdParser::readDocumentInfo(), MsWks4Zone::readDOP(), MsWrdParser::readHeaderEndV3(), BeagleWksParser::readLastZone(), NisusWrtParser::readPageLimit(), SuperPaintParser::readPrintInfo(), MacDrawParser::readPrintInfo(), WingzParser::readPrintInfo(), MacWrtParser::readPrintInfo(), WriterPlsParser::readPrintInfo(), MacDrawProParser::readPrintInfo(), MacDraftParser::readPrintInfo(), ActaParser::readPrintInfo(), LightWayTxtParser::readPrintInfo(), ClarisDrawParser::readPrintInfo(), MindWrtParser::readPrintInfo(), BeagleWksDBParser::readPrintInfo(), BeagleWksBMParser::readPrintInfo(), NisusWrtParser::readPrintInfo(), BeagleWksParser::readPrintInfo(), BeagleWksSSParser::readPrintInfo(), MoreParser::readPrintInfo(), ZWrtParser::readPrintInfo(), FullWrtParser::readPrintInfo(), GreatWksDocument::readPrintInfo(), MsWrdParser::readPrintInfo(), BeagleWksDRParser::readPrintInfo(), WriteNowParser::readPrintInfo(), MacWrtProParser::readPrintInfo(), RagTimeParser::readPrintInfo(), ClarisWksDocument::readPrintInfo(), HanMacWrdJParser::readPrintInfo(), MarinerWrtParser::readPrintInfo(), HanMacWrdKParser::readPrintInfo(), MsWks4Zone::readPRNT(), and DocMkrText::updatePageSpanList().

void MWAWPageSpan::setMarginLeft ( const double  marginLeft)
inline

set the page left margin

Referenced by HanMacWrdKParser::init(), ClarisDrawParser::readDocHeader(), MacWrtProParser::readDocHeader(), ClarisWksDocument::readDocHeader(), GreatWksParser::readDocInfo(), MsWrd1Parser::readDocInfo(), FullWrtParser::readDocInfo(), MarinerWrtParser::readDocInfo(), LightWayTxtParser::readDocument(), BeagleWksStructManager::readDocumentInfo(), MoreParser::readDocumentInfo(), MsWrdParser::readDocumentInfo(), MsWks4Zone::readDOP(), MsWrdParser::readHeaderEndV3(), BeagleWksParser::readLastZone(), NisusWrtParser::readPageLimit(), SuperPaintParser::readPrintInfo(), MacDrawParser::readPrintInfo(), WingzParser::readPrintInfo(), MacWrtParser::readPrintInfo(), WriterPlsParser::readPrintInfo(), MacDrawProParser::readPrintInfo(), MacDraftParser::readPrintInfo(), ActaParser::readPrintInfo(), LightWayTxtParser::readPrintInfo(), ClarisDrawParser::readPrintInfo(), BeagleWksDBParser::readPrintInfo(), MindWrtParser::readPrintInfo(), BeagleWksBMParser::readPrintInfo(), BeagleWksParser::readPrintInfo(), NisusWrtParser::readPrintInfo(), BeagleWksSSParser::readPrintInfo(), MoreParser::readPrintInfo(), ZWrtParser::readPrintInfo(), FullWrtParser::readPrintInfo(), GreatWksDocument::readPrintInfo(), MsWrdParser::readPrintInfo(), BeagleWksDRParser::readPrintInfo(), WriteNowParser::readPrintInfo(), MacWrtProParser::readPrintInfo(), RagTimeParser::readPrintInfo(), ClarisWksDocument::readPrintInfo(), HanMacWrdJParser::readPrintInfo(), MarinerWrtParser::readPrintInfo(), HanMacWrdKParser::readPrintInfo(), MsWks4Zone::readPRNT(), and DocMkrText::updatePageSpanList().

void MWAWPageSpan::setMarginRight ( const double  marginRight)
inline

set the page right margin

Referenced by ClarisWksDocument::getFinalPageSpan(), HanMacWrdKParser::init(), ClarisDrawParser::readDocHeader(), MacWrtProParser::readDocHeader(), ClarisWksDocument::readDocHeader(), GreatWksParser::readDocInfo(), FullWrtParser::readDocInfo(), MarinerWrtParser::readDocInfo(), LightWayTxtParser::readDocument(), BeagleWksStructManager::readDocumentInfo(), MoreParser::readDocumentInfo(), MsWrdParser::readDocumentInfo(), MsWks4Zone::readDOP(), MsWrdParser::readHeaderEndV3(), BeagleWksParser::readLastZone(), NisusWrtParser::readPageLimit(), SuperPaintParser::readPrintInfo(), MacDrawParser::readPrintInfo(), WingzParser::readPrintInfo(), MacWrtParser::readPrintInfo(), WriterPlsParser::readPrintInfo(), MacDrawProParser::readPrintInfo(), MacDraftParser::readPrintInfo(), ActaParser::readPrintInfo(), LightWayTxtParser::readPrintInfo(), ClarisDrawParser::readPrintInfo(), MindWrtParser::readPrintInfo(), BeagleWksDBParser::readPrintInfo(), BeagleWksBMParser::readPrintInfo(), NisusWrtParser::readPrintInfo(), BeagleWksParser::readPrintInfo(), BeagleWksSSParser::readPrintInfo(), MoreParser::readPrintInfo(), ZWrtParser::readPrintInfo(), FullWrtParser::readPrintInfo(), GreatWksDocument::readPrintInfo(), MsWrdParser::readPrintInfo(), BeagleWksDRParser::readPrintInfo(), WriteNowParser::readPrintInfo(), MacWrtProParser::readPrintInfo(), RagTimeParser::readPrintInfo(), ClarisWksDocument::readPrintInfo(), HanMacWrdJParser::readPrintInfo(), MarinerWrtParser::readPrintInfo(), HanMacWrdKParser::readPrintInfo(), MsWks4Zone::readPRNT(), and DocMkrText::updatePageSpanList().

void MWAWPageSpan::setMarginTop ( const double  marginTop)
inline

set the page top margin

Referenced by HanMacWrdKParser::init(), ClarisDrawParser::readDocHeader(), MacWrtProParser::readDocHeader(), ClarisWksDocument::readDocHeader(), GreatWksParser::readDocInfo(), MsWrd1Parser::readDocInfo(), FullWrtParser::readDocInfo(), MarinerWrtParser::readDocInfo(), LightWayTxtParser::readDocument(), BeagleWksStructManager::readDocumentInfo(), MoreParser::readDocumentInfo(), MsWrdParser::readDocumentInfo(), MsWks4Zone::readDOP(), MsWrdParser::readHeaderEndV3(), BeagleWksParser::readLastZone(), NisusWrtParser::readPageLimit(), SuperPaintParser::readPrintInfo(), MacDrawParser::readPrintInfo(), WingzParser::readPrintInfo(), MacWrtParser::readPrintInfo(), WriterPlsParser::readPrintInfo(), MacDrawProParser::readPrintInfo(), MacDraftParser::readPrintInfo(), ActaParser::readPrintInfo(), LightWayTxtParser::readPrintInfo(), ClarisDrawParser::readPrintInfo(), BeagleWksDBParser::readPrintInfo(), MindWrtParser::readPrintInfo(), BeagleWksBMParser::readPrintInfo(), BeagleWksParser::readPrintInfo(), NisusWrtParser::readPrintInfo(), BeagleWksSSParser::readPrintInfo(), MoreParser::readPrintInfo(), ZWrtParser::readPrintInfo(), FullWrtParser::readPrintInfo(), GreatWksDocument::readPrintInfo(), MsWrdParser::readPrintInfo(), BeagleWksDRParser::readPrintInfo(), WriteNowParser::readPrintInfo(), MacWrtProParser::readPrintInfo(), RagTimeParser::readPrintInfo(), ClarisWksDocument::readPrintInfo(), HanMacWrdJParser::readPrintInfo(), MarinerWrtParser::readPrintInfo(), HanMacWrdKParser::readPrintInfo(), MsWks4Zone::readPRNT(), and DocMkrText::updatePageSpanList().

void MWAWPageSpan::setMasterPageName ( librevenge::RVNGString const &  name)
inline
void MWAWPageSpan::setPageName ( librevenge::RVNGString const &  name)
inline
void MWAWPageSpan::setPageNumber ( const int  pageNumber)
inline

set the page number

Referenced by DocMkrText::updatePageSpanList().

void MWAWPageSpan::setPageSpan ( const int  pageSpan)
inline

set the page span ( default 1)

Referenced by EDocParser::createDocument(), MacDocParser::createDocument(), TeachTxtParser::createDocument(), GreatWksDRParser::createDocument(), MacPaintParser::createDocument(), GreatWksParser::createDocument(), GreatWksBMParser::createDocument(), MsWrd1Parser::createDocument(), MacWrtParser::createDocument(), ActaParser::createDocument(), GreatWksSSParser::createDocument(), SuperPaintParser::createDocument(), MacDraftParser::createDocument(), MacDrawParser::createDocument(), BeagleWksBMParser::createDocument(), WingzParser::createDocument(), BeagleWksParser::createDocument(), LightWayTxtParser::createDocument(), BeagleWksDRParser::createDocument(), NisusWrtParser::createDocument(), BeagleWksDBParser::createDocument(), MindWrtParser::createDocument(), GreatWksDBParser::createDocument(), MacDrawProParser::createDocument(), BeagleWksSSParser::createDocument(), WriterPlsParser::createDocument(), FullWrtParser::createDocument(), MacWrtProParser::createDocument(), WriteNowParser::createDocument(), ClarisDrawParser::createDocument(), MoreParser::createDocument(), ZWrtParser::createDocument(), RagTimeParser::createDocument(), MsWrdParser::createDocument(), RagTime5Parser::createDocument(), HanMacWrdJParser::createDocument(), MarinerWrtParser::createDocument(), HanMacWrdKParser::createDocument(), MsWksDocument::getPageSpanList(), MWAWGraphicListener::MWAWGraphicListener(), MWAWSpreadsheetListener::MWAWSpreadsheetListener(), ClarisWksPresentation::updatePageSpanList(), ClarisWksText::updatePageSpanList(), and ClarisWksDocument::updatePageSpanList().

Member Data Documentation

MWAWColor MWAWPageSpan::m_backgroundColor
private

the page background color: default white

Referenced by backgroundColor(), getPageProperty(), and setBackgroundColor().

double MWAWPageSpan::m_formLength
private
FormOrientation MWAWPageSpan::m_formOrientation
private

the form orientation

Referenced by getFormOrientation(), operator==(), and setFormOrientation().

double MWAWPageSpan::m_formWidth
private
std::vector<MWAWHeaderFooter> MWAWPageSpan::m_headerFooterList
private
librevenge::RVNGString MWAWPageSpan::m_masterName
private

the page master name

Referenced by getMasterPageName(), hasMasterPageName(), and setMasterPageName().

librevenge::RVNGString MWAWPageSpan::m_name
private

the page name

Referenced by getPageName(), hasPageName(), and setPageName().

int MWAWPageSpan::m_pageNumber
private

the page number ( or -1)

Referenced by getPageNumber(), and setPageNumber().

int MWAWPageSpan::m_pageSpan
private

the number of page

Referenced by getPageSpan(), and setPageSpan().


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

Generated on Thu Jul 9 2015 20:26:39 for libmwaw by doxygen 1.8.8