MWAWPageSpan.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 -*- */

/* libmwaw
* 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 MWAWPAGESPAN_H
#define MWAWPAGESPAN_H

#include <vector>

#include "libmwaw_internal.hxx"

#include "MWAWFont.hxx"

class WPXPropertyList;

class MWAWContentListener;

class MWAWSubDocument;
typedef shared_ptr<MWAWSubDocument> MWAWSubDocumentPtr;

class MWAWHeaderFooter
{
public:
  enum Type { HEADER, FOOTER, UNDEF };
  enum Occurence { ODD, EVEN, ALL, NEVER };
  enum PageNumberPosition { None = 0, TopLeft, TopCenter, TopRight, BottomLeft, BottomCenter, BottomRight };

  MWAWHeaderFooter(Type const type=UNDEF, Occurence const occurence=NEVER);
  ~MWAWHeaderFooter();
  bool isDefined() const {
    return m_type != UNDEF;
  }
  void send(MWAWContentListener *listener) const;
  bool operator==(MWAWHeaderFooter const &headerFooter) const;
  bool operator!=(MWAWHeaderFooter const &headerFooter) const {
    return !operator==(headerFooter);
  }
  void insertPageNumberParagraph(MWAWContentListener *listener) const;

public:
  Type m_type;
  Occurence m_occurence;
  double m_height;
  PageNumberPosition m_pageNumberPosition;
  libmwaw::NumberingType m_pageNumberType;
  MWAWFont m_pageNumberFont;
  MWAWSubDocumentPtr m_subDocument;
};

typedef shared_ptr<MWAWHeaderFooter> MWAWHeaderFooterPtr;

class MWAWPageSpan
{
  friend class MWAWContentListener;
public:
  enum FormOrientation { PORTRAIT, LANDSCAPE };
  enum PageNumberPosition { None = 0, TopLeft, TopCenter, TopRight,
                            BottomLeft, BottomCenter, BottomRight
                          };
public:
  MWAWPageSpan();
  virtual ~MWAWPageSpan();

  double getFormLength() const {
    return m_formLength;
  }
  double getFormWidth() const {
    return m_formWidth;
  }
  FormOrientation getFormOrientation() const {
    return m_formOrientation;
  }
  double getMarginLeft() const {
    return m_margins[libmwaw::Left];
  }
  double getMarginRight() const {
    return m_margins[libmwaw::Right];
  }
  double getMarginTop() const {
    return m_margins[libmwaw::Top];
  }
  double getMarginBottom() const {
    return m_margins[libmwaw::Bottom];
  }
  double getPageLength() const {
    return m_formLength-m_margins[libmwaw::Top]-m_margins[libmwaw::Bottom];
  }
  double getPageWidth() const {
    return m_formWidth-m_margins[libmwaw::Left]-m_margins[libmwaw::Right];
  }
  MWAWColor backgroundColor() const {
    return m_backgroundColor;
  }
  int getPageNumber() const {
    return m_pageNumber;
  }
  int getPageSpan() const {
    return m_pageSpan;
  }

  void setHeaderFooter(MWAWHeaderFooter const &headerFooter);
  void setFormLength(const double formLength) {
    m_formLength = formLength;
  }
  void setFormWidth(const double formWidth) {
    m_formWidth = formWidth;
  }
  void setFormOrientation(const FormOrientation formOrientation) {
    m_formOrientation = formOrientation;
  }
  void setMarginLeft(const double marginLeft) {
    m_margins[libmwaw::Left] = (marginLeft > 0) ? marginLeft : 0.01;
  }
  void setMarginRight(const double marginRight) {
    m_margins[libmwaw::Right] = (marginRight > 0) ? marginRight : 0.01;
  }
  void setMarginTop(const double marginTop) {
    m_margins[libmwaw::Top] =(marginTop > 0) ? marginTop : 0.01;
  }
  void setMarginBottom(const double marginBottom) {
    m_margins[libmwaw::Bottom] = (marginBottom > 0) ? marginBottom : 0.01;
  }
  void setMargins(double margin, int wh=libmwaw::LeftBit|libmwaw::RightBit|libmwaw::TopBit|libmwaw::BottomBit) {
    if (margin <= 0.0) margin = 0.01;
    if (wh&libmwaw::LeftBit)
      m_margins[libmwaw::Left]=margin;
    if (wh&libmwaw::RightBit)
      m_margins[libmwaw::Right]=margin;
    if (wh&libmwaw::TopBit)
      m_margins[libmwaw::Top]=margin;
    if (wh&libmwaw::BottomBit)
      m_margins[libmwaw::Bottom]=margin;
  }
  void checkMargins();
  void setBackgroundColor(MWAWColor color=MWAWColor::white()) {
    m_backgroundColor=color;
  }
  void setPageNumber(const int pageNumber) {
    m_pageNumber = pageNumber;
  }
  void setPageSpan(const int pageSpan) {
    m_pageSpan = pageSpan;
  }
  bool operator==(shared_ptr<MWAWPageSpan> const &pageSpan) const;
  bool operator!=(shared_ptr<MWAWPageSpan> const &pageSpan) const {
    return !operator==(pageSpan);
  }
protected:
  // interface with MWAWContentListener
  void getPageProperty(WPXPropertyList &pList) const;
  void sendHeaderFooters(MWAWContentListener *listener) const;

protected:
  int getHeaderFooterPosition(MWAWHeaderFooter::Type type, MWAWHeaderFooter::Occurence occurence);
  void removeHeaderFooter(MWAWHeaderFooter::Type type, MWAWHeaderFooter::Occurence occurence);
  bool containsHeaderFooter(MWAWHeaderFooter::Type type, MWAWHeaderFooter::Occurence occurence);
private:
  double m_formLength, m_formWidth ;
  FormOrientation m_formOrientation;
  double m_margins[4];
  MWAWColor m_backgroundColor;
  int m_pageNumber;
  std::vector<MWAWHeaderFooter> m_headerFooterList;
  int m_pageSpan;
};

#endif
// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab: