STOFFPageSpan.hxx
Go to the documentation of this file.
/* -*- Mode: C++; c-default-style: "k&r"; indent-tabs-mode: nil; tab-width: 2; c-basic-offset: 2 -*- */
/* libstaroffice
* Version: MPL 2.0 / LGPLv2+
*
* The contents of this file are subject to the Mozilla Public License Version
* 2.0 (the "License"); you may not use this file except in compliance with
* the License or as specified alternatively below. You may obtain a copy of
* the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* Major Contributor(s):
* Copyright (C) 2002 William Lachance (wrlach@gmail.com)
* Copyright (C) 2002,2004 Marc Maurer (uwog@uwog.net)
* Copyright (C) 2004-2006 Fridrich Strba (fridrich.strba@bluewin.ch)
* Copyright (C) 2006, 2007 Andrew Ziem
* Copyright (C) 2011, 2012 Alonso Laurent (alonso@loria.fr)
*
*
* All Rights Reserved.
*
* For minor contributions see the git repository.
*
* Alternatively, the contents of this file may be used under the terms of
* the GNU Lesser General Public License Version 2 or later (the "LGPLv2+"),
* in which case the provisions of the LGPLv2+ are applicable
* instead of those above.
*/
#ifndef STOFFPAGESPAN_H
#define STOFFPAGESPAN_H
#include <map>
#include <vector>
#include "libstaroffice_internal.hxx"
#include "STOFFFont.hxx"
#include "STOFFSection.hxx"
class STOFFListener;
class STOFFHeaderFooter
{
public:
enum Type { R_Left=0, R_Center, R_Right, R_All };
STOFFHeaderFooter()
{
}
~STOFFHeaderFooter()
{
}
bool operator==(STOFFHeaderFooter const &headerFooter) const;
bool operator!=(STOFFHeaderFooter const &headerFooter) const
{
return !operator==(headerFooter);
}
void send(STOFFListener *listener, bool header) const;
STOFFSubDocumentPtr m_subDocument[4];
};
class STOFFPageSpan
{
public:
enum ZoneType { Page=0, Header, Footer };
public:
STOFFPageSpan();
STOFFPageSpan(STOFFPageSpan const &)=default;
STOFFPageSpan(STOFFPageSpan &&)=default;
STOFFPageSpan &operator=(STOFFPageSpan const &)=default;
STOFFPageSpan &operator=(STOFFPageSpan &&)=default;
~STOFFPageSpan();
void addHeaderFooter(bool header, std::string const &occurrence, STOFFHeaderFooter const &hf);
bool operator==(std::shared_ptr<STOFFPageSpan> const &pageSpan) const;
bool operator!=(std::shared_ptr<STOFFPageSpan> const &pageSpan) const
{
return !operator==(pageSpan);
}
// interface with STOFFListener
void getPageProperty(librevenge::RVNGPropertyList &pList) const;
void sendHeaderFooters(STOFFListener *listener) const;
int m_pageSpan;
librevenge::RVNGPropertyList m_propertiesList[3];
std::map<std::string, STOFFHeaderFooter> m_occurrenceHFMap[2];
STOFFSection m_section;
int m_pageNumber;
};
#endif
// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
STOFFFont.hxx
STOFFSection.hxx
STOFFListener
This class contains a virtual interface to all listener.
Definition STOFFListener.hxx:51
STOFFPageSpan::operator=
STOFFPageSpan & operator=(STOFFPageSpan &&)=default
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::m_pageNumber
int m_pageNumber
the page number ( or -1)
Definition STOFFPageSpan.hxx:116
STOFFPageSpan::operator!=
bool operator!=(std::shared_ptr< STOFFPageSpan > const &pageSpan) const
operator!=
Definition STOFFPageSpan.hxx:95
STOFFPageSpan::getPageProperty
void getPageProperty(librevenge::RVNGPropertyList &pList) const
add the page properties in pList
Definition STOFFPageSpan.cxx:120
STOFFPageSpan::sendHeaderFooters
void sendHeaderFooters(STOFFListener *listener) const
send the page's headers/footers if some exists
Definition STOFFPageSpan.cxx:94
STOFFPageSpan::STOFFPageSpan
STOFFPageSpan(STOFFPageSpan &&)=default
STOFFPageSpan::ZoneType
ZoneType
the zone type
Definition STOFFPageSpan.hxx:79
STOFFPageSpan::Header
@ Header
Definition STOFFPageSpan.hxx:79
STOFFPageSpan::Footer
@ Footer
Definition STOFFPageSpan.hxx:79
STOFFPageSpan::Page
@ Page
Definition STOFFPageSpan.hxx:79
STOFFPageSpan::operator==
bool operator==(std::shared_ptr< STOFFPageSpan > const &pageSpan) const
operator==
Definition STOFFPageSpan.cxx:134
STOFFPageSpan::~STOFFPageSpan
~STOFFPageSpan()
destructor
Definition STOFFPageSpan.cxx:85
STOFFPageSpan::operator=
STOFFPageSpan & operator=(STOFFPageSpan const &)=default
STOFFPageSpan::STOFFPageSpan
STOFFPageSpan(STOFFPageSpan const &)=default
STOFFPageSpan::m_occurrenceHFMap
std::map< std::string, STOFFHeaderFooter > m_occurrenceHFMap[2]
the map occurrence to header/footer document
Definition STOFFPageSpan.hxx:112
STOFFPageSpan::m_pageSpan
int m_pageSpan
the number of page
Definition STOFFPageSpan.hxx:108
STOFFPageSpan::m_section
STOFFSection m_section
the main section
Definition STOFFPageSpan.hxx:114
STOFFPageSpan::STOFFPageSpan
STOFFPageSpan()
constructor
Definition STOFFPageSpan.cxx:75
STOFFPageSpan::m_propertiesList
librevenge::RVNGPropertyList m_propertiesList[3]
the document, header and footer property list
Definition STOFFPageSpan.hxx:110
STOFFSection
a class which stores section properties
Definition STOFFSection.hxx:46
libstaroffice_internal.hxx
STOFFSubDocumentPtr
std::shared_ptr< STOFFSubDocument > STOFFSubDocumentPtr
a smart pointer of STOFFSubDocument
Definition libstaroffice_internal.hxx:499