/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */

/* libwps

 * Version: MPL 2.0 / LGPLv2.1+

 *

 * This Source Code Form is subject to the terms of the Mozilla Public

 * License, v. 2.0. If a copy of the MPL was not distributed with this

 * file, You can obtain one at http://mozilla.org/MPL/2.0/.

 *

 * Major Contributor(s):

 * Copyright (C) 2002 William Lachance (william.lachance@sympatico.ca)

 * Copyright (C) 2002 Marc Maurer (uwog@uwog.net)

 * Copyright (C) 2006 Fridrich Strba (fridrich.strba@bluewin.ch)

 *

 * 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.1 or later

 * (LGPLv2.1+), in which case the provisions of the LGPLv2.1+ are

 * applicable instead of those above.

 *

 * For further information visit http://libwps.sourceforge.net

 */

#ifndef WPSPAGESPAN_H

#define WPSPAGESPAN_H

#include <vector>

#include "libwps_internal.h"

class WKSContentListener;

class WPSContentListener;

namespace WPSPageSpanInternal

{

class HeaderFooter;

typedef std::shared_ptr<HeaderFooter> HeaderFooterPtr;

}

class WPSPageSpan

{

public:

  enum FormOrientation { PORTRAIT, LANDSCAPE };

  enum HeaderFooterType { HEADER, FOOTER };

  enum HeaderFooterOccurrence { ODD, EVEN, ALL, FIRST, NEVER };

  enum PageNumberPosition { None = 0, TopLeft, TopCenter, TopRight, TopLeftAndRight, TopInsideLeftAndRight,

                            BottomLeft, BottomCenter, BottomRight, BottomLeftAndRight, BottomInsideLeftAndRight

                          };

public:

  //! constructor

  WPSPageSpan();

  WPSPageSpan(WPSPageSpan const &)=default;

  WPSPageSpan(WPSPageSpan &&)=default;

  WPSPageSpan &operator=(WPSPageSpan const &)=default;

  WPSPageSpan &operator=(WPSPageSpan &&)=default;

  //! destructor

  ~WPSPageSpan();

  double getFormLength() const

  {

    return m_formLength;

  }

  double getFormWidth() const

  {

    return m_formWidth;

  }

  FormOrientation getFormOrientation() const

  {

    return m_formOrientation;

  }

  double getMarginLeft() const

  {

    return m_marginLeft;

  }

  double getMarginRight() const

  {

    return m_marginRight;

  }

  double getMarginTop() const

  {

    return m_marginTop;

  }

  double getMarginBottom() const

  {

    return m_marginBottom;

  }

  PageNumberPosition getPageNumberPosition() const

  {

    return m_pageNumberPosition;

  }

  int getPageNumber() const

  {

    return m_pageNumber;

  }

  libwps::NumberingType getPageNumberingType() const

  {

    return m_pageNumberingType;

  }

  double getPageNumberingFontSize() const

  {

    return m_pageNumberingFontSize;

  }

  librevenge::RVNGString getPageNumberingFontName() const

  {

    return m_pageNumberingFontName;

  }

  int getPageSpan() const

  {

    return m_pageSpan;

  }

  const std::vector<WPSPageSpanInternal::HeaderFooterPtr> &getHeaderFooterList() const

  {

    return m_headerFooterList;

  }

  void setHeaderFooter(const HeaderFooterType type, const HeaderFooterOccurrence occurrence,

                       WPSSubDocumentPtr &subDocument);

  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_marginLeft = marginLeft;

  }

  void setMarginRight(const double marginRight)

  {

    m_marginRight = marginRight;

  }

  void setMarginTop(const double marginTop)

  {

    m_marginTop = marginTop;

  }

  void setMarginBottom(const double marginBottom)

  {

    m_marginBottom = marginBottom;

  }

  void setPageNumberPosition(const PageNumberPosition pageNumberPosition)

  {

    m_pageNumberPosition = pageNumberPosition;

  }

  void setPageNumber(const int pageNumber)

  {

    m_pageNumber = pageNumber;

  }

  void setPageNumberingType(const libwps::NumberingType pageNumberingType)

  {

    m_pageNumberingType = pageNumberingType;

  }

  void setPageNumberingFontSize(const double pageNumberingFontSize)

  {

    m_pageNumberingFontSize = pageNumberingFontSize;

  }

  void setPageNumberingFontName(const librevenge::RVNGString &pageNumberingFontName)

  {

    m_pageNumberingFontName = pageNumberingFontName;

  }

  void setPageSpan(const int pageSpan)

  {

    m_pageSpan = pageSpan;

  }

  bool operator==(std::shared_ptr<WPSPageSpan> const &pageSpan) const;

  bool operator!=(std::shared_ptr<WPSPageSpan> const &pageSpan) const

  {

    return !operator==(pageSpan);

  }

  // interface with the listeners

  void getPageProperty(librevenge::RVNGPropertyList &pList) const;

  void sendHeaderFooters(WPSContentListener *listener, librevenge::RVNGTextInterface *documentInterface);

  void sendHeaderFooters(WKSContentListener *listener, librevenge::RVNGSpreadsheetInterface *documentInterface);

protected:

  int _getHeaderFooterPosition(HeaderFooterType type, HeaderFooterOccurrence occurrence);

  void _setHeaderFooter(HeaderFooterType type, HeaderFooterOccurrence occurrence, WPSSubDocumentPtr &doc);

  void _removeHeaderFooter(HeaderFooterType type, HeaderFooterOccurrence occurrence);

  bool _containsHeaderFooter(HeaderFooterType type, HeaderFooterOccurrence occurrence);

  void _insertPageNumberParagraph(librevenge::RVNGTextInterface *documentInterface);

private:

  double m_formLength, m_formWidth;

  FormOrientation m_formOrientation;

  double m_marginLeft, m_marginRight;

  double m_marginTop, m_marginBottom;

  PageNumberPosition m_pageNumberPosition;

  int m_pageNumber;

  libwps::NumberingType m_pageNumberingType;

  librevenge::RVNGString m_pageNumberingFontName;

  double m_pageNumberingFontSize;

  std::vector<WPSPageSpanInternal::HeaderFooterPtr> m_headerFooterList;

  int m_pageSpan;

};

#endif

/* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */