MWAWHeaderFooter Class Reference

a class which stores the header/footer data More...

#include <MWAWPageSpan.hxx>

List of all members.

Public Types

enum  Type { HEADER, FOOTER, UNDEF }
 the header/footer type More...
enum  Occurence { ODD, EVEN, ALL, NEVER }
 the header/footer occurence in the file More...
enum  PageNumberPosition {
  None = 0, TopLeft, TopCenter, TopRight,
  BottomLeft, BottomCenter, BottomRight
}
 a fixed page number position More...

Public Member Functions

 MWAWHeaderFooter (Type const type=UNDEF, Occurence const occurence=NEVER)
 constructor
 ~MWAWHeaderFooter ()
 destructor
bool isDefined () const
 returns true if the header footer is defined
void send (MWAWContentListener *listener) const
 send to header to the listener
bool operator== (MWAWHeaderFooter const &headerFooter) const
 operator==
bool operator!= (MWAWHeaderFooter const &headerFooter) const
 operator!=
void insertPageNumberParagraph (MWAWContentListener *listener) const
 insert a page number

Public Attributes

Type m_type
 the type header/footer
Occurence m_occurence
 the actual occurence
double m_height
 the height ( if known )
PageNumberPosition m_pageNumberPosition
 the page number position ( or none)
libmwaw::NumberingType m_pageNumberType
 the page numbering type
MWAWFont m_pageNumberFont
 the page numbering font
MWAWSubDocumentPtr m_subDocument
 the document data

Detailed Description

a class which stores the header/footer data


Member Enumeration Documentation

the header/footer occurence in the file

Enumerator:
ODD 
EVEN 
ALL 
NEVER 

a fixed page number position

Enumerator:
None 
TopLeft 
TopCenter 
TopRight 
BottomLeft 
BottomCenter 
BottomRight 

the header/footer type

Enumerator:
HEADER 
FOOTER 
UNDEF 

Constructor & Destructor Documentation


Member Function Documentation

bool MWAWHeaderFooter::isDefined ( ) const [inline]

returns true if the header footer is defined

Referenced by MWAWPageSpan::sendHeaderFooters().

bool MWAWHeaderFooter::operator!= ( MWAWHeaderFooter const &  headerFooter) const [inline]

operator!=

bool MWAWHeaderFooter::operator== ( MWAWHeaderFooter const &  headerFooter) const

operator==

Referenced by operator!=().

void MWAWHeaderFooter::send ( MWAWContentListener listener) const

send to header to the listener

Referenced by MWAWPageSpan::sendHeaderFooters().


Member Data Documentation

the height ( if known )

Referenced by operator==().

the page numbering font

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


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