MWAWListener.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 MWAW_LISTENER_H
#define MWAW_LISTENER_H

#include <vector>

#include <librevenge/librevenge.h>

#include "libmwaw_internal.hxx"

#include "MWAWGraphicStyle.hxx"

class MWAWCell;
class MWAWTable;

class MWAWListener
{
public:
  virtual ~MWAWListener() {}

  enum Type { Graphic, Presentation, Spreadsheet, Text };
  enum BreakType { PageBreak=0, SoftPageBreak, ColumnBreak };

  //------- generic accessor ---
  virtual Type getType() const = 0;
  virtual bool canWriteText() const =0;

  // ------ main document -------
  virtual void setDocumentLanguage(std::string locale) = 0;
  virtual void startDocument() = 0;
  virtual bool isDocumentStarted() const =0;
  virtual void endDocument(bool sendDelayedSubDoc=true) = 0;

  // ------ page --------
  virtual bool isPageSpanOpened() const = 0;
  virtual MWAWPageSpan const &getPageSpan() = 0;

  // ------ header/footer --------
  virtual bool insertHeader(MWAWSubDocumentPtr subDocument, librevenge::RVNGPropertyList const &extras) = 0;
  virtual bool insertFooter(MWAWSubDocumentPtr subDocument, librevenge::RVNGPropertyList const &extras) = 0;
  virtual bool isHeaderFooterOpened() const = 0;

  // ------ text data -----------
  virtual void insertChar(uint8_t character)=0;
  virtual void insertCharacter(unsigned char c)=0;
  virtual int insertCharacter(unsigned char c, MWAWInputStreamPtr &input, long endPos=-1)=0;
  virtual void insertUnicode(uint32_t character)=0;
  virtual void insertUnicodeString(librevenge::RVNGString const &str)=0;

  virtual void insertTab()=0;
  virtual void insertEOL(bool softBreak=false)=0;

  // ------ text format -----------
  virtual void setFont(MWAWFont const &font)=0;
  virtual MWAWFont const &getFont() const=0;

  // ------ paragraph format -----------
  virtual bool isParagraphOpened() const=0;
  virtual void setParagraph(MWAWParagraph const &paragraph)=0;
  virtual MWAWParagraph const &getParagraph() const=0;

  // ------- fields ----------------
  virtual void insertField(MWAWField const &field)=0;

  // ------- link ----------------

  virtual void openLink(MWAWLink const &link)=0;
  virtual void closeLink()=0;

  // ------- table -----------------
  virtual void openTable(MWAWTable const &table) = 0;
  virtual void closeTable() = 0;
  virtual void openTableRow(float h, librevenge::RVNGUnit unit, bool headerRow=false) = 0;
  virtual void closeTableRow() = 0;
  virtual void openTableCell(MWAWCell const &cell) = 0;
  virtual void closeTableCell() = 0;
  virtual void addEmptyTableCell(MWAWVec2i const &pos, MWAWVec2i span=MWAWVec2i(1,1)) = 0;

  // ------- section ---------------
  virtual bool canOpenSectionAddBreak() const =0;
  virtual bool isSectionOpened() const=0;
  virtual MWAWSection const &getSection() const=0;
  virtual bool openSection(MWAWSection const &section)=0;
  virtual bool closeSection()=0;
  virtual void insertBreak(BreakType breakType)=0;

  // ------- subdocument ---------------
  virtual void insertNote(MWAWNote const &note, MWAWSubDocumentPtr &subDocument)=0;
  virtual void insertComment(MWAWSubDocumentPtr &subDocument) = 0;
  virtual void insertPicture(MWAWPosition const &pos, const librevenge::RVNGBinaryData &binaryData,
                             std::string type="image/pict", MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle()) = 0;
  virtual void insertPicture(MWAWPosition const &pos, MWAWGraphicShape const &shape,
                             MWAWGraphicStyle const &style) = 0;
  virtual void insertTextBox(MWAWPosition const &pos, MWAWSubDocumentPtr subDocument,
                             MWAWGraphicStyle const &frameStyle=MWAWGraphicStyle::emptyStyle()) = 0;
  virtual bool openFrame(MWAWPosition const &pos, MWAWGraphicStyle const &style=MWAWGraphicStyle::emptyStyle()) = 0;
  virtual void closeFrame() = 0;
  virtual void handleSubDocument(MWAWSubDocumentPtr subDocument, libmwaw::SubDocumentType subDocumentType) = 0;
  virtual bool isSubDocumentOpened(libmwaw::SubDocumentType &subdocType) const = 0;
};

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