MWAWHeaderFooter Class Reference

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

#include <MWAWPageSpan.hxx>

Public Types

enum  Type { HEADER , FOOTER , UNDEF }
 the header/footer type More...
 
enum  Occurrence { ODD , EVEN , ALL , NEVER }
 the header/footer occurrence 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, Occurrence const occurrence=NEVER)
 constructor
 
 MWAWHeaderFooter (MWAWHeaderFooter const &)=default
 
MWAWHeaderFooteroperator= (MWAWHeaderFooter const &)=default
 
MWAWHeaderFooteroperator= (MWAWHeaderFooter &&)=default
 
 ~MWAWHeaderFooter ()
 destructor
 
bool isDefined () const
 returns true if the header footer is defined
 
void send (MWAWListener *listener) const
 send to header to the listener
 
bool operator== (MWAWHeaderFooter const &headerFooter) const
 operator==
 
bool operator!= (MWAWHeaderFooter const &headerFooter) const
 operator!=
 
void insertPageNumberParagraph (MWAWListener *listener) const
 insert a page number
 

Public Attributes

Type m_type
 the type header/footer
 
Occurrence m_occurrence
 the actual occurrence
 
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

◆ Occurrence

the header/footer occurrence in the file

Enumerator
ODD 
EVEN 
ALL 
NEVER 

◆ PageNumberPosition

a fixed page number position

Enumerator
None 
TopLeft 
TopCenter 
TopRight 
BottomLeft 
BottomCenter 
BottomRight 

◆ Type

the header/footer type

Enumerator
HEADER 
FOOTER 
UNDEF 

Constructor & Destructor Documentation

◆ MWAWHeaderFooter() [1/2]

MWAWHeaderFooter::MWAWHeaderFooter ( MWAWHeaderFooter::Type const  type = UNDEF,
MWAWHeaderFooter::Occurrence const  occurrence = NEVER 
)

constructor

◆ MWAWHeaderFooter() [2/2]

MWAWHeaderFooter::MWAWHeaderFooter ( MWAWHeaderFooter const &  )
default

◆ ~MWAWHeaderFooter()

MWAWHeaderFooter::~MWAWHeaderFooter ( )

destructor

Member Function Documentation

◆ insertPageNumberParagraph()

void MWAWHeaderFooter::insertPageNumberParagraph ( MWAWListener listener) const

insert a page number

Referenced by MWAWPageSpanInternal::SubDocument::parse().

◆ isDefined()

bool MWAWHeaderFooter::isDefined ( ) const
inline

returns true if the header footer is defined

◆ operator!=()

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

operator!=

◆ operator=() [1/2]

MWAWHeaderFooter & MWAWHeaderFooter::operator= ( MWAWHeaderFooter &&  )
default

◆ operator=() [2/2]

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

◆ operator==()

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

operator==

Referenced by operator!=().

◆ send()

void MWAWHeaderFooter::send ( MWAWListener listener) const

send to header to the listener

Member Data Documentation

◆ m_height

double MWAWHeaderFooter::m_height

the height ( if known )

Referenced by operator==().

◆ m_occurrence

Occurrence MWAWHeaderFooter::m_occurrence

the actual occurrence

Referenced by operator==(), send(), and MWAWPageSpan::setHeaderFooter().

◆ m_pageNumberFont

MWAWFont MWAWHeaderFooter::m_pageNumberFont

the page numbering font

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

◆ m_pageNumberPosition

PageNumberPosition MWAWHeaderFooter::m_pageNumberPosition

the page number position ( or none)

Referenced by insertPageNumberParagraph(), operator==(), MWAWPageSpanInternal::SubDocument::parse(), and send().

◆ m_pageNumberType

libmwaw::NumberingType MWAWHeaderFooter::m_pageNumberType

the page numbering type

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

◆ m_subDocument

◆ m_type

Type MWAWHeaderFooter::m_type

the type header/footer

Referenced by isDefined(), operator==(), send(), and MWAWPageSpan::setHeaderFooter().


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

Generated on Thu Jan 19 2023 00:00:00 for libmwaw by doxygen 1.9.6