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 
41 
42 #include "STOFFFont.hxx"
43 #include "STOFFSection.hxx"
44 
45 class STOFFListener;
46 
49 {
50 public:
52  enum Type { R_Left=0, R_Center, R_Right, R_All };
55  {
56  }
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;
72 };
73 
76 {
77 public:
79  enum ZoneType { Page=0, Header, Footer };
80 public:
82  STOFFPageSpan();
83  STOFFPageSpan(STOFFPageSpan const &)=default;
89 
91  void addHeaderFooter(bool header, std::string const &occurrence, STOFFHeaderFooter const &hf);
93  bool operator==(std::shared_ptr<STOFFPageSpan> const &pageSpan) const;
95  bool operator!=(std::shared_ptr<STOFFPageSpan> const &pageSpan) const
96  {
97  return !operator==(pageSpan);
98  }
99 
100  // interface with STOFFListener
101 
103  void getPageProperty(librevenge::RVNGPropertyList &pList) const;
105  void sendHeaderFooters(STOFFListener *listener) const;
106 
110  librevenge::RVNGPropertyList m_propertiesList[3];
112  std::map<std::string, STOFFHeaderFooter> m_occurrenceHFMap[2];
117 };
118 
119 #endif
120 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
a class which stores the header/footer
Definition: STOFFPageSpan.hxx:49
~STOFFHeaderFooter()
destructor
Definition: STOFFPageSpan.hxx:58
STOFFHeaderFooter()
constructor
Definition: STOFFPageSpan.hxx:54
bool operator==(STOFFHeaderFooter const &headerFooter) const
operator==
Definition: STOFFPageSpan.cxx:44
void send(STOFFListener *listener, bool header) const
send to header to the listener
Definition: STOFFPageSpan.cxx:57
bool operator!=(STOFFHeaderFooter const &headerFooter) const
operator!=
Definition: STOFFPageSpan.hxx:64
STOFFSubDocumentPtr m_subDocument[4]
the document data: left, center, right, all
Definition: STOFFPageSpan.hxx:71
Type
the different type
Definition: STOFFPageSpan.hxx:52
@ R_All
Definition: STOFFPageSpan.hxx:52
@ R_Right
Definition: STOFFPageSpan.hxx:52
@ R_Left
Definition: STOFFPageSpan.hxx:52
@ R_Center
Definition: STOFFPageSpan.hxx:52
This class contains a virtual interface to all listener.
Definition: STOFFListener.hxx:51
A class which defines the page properties.
Definition: STOFFPageSpan.hxx:76
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 & operator=(STOFFPageSpan &&)=default
int m_pageNumber
the page number ( or -1)
Definition: STOFFPageSpan.hxx:116
bool operator!=(std::shared_ptr< STOFFPageSpan > const &pageSpan) const
operator!=
Definition: STOFFPageSpan.hxx:95
void getPageProperty(librevenge::RVNGPropertyList &pList) const
add the page properties in pList
Definition: STOFFPageSpan.cxx:120
void sendHeaderFooters(STOFFListener *listener) const
send the page's headers/footers if some exists
Definition: STOFFPageSpan.cxx:94
STOFFPageSpan(STOFFPageSpan &&)=default
ZoneType
the zone type
Definition: STOFFPageSpan.hxx:79
@ Header
Definition: STOFFPageSpan.hxx:79
@ Footer
Definition: STOFFPageSpan.hxx:79
@ Page
Definition: STOFFPageSpan.hxx:79
bool operator==(std::shared_ptr< STOFFPageSpan > const &pageSpan) const
operator==
Definition: STOFFPageSpan.cxx:134
~STOFFPageSpan()
destructor
Definition: STOFFPageSpan.cxx:85
STOFFPageSpan(STOFFPageSpan const &)=default
std::map< std::string, STOFFHeaderFooter > m_occurrenceHFMap[2]
the map occurrence to header/footer document
Definition: STOFFPageSpan.hxx:112
int m_pageSpan
the number of page
Definition: STOFFPageSpan.hxx:108
STOFFPageSpan & operator=(STOFFPageSpan const &)=default
STOFFSection m_section
the main section
Definition: STOFFPageSpan.hxx:114
STOFFPageSpan()
constructor
Definition: STOFFPageSpan.cxx:75
librevenge::RVNGPropertyList m_propertiesList[3]
the document, header and footer property list
Definition: STOFFPageSpan.hxx:110
a class which stores section properties
Definition: STOFFSection.hxx:46
std::shared_ptr< STOFFSubDocument > STOFFSubDocumentPtr
a smart pointer of STOFFSubDocument
Definition: libstaroffice_internal.hxx:499

Generated on Wed Mar 15 2023 00:00:00 for libstaroffice by doxygen 1.9.1