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 More...
 
 ~STOFFPageSpan ()
 destructor More...
 
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 More...
 
bool operator== (std::shared_ptr< STOFFPageSpan > const &pageSpan) const
 operator== More...
 
bool operator!= (std::shared_ptr< STOFFPageSpan > const &pageSpan) const
 operator!= More...
 
void getPageProperty (librevenge::RVNGPropertyList &pList) const
 add the page properties in pList More...
 
void sendHeaderFooters (STOFFListener *listener) const
 send the page's headers/footers if some exists More...
 

Public Attributes

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

Detailed Description

A class which defines the page properties.

Member Enumeration Documentation

◆ ZoneType

the zone type

Enumerator
Page 
Header 
Footer 

Constructor & Destructor Documentation

◆ STOFFPageSpan()

STOFFPageSpan::STOFFPageSpan ( )

constructor

◆ ~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==()

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 Jan 20 2020 23:02:20 for libstaroffice by doxygen 1.8.16