STOFFPageSpan Class Reference

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

#include <STOFFPageSpan.hxx>

List of all members.

Public Types

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

Public Member Functions

 STOFFPageSpan ()
 constructor
virtual ~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== (shared_ptr< STOFFPageSpan > const &pageSpan) const
 operator==
bool operator!= (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,
STOFFHeaderFooter
m_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

the zone type

Enumerator:
Page 
Header 
Footer 

Constructor & Destructor Documentation

destructor


Member Function Documentation

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

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

operator!=

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

operator==

Referenced by operator!=().


Member Data Documentation

the map occurrence to header/footer document

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

the page number ( or -1)


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