WPSPageSpan Class Reference

#include <WPSPageSpan.h>

Public Types

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

Public Member Functions

 WPSPageSpan ()
 constructor
 
 WPSPageSpan (WPSPageSpan const &)=default
 
 WPSPageSpan (WPSPageSpan &&)=default
 
WPSPageSpanoperator= (WPSPageSpan const &)=default
 
WPSPageSpanoperator= (WPSPageSpan &&)=default
 
 ~WPSPageSpan ()
 destructor
 
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
 
librevenge::RVNGString getPageNumberingFontName () const
 
int getPageSpan () const
 
const std::vector< WPSPageSpanInternal::HeaderFooterPtr > & getHeaderFooterList () const
 
void setHeaderFooter (const HeaderFooterType type, const HeaderFooterOccurrence occurrence, 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 librevenge::RVNGString &pageNumberingFontName)
 
void setPageSpan (const int pageSpan)
 
bool operator== (std::shared_ptr< WPSPageSpan > const &pageSpan) const
 
bool operator!= (std::shared_ptr< WPSPageSpan > const &pageSpan) const
 
void getPageProperty (librevenge::RVNGPropertyList &pList) const
 
void sendHeaderFooters (WPSContentListener *listener, librevenge::RVNGTextInterface *documentInterface)
 
void sendHeaderFooters (WKSContentListener *listener, librevenge::RVNGSpreadsheetInterface *documentInterface)
 

Protected Member Functions

int _getHeaderFooterPosition (HeaderFooterType type, HeaderFooterOccurrence occurrence)
 
void _setHeaderFooter (HeaderFooterType type, HeaderFooterOccurrence occurrence, WPSSubDocumentPtr &doc)
 
void _removeHeaderFooter (HeaderFooterType type, HeaderFooterOccurrence occurrence)
 
bool _containsHeaderFooter (HeaderFooterType type, HeaderFooterOccurrence occurrence)
 
void _insertPageNumberParagraph (librevenge::RVNGTextInterface *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
 
librevenge::RVNGString m_pageNumberingFontName
 
double m_pageNumberingFontSize
 
std::vector< WPSPageSpanInternal::HeaderFooterPtrm_headerFooterList
 
int m_pageSpan
 

Member Enumeration Documentation

◆ FormOrientation

Enumerator
PORTRAIT 
LANDSCAPE 

◆ HeaderFooterOccurrence

Enumerator
ODD 
EVEN 
ALL 
FIRST 
NEVER 

◆ HeaderFooterType

Enumerator
HEADER 
FOOTER 

◆ PageNumberPosition

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

Constructor & Destructor Documentation

◆ WPSPageSpan() [1/3]

WPSPageSpan::WPSPageSpan ( )

constructor

◆ WPSPageSpan() [2/3]

WPSPageSpan::WPSPageSpan ( WPSPageSpan const & )
default

◆ WPSPageSpan() [3/3]

WPSPageSpan::WPSPageSpan ( WPSPageSpan && )
default

◆ ~WPSPageSpan()

WPSPageSpan::~WPSPageSpan ( )

destructor

Member Function Documentation

◆ _containsHeaderFooter()

bool WPSPageSpan::_containsHeaderFooter ( HeaderFooterType type,
HeaderFooterOccurrence occurrence )
protected

Referenced by setHeaderFooter().

◆ _getHeaderFooterPosition()

int WPSPageSpan::_getHeaderFooterPosition ( HeaderFooterType type,
HeaderFooterOccurrence occurrence )
protected

◆ _insertPageNumberParagraph()

void WPSPageSpan::_insertPageNumberParagraph ( librevenge::RVNGTextInterface * documentInterface)
protected

Referenced by sendHeaderFooters().

◆ _removeHeaderFooter()

void WPSPageSpan::_removeHeaderFooter ( HeaderFooterType type,
HeaderFooterOccurrence occurrence )
protected

Referenced by setHeaderFooter().

◆ _setHeaderFooter()

void WPSPageSpan::_setHeaderFooter ( HeaderFooterType type,
HeaderFooterOccurrence occurrence,
WPSSubDocumentPtr & doc )
protected

Referenced by setHeaderFooter().

◆ getFormLength()

double WPSPageSpan::getFormLength ( ) const
inline

◆ getFormOrientation()

FormOrientation WPSPageSpan::getFormOrientation ( ) const
inline

Referenced by getPageProperty().

◆ getFormWidth()

double WPSPageSpan::getFormWidth ( ) const
inline

◆ getHeaderFooterList()

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

◆ getMarginBottom()

double WPSPageSpan::getMarginBottom ( ) const
inline

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

◆ getMarginLeft()

double WPSPageSpan::getMarginLeft ( ) const
inline

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

◆ getMarginRight()

double WPSPageSpan::getMarginRight ( ) const
inline

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

◆ getMarginTop()

double WPSPageSpan::getMarginTop ( ) const
inline

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

◆ getPageNumber()

int WPSPageSpan::getPageNumber ( ) const
inline

Referenced by operator==().

◆ getPageNumberingFontName()

librevenge::RVNGString 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 ( librevenge::RVNGPropertyList & pList) const

◆ getPageSpan()

int WPSPageSpan::getPageSpan ( ) const
inline

Referenced by getPageProperty().

◆ operator!=()

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

◆ operator=() [1/2]

WPSPageSpan & WPSPageSpan::operator= ( WPSPageSpan && )
default

◆ operator=() [2/2]

WPSPageSpan & WPSPageSpan::operator= ( WPSPageSpan const & )
default

◆ operator==()

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

Referenced by operator!=().

◆ sendHeaderFooters() [1/2]

void WPSPageSpan::sendHeaderFooters ( WKSContentListener * listener,
librevenge::RVNGSpreadsheetInterface * documentInterface )

◆ sendHeaderFooters() [2/2]

void WPSPageSpan::sendHeaderFooters ( WPSContentListener * listener,
librevenge::RVNGTextInterface * documentInterface )

◆ setFormLength()

void WPSPageSpan::setFormLength ( const double formLength)
inline

◆ setFormOrientation()

void WPSPageSpan::setFormOrientation ( const FormOrientation formOrientation)
inline

◆ setFormWidth()

void WPSPageSpan::setFormWidth ( const double formWidth)
inline

◆ setHeaderFooter()

void WPSPageSpan::setHeaderFooter ( const HeaderFooterType type,
const HeaderFooterOccurrence occurrence,
WPSSubDocumentPtr & subDocument )

◆ setMarginBottom()

void WPSPageSpan::setMarginBottom ( const double marginBottom)
inline

◆ setMarginLeft()

void WPSPageSpan::setMarginLeft ( const double marginLeft)
inline

◆ setMarginRight()

void WPSPageSpan::setMarginRight ( const double marginRight)
inline

◆ setMarginTop()

void WPSPageSpan::setMarginTop ( const double marginTop)
inline

◆ setPageNumber()

void WPSPageSpan::setPageNumber ( const int pageNumber)
inline

◆ setPageNumberingFontName()

void WPSPageSpan::setPageNumberingFontName ( const librevenge::RVNGString & 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

Member Data Documentation

◆ m_formLength

double WPSPageSpan::m_formLength
private

◆ m_formOrientation

FormOrientation WPSPageSpan::m_formOrientation
private

◆ m_formWidth

double WPSPageSpan::m_formWidth
private

◆ m_headerFooterList

◆ m_marginBottom

double WPSPageSpan::m_marginBottom
private

Referenced by getMarginBottom(), and setMarginBottom().

◆ m_marginLeft

double WPSPageSpan::m_marginLeft
private

Referenced by getMarginLeft(), and setMarginLeft().

◆ m_marginRight

double WPSPageSpan::m_marginRight
private

Referenced by getMarginRight(), and setMarginRight().

◆ m_marginTop

double WPSPageSpan::m_marginTop
private

Referenced by getMarginTop(), and setMarginTop().

◆ m_pageNumber

int WPSPageSpan::m_pageNumber
private

Referenced by getPageNumber(), and setPageNumber().

◆ m_pageNumberingFontName

librevenge::RVNGString WPSPageSpan::m_pageNumberingFontName
private

◆ m_pageNumberingFontSize

double WPSPageSpan::m_pageNumberingFontSize
private

◆ m_pageNumberingType

libwps::NumberingType WPSPageSpan::m_pageNumberingType
private

◆ m_pageNumberPosition

◆ m_pageSpan

int WPSPageSpan::m_pageSpan
private

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

Generated on Tue May 21 2024 12:30:44 for libwps by doxygen 1.10.0