STOFFPageSpan.hxx Source File documentation

STOFFPageSpan.hxx
Go to the documentation of this file.
1 /* -*- Mode: C++; c-default-style: "k&r"; indent-tabs-mode: nil; tab-width: 2; c-basic-offset: 2 -*- */
2
3 /* libstaroffice
4 * Version: MPL 2.0 / LGPLv2+
5 *
6 * The contents of this file are subject to the Mozilla Public License Version
7 * 2.0 (the "License"); you may not use this file except in compliance with
8 * the License or as specified alternatively below. You may obtain a copy of
9 * the License at http://www.mozilla.org/MPL/
10 *
11 * Software distributed under the License is distributed on an "AS IS" basis,
12 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13 * for the specific language governing rights and limitations under the
14 * License.
15 *
16 * Major Contributor(s):
17 * Copyright (C) 2002 William Lachance (wrlach@gmail.com)
18 * Copyright (C) 2002,2004 Marc Maurer (uwog@uwog.net)
19 * Copyright (C) 2004-2006 Fridrich Strba (fridrich.strba@bluewin.ch)
20 * Copyright (C) 2006, 2007 Andrew Ziem
21 * Copyright (C) 2011, 2012 Alonso Laurent (alonso@loria.fr)
22 *
23 *
24 * All Rights Reserved.
25 *
26 * For minor contributions see the git repository.
27 *
28 * Alternatively, the contents of this file may be used under the terms of
29 * the GNU Lesser General Public License Version 2 or later (the "LGPLv2+"),
30 * in which case the provisions of the LGPLv2+ are applicable
31 * instead of those above.
32 */
33
34 #ifndef STOFFPAGESPAN_H
35 #define STOFFPAGESPAN_H
36
37 #include <map>
38 #include <vector>
39
40 #include "libstaroffice_internal.hxx"
41
42 #include "STOFFFont.hxx"
43 #include "STOFFSection.hxx"
44
45 class STOFFListener;
46
48 class STOFFHeaderFooter
49 {
50 public:
52 enum Type { R_Left=0, R_Center, R_Right, R_All };
54 STOFFHeaderFooter()
55 {
56 }
58 ~STOFFHeaderFooter()
59 {
60 }
62 bool operator==(STOFFHeaderFooter const &headerFooter) const;
64 bool operator!=(STOFFHeaderFooter const &headerFooter) const
65 {
66 return !operator==(headerFooter);
67 }
69 void send(STOFFListener *listener, bool header) const;
71 STOFFSubDocumentPtr m_subDocument[4];
72 };
73
75 class STOFFPageSpan
76 {
77 public:
79 enum ZoneType { Page=0, Header, Footer };
80 public:
82 STOFFPageSpan();
84 ~STOFFPageSpan();
85
87 void addHeaderFooter(bool header, std::string const &occurrence, STOFFHeaderFooter const &hf);
89 bool operator==(std::shared_ptr<STOFFPageSpan> const &pageSpan) const;
91 bool operator!=(std::shared_ptr<STOFFPageSpan> const &pageSpan) const
92 {
93 return !operator==(pageSpan);
94 }
95
96 // interface with STOFFListener
97
99 void getPageProperty(librevenge::RVNGPropertyList &pList) const;
101 void sendHeaderFooters(STOFFListener *listener) const;
102
104 int m_pageSpan;
106 librevenge::RVNGPropertyList m_propertiesList[3];
108 std::map<std::string, STOFFHeaderFooter> m_occurrenceHFMap[2];
110 STOFFSection m_section;
112 int m_pageNumber;
113 };
114
115 #endif
116 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
STOFFSection.hxx
STOFFFont.hxx
STOFFPageSpan::m_pageSpan
int m_pageSpan
the number of page
Definition: STOFFPageSpan.hxx:104
STOFFHeaderFooter::send
void send(STOFFListener *listener, bool header) const
send to header to the listener
Definition: STOFFPageSpan.cxx:57
STOFFPageSpan::m_section
STOFFSection m_section
the main section
Definition: STOFFPageSpan.hxx:110
STOFFHeaderFooter::operator!=
bool operator!=(STOFFHeaderFooter const &headerFooter) const
operator!=
Definition: STOFFPageSpan.hxx:64
STOFFPageSpan::m_occurrenceHFMap
std::map< std::string, STOFFHeaderFooter > m_occurrenceHFMap[2]
the map occurrence to header/footer document
Definition: STOFFPageSpan.hxx:108
STOFFHeaderFooter::R_All
Definition: STOFFPageSpan.hxx:52
STOFFPageSpan::operator!=
bool operator!=(std::shared_ptr< STOFFPageSpan > const &pageSpan) const
operator!=
Definition: STOFFPageSpan.hxx:91
STOFFPageSpan::Footer
Definition: STOFFPageSpan.hxx:79
STOFFHeaderFooter
a class which stores the header/footer
Definition: STOFFPageSpan.hxx:48
STOFFPageSpan::addHeaderFooter
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 ...
Definition: STOFFPageSpan.cxx:89
STOFFPageSpan::~STOFFPageSpan
~STOFFPageSpan()
destructor
Definition: STOFFPageSpan.cxx:85
STOFFPageSpan::STOFFPageSpan
STOFFPageSpan()
constructor
Definition: STOFFPageSpan.cxx:75
STOFFPageSpan::Page
Definition: STOFFPageSpan.hxx:79
STOFFPageSpan::getPageProperty
void getPageProperty(librevenge::RVNGPropertyList &pList) const
add the page properties in pList
Definition: STOFFPageSpan.cxx:120
STOFFPageSpan::Header
Definition: STOFFPageSpan.hxx:79
STOFFHeaderFooter::R_Right
Definition: STOFFPageSpan.hxx:52
STOFFPageSpan::ZoneType
ZoneType
the zone type
Definition: STOFFPageSpan.hxx:79
STOFFPageSpan::m_propertiesList
librevenge::RVNGPropertyList m_propertiesList[3]
the document, header and footer property list
Definition: STOFFPageSpan.hxx:106
STOFFSubDocumentPtr
std::shared_ptr< STOFFSubDocument > STOFFSubDocumentPtr
a smart pointer of STOFFSubDocument
Definition: libstaroffice_internal.hxx:494
STOFFPageSpan::operator==
bool operator==(std::shared_ptr< STOFFPageSpan > const &pageSpan) const
operator==
Definition: STOFFPageSpan.cxx:134
STOFFPageSpan::sendHeaderFooters
void sendHeaderFooters(STOFFListener *listener) const
send the page&#39;s headers/footers if some exists
Definition: STOFFPageSpan.cxx:94
STOFFSection
a class which stores section properties
Definition: STOFFSection.hxx:45
STOFFHeaderFooter::Type
Type
the different type
Definition: STOFFPageSpan.hxx:52
STOFFHeaderFooter::R_Left
Definition: STOFFPageSpan.hxx:52
libstaroffice_internal.hxx
STOFFPageSpan::m_pageNumber
int m_pageNumber
the page number ( or -1)
Definition: STOFFPageSpan.hxx:112
STOFFHeaderFooter::STOFFHeaderFooter
STOFFHeaderFooter()
constructor
Definition: STOFFPageSpan.hxx:54
STOFFHeaderFooter::m_subDocument
STOFFSubDocumentPtr m_subDocument[4]
the document data: left, center, right, all
Definition: STOFFPageSpan.hxx:71
STOFFPageSpan
A class which defines the page properties.
Definition: STOFFPageSpan.hxx:75
STOFFHeaderFooter::~STOFFHeaderFooter
~STOFFHeaderFooter()
destructor
Definition: STOFFPageSpan.hxx:58
STOFFListener
This class contains a virtual interface to all listener.
Definition: STOFFListener.hxx:50
STOFFHeaderFooter::operator==
bool operator==(STOFFHeaderFooter const &headerFooter) const
operator==
Definition: STOFFPageSpan.cxx:44
STOFFHeaderFooter::R_Center
Definition: STOFFPageSpan.hxx:52