Go to the documentation of this file.
34 #ifndef MWAWPAGESPAN_H
35 #define MWAWPAGESPAN_H
215 if (margin < 0.0) margin = 0.01;
273 bool operator==(std::shared_ptr<MWAWPageSpan>
const &pageSpan)
const;
275 bool operator!=(std::shared_ptr<MWAWPageSpan>
const &pageSpan)
const
282 void getPageProperty(librevenge::RVNGPropertyList &pList,
bool isPresentation=
false)
const;
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:47
MWAWVariable< Justification > m_justify
the justification
Definition: MWAWParagraph.hxx:167
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:551
@ BottomLeft
Definition: MWAWPageSpan.hxx:105
@ PORTRAIT
Definition: MWAWPageSpan.hxx:102
@ BottomCenter
Definition: MWAWPageSpan.hxx:105
bool containsHeaderFooter(MWAWHeaderFooter::Type type, MWAWHeaderFooter::Occurrence occurrence)
return true if we have a header footer in this position
Definition: MWAWPageSpan.cxx:387
MWAWPageSpan()
constructor
Definition: MWAWPageSpan.cxx:209
void setPageSpan(const int pageSpan)
set the page span ( default 1)
Definition: MWAWPageSpan.hxx:268
int m_pageNumber
the page number ( or -1)
Definition: MWAWPageSpan.hxx:310
virtual void setFont(MWAWFont const &font)=0
sets the font
#define MWAW_DEBUG_MSG(M)
Definition: libmwaw_internal.hxx:129
librevenge::RVNGString const & getMasterPageName() const
return the page master name
Definition: MWAWPageSpan.hxx:253
NumberingType
Definition: libmwaw_internal.hxx:180
Internal: the structures of a MWAWPageSpan.
Definition: MWAWPageSpan.cxx:45
double m_formWidth
the form width
Definition: MWAWPageSpan.hxx:296
static MWAWColor white()
return the white color
Definition: libmwaw_internal.hxx:250
bool operator!=(MWAWSubDocument const &doc) const final
operator!=
Definition: MWAWPageSpan.cxx:62
@ BottomBit
Definition: libmwaw_internal.hxx:178
void setMarginBottom(const double marginBottom)
set the page bottom margin
Definition: MWAWPageSpan.hxx:208
MWAWPageSpan(MWAWPageSpan const &)=default
the class to store a color
Definition: libmwaw_internal.hxx:192
double m_formLength
the form length
Definition: MWAWPageSpan.hxx:296
std::shared_ptr< MWAWSubDocument > MWAWSubDocumentPtr
a smart pointer of MWAWSubDocument
Definition: libmwaw_internal.hxx:565
bool operator!=(std::shared_ptr< MWAWPageSpan > const &pageSpan) const
operator!=
Definition: MWAWPageSpan.hxx:275
int getPageNumber() const
Definition: MWAWPageSpan.hxx:166
class to store the paragraph properties
Definition: MWAWParagraph.hxx:85
void setFormOrientation(const FormOrientation formOrientation)
set the form orientation
Definition: MWAWPageSpan.hxx:188
void setMarginLeft(const double marginLeft)
set the page left margin
Definition: MWAWPageSpan.hxx:193
std::string str() const
print the color in the form #rrggbb
Definition: libmwaw_internal.cxx:232
double m_margins[4]
the margins: libmwaw::Left, ...
Definition: MWAWPageSpan.hxx:298
#define MWAW_FALLTHROUGH
Definition: libmwaw_internal.hxx:118
void parse(MWAWListenerPtr &listener, libmwaw::SubDocumentType type) final
the parser function
Definition: MWAWPageSpan.cxx:79
int getHeaderFooterPosition(MWAWHeaderFooter::Type type, MWAWHeaderFooter::Occurrence occurrence)
return the header footer positions in m_headerFooterList
Definition: MWAWPageSpan.cxx:394
virtual void insertEOL(bool softBreak=false)=0
adds an end of line ( by default an hard one)
double getPageWidth() const
returns the page width (form width without margin )
Definition: MWAWPageSpan.hxx:157
@ TopLeft
Definition: MWAWPageSpan.hxx:104
abstract class used to store a subdocument (with a comparison function)
Definition: MWAWSubDocument.hxx:42
int m_pageSpan
the number of page
Definition: MWAWPageSpan.hxx:312
double getMarginLeft() const
returns the left margin
Definition: MWAWPageSpan.hxx:132
void getPageProperty(librevenge::RVNGPropertyList &pList, bool isPresentation=false) const
add the page properties in pList
Definition: MWAWPageSpan.cxx:310
std::shared_ptr< MWAWHeaderFooter > MWAWHeaderFooterPtr
Definition: MWAWPageSpan.hxx:95
MWAWColor m_backgroundColor
the page background color: default white
Definition: MWAWPageSpan.hxx:306
libmwaw::NumberingType m_numberingType
the number type ( for number field )
Definition: libmwaw_internal.hxx:422
virtual void insertField(MWAWField const &field)=0
adds a field type
void setFormLength(const double formLength)
set the total page length
Definition: MWAWPageSpan.hxx:178
void setMasterPageName(librevenge::RVNGString const &name)
set the page master name
Definition: MWAWPageSpan.hxx:243
int getPageSpan() const
Definition: MWAWPageSpan.hxx:170
SubDocumentType
Definition: libmwaw_internal.hxx:188
PageNumberPosition
a fixed page number position
Definition: MWAWPageSpan.hxx:104
void setBackgroundColor(MWAWColor color=MWAWColor::white())
set the background color
Definition: MWAWPageSpan.hxx:258
double getMarginRight() const
returns the right margin
Definition: MWAWPageSpan.hxx:137
@ JustificationCenter
Definition: MWAWParagraph.hxx:90
bool hasPageName() const
return true if the page has a name
Definition: MWAWPageSpan.hxx:233
double getMarginTop() const
returns the top margin
Definition: MWAWPageSpan.hxx:142
void sendHeaderFooters(MWAWListener *listener) const
send the page's headers/footers if some exists
Definition: MWAWPageSpan.cxx:283
@ Bottom
Definition: libmwaw_internal.hxx:176
This class contains a virtual interface to all listener.
Definition: MWAWListener.hxx:50
@ None
Definition: MWAWPageSpan.hxx:104
void setFormWidth(const double formWidth)
set the total page width
Definition: MWAWPageSpan.hxx:183
MWAWPageSpan & operator=(MWAWPageSpan &&)=default
virtual bool insertHeader(MWAWSubDocumentPtr const &subDocument, librevenge::RVNGPropertyList const &extras)=0
insert a header (interaction with MWAWPageSpan which fills the parameters for openHeader)
virtual void setParagraph(MWAWParagraph const ¶graph)=0
sets the paragraph
double getPageLength() const
returns the page length (form width without margin )
Definition: MWAWPageSpan.hxx:152
MWAWColor backgroundColor() const
returns the background color
Definition: MWAWPageSpan.hxx:162
double getFormWidth() const
returns the page width
Definition: MWAWPageSpan.hxx:122
bool hasMasterPageName() const
return true if the masterPage has a name
Definition: MWAWPageSpan.hxx:248
@ RightBit
Definition: libmwaw_internal.hxx:178
@ ARABIC
Definition: libmwaw_internal.hxx:180
void removeHeaderFooter(MWAWHeaderFooter::Type type, MWAWHeaderFooter::Occurrence occurrence)
remove a header footer
Definition: MWAWPageSpan.cxx:380
@ TopCenter
Definition: MWAWPageSpan.hxx:104
a field
Definition: libmwaw_internal.hxx:399
@ PageNumber
Definition: libmwaw_internal.hxx:401
void setMarginTop(const double marginTop)
set the page top margin
Definition: MWAWPageSpan.hxx:203
@ JustificationLeft
Definition: MWAWParagraph.hxx:90
virtual bool insertFooter(MWAWSubDocumentPtr const &subDocument, librevenge::RVNGPropertyList const &extras)=0
insert a footer (interaction with MWAWPageSpan which fills the parameters for openFooter)
void setPageName(librevenge::RVNGString const &name)
set the page name
Definition: MWAWPageSpan.hxx:228
@ Top
Definition: libmwaw_internal.hxx:176
double getMarginBottom() const
returns the bottom margin
Definition: MWAWPageSpan.hxx:147
bool operator==(std::shared_ptr< MWAWPageSpan > const &pageSpan) const
operator==
Definition: MWAWPageSpan.cxx:339
@ LeftBit
Definition: libmwaw_internal.hxx:178
SubDocument(MWAWHeaderFooter const &headerFooter)
constructor
Definition: MWAWPageSpan.cxx:52
void checkMargins()
check if the page margins are consistent with the page dimension, if not update them
Definition: MWAWPageSpan.cxx:271
FormOrientation
the page orientation
Definition: MWAWPageSpan.hxx:102
@ Right
Definition: libmwaw_internal.hxx:176
MWAWHeaderFooter const & m_headerFooter
the header footer
Definition: MWAWPageSpan.cxx:76
@ TopRight
Definition: MWAWPageSpan.hxx:104
librevenge::RVNGString m_masterName
the page master name
Definition: MWAWPageSpan.hxx:302
librevenge::RVNGString const & getPageName() const
return the page name
Definition: MWAWPageSpan.hxx:238
@ JustificationRight
Definition: MWAWParagraph.hxx:91
@ TopBit
Definition: libmwaw_internal.hxx:178
virtual bool isParagraphOpened() const =0
returns true if a paragraph or a list is opened
void setMarginRight(const double marginRight)
set the page right margin
Definition: MWAWPageSpan.hxx:198
void setHeaderFooter(MWAWHeaderFooter const &headerFooter)
add a header/footer on some page
Definition: MWAWPageSpan.cxx:227
@ Left
Definition: libmwaw_internal.hxx:176
~MWAWPageSpan()
destructor
Definition: MWAWPageSpan.cxx:223
namespace used to regroup all libwpd functions, enumerations which we have redefined for internal usa...
Definition: libmwaw_internal.cxx:51
librevenge::RVNGString m_name
the page name
Definition: MWAWPageSpan.hxx:300
bool isWhite() const
return true if the color is white
Definition: libmwaw_internal.hxx:289
std::shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:553
void setMargins(double margin, int wh=libmwaw::LeftBit|libmwaw::RightBit|libmwaw::TopBit|libmwaw::BottomBit)
set all the margins
Definition: MWAWPageSpan.hxx:213
@ BottomRight
Definition: MWAWPageSpan.hxx:105
Class to store font.
Definition: MWAWFont.hxx:44
std::vector< MWAWHeaderFooter > m_headerFooterList
the list of header
Definition: MWAWPageSpan.hxx:308
double getFormLength() const
returns the page length
Definition: MWAWPageSpan.hxx:117
FormOrientation getFormOrientation() const
returns the page orientation
Definition: MWAWPageSpan.hxx:127
FormOrientation m_formOrientation
the form orientation
Definition: MWAWPageSpan.hxx:304
Internal: the subdocument of a MWAWParser.
Definition: MWAWPageSpan.cxx:49
@ LANDSCAPE
Definition: MWAWPageSpan.hxx:102
void setPageNumber(const int pageNumber)
set the page number
Definition: MWAWPageSpan.hxx:263
MWAWPageSpan & operator=(MWAWPageSpan const &)=default
A class which defines the page properties.
Definition: MWAWPageSpan.hxx:99
~SubDocument() final
destructor
Definition: MWAWPageSpan.cxx:59
Generated on Fri Sep 18 2020 18:14:52 for libmwaw by
doxygen 1.8.20