STOFFPageSpan Class Reference

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

#include <STOFFPageSpan.hxx>

Public Types

enum  ZoneType { Page =0 , Header , Footer }
 the zone type More...
 

Public Member Functions

 STOFFPageSpan ()
 constructor
 
 STOFFPageSpan (STOFFPageSpan const &)=default
 
 STOFFPageSpan (STOFFPageSpan &&)=default
 
STOFFPageSpanoperator= (STOFFPageSpan const &)=default
 
STOFFPageSpanoperator= (STOFFPageSpan &&)=default
 
 ~STOFFPageSpan ()
 destructor
 
void addHeaderFooter (bool header, std::string const &occurrence, STOFFHeaderFooter const &hf)
 add a header on some page: occurrence must be odd|right, even|left, first, last or all
 
bool operator== (std::shared_ptr< STOFFPageSpan > const &pageSpan) const
 operator==
 
bool operator!= (std::shared_ptr< STOFFPageSpan > const &pageSpan) const
 operator!=
 
void getPageProperty (librevenge::RVNGPropertyList &pList) const
 add the page properties in pList
 
void sendHeaderFooters (STOFFListener *listener) const
 send the page's headers/footers if some exists
 

Public Attributes

int m_pageSpan
 the number of page
 
librevenge::RVNGPropertyList m_propertiesList [3]
 the document, header and footer property list
 
std::map< std::string, STOFFHeaderFooterm_occurrenceHFMap [2]
 the map occurrence to header/footer document
 
STOFFSection m_section
 the main section
 
int m_pageNumber
 the page number ( or -1)
 

Detailed Description

A class which defines the page properties.

Member Enumeration Documentation

◆ ZoneType

the zone type

Enumerator
Page 
Header 
Footer 

Constructor & Destructor Documentation

◆ STOFFPageSpan() [1/3]

STOFFPageSpan::STOFFPageSpan ( )

constructor

◆ STOFFPageSpan() [2/3]

STOFFPageSpan::STOFFPageSpan ( STOFFPageSpan const & )
default

◆ STOFFPageSpan() [3/3]

STOFFPageSpan::STOFFPageSpan ( STOFFPageSpan && )
default

◆ ~STOFFPageSpan()

STOFFPageSpan::~STOFFPageSpan ( )

destructor

Member Function Documentation

◆ addHeaderFooter()

void STOFFPageSpan::addHeaderFooter ( bool header,
std::string const & occurrence,
STOFFHeaderFooter const & hf )

add a header on some page: occurrence must be odd|right, even|left, first, last or all

◆ getPageProperty()

void STOFFPageSpan::getPageProperty ( librevenge::RVNGPropertyList & pList) const

◆ operator!=()

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

operator!=

◆ operator=() [1/2]

STOFFPageSpan & STOFFPageSpan::operator= ( STOFFPageSpan && )
default

◆ operator=() [2/2]

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

◆ operator==()

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

operator==

Referenced by operator!=().

◆ sendHeaderFooters()

void STOFFPageSpan::sendHeaderFooters ( STOFFListener * listener) const

send the page's headers/footers if some exists

Referenced by STOFFGraphicListener::_openPageSpan(), and STOFFSpreadsheetListener::_openPageSpan().

Member Data Documentation

◆ m_occurrenceHFMap

std::map<std::string, STOFFHeaderFooter> STOFFPageSpan::m_occurrenceHFMap[2]

the map occurrence to header/footer document

Referenced by addHeaderFooter(), operator==(), and sendHeaderFooters().

◆ m_pageNumber

int STOFFPageSpan::m_pageNumber

the page number ( or -1)

◆ m_pageSpan

◆ m_propertiesList

librevenge::RVNGPropertyList STOFFPageSpan::m_propertiesList[3]

◆ m_section

STOFFSection STOFFPageSpan::m_section

the main section


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

Generated on Mon Apr 22 2024 12:48:55 for libstaroffice by doxygen 1.10.0