textdocument/lib/abstractmarkupbuilder.h

/*
  This file is part of the Grantlee template system.

  Copyright (c) 2008,2010 Stephen Kelly <steveire@gmail.com>

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either version
  2.1 of the Licence, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library.  If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef GRANTLEE_ABSTRACTMARKUPBUILDER_H
#define GRANTLEE_ABSTRACTMARKUPBUILDER_H

#include "grantlee_textdocument_export.h"

#include <QtCore/QString>
#include <QtGui/QTextListFormat>

class QBrush;

namespace Grantlee
{

class AbstractMarkupBuilderPrivate;


class GRANTLEE_TEXTDOCUMENT_EXPORT AbstractMarkupBuilder
{
public:
  virtual ~AbstractMarkupBuilder() {}

  virtual void beginStrong() = 0;

  virtual void endStrong() = 0;

  virtual void beginEmph() = 0;

  virtual void endEmph() = 0;

  virtual void beginUnderline() = 0;

  virtual void endUnderline() = 0;

  virtual void beginStrikeout() = 0;

  virtual void endStrikeout() = 0;

  virtual void beginForeground(const QBrush &brush) = 0;

  virtual void endForeground() = 0;

  virtual void beginBackground(const QBrush &brush) = 0;

  virtual void endBackground() = 0;

  virtual void beginAnchor(const QString &href = QString(),
                           const QString &name = QString())
      = 0;

  virtual void endAnchor() = 0;

  virtual void beginFontFamily(const QString &family) = 0;

  virtual void endFontFamily() = 0;

  virtual void beginFontPointSize(int size) = 0;

  virtual void endFontPointSize() = 0;

  virtual void beginParagraph(Qt::Alignment a = Qt::AlignLeft, qreal top = 0.0,
                              qreal bottom = 0.0, qreal left = 0.0,
                              qreal right = 0.0)
      = 0;

  virtual void endParagraph() = 0;
  virtual void addNewline() = 0;

  virtual void insertHorizontalRule(int width = -1) = 0;

  virtual void insertImage(const QString &url, qreal width, qreal height) = 0;

  virtual void beginList(QTextListFormat::Style style) = 0;

  virtual void endList() = 0;

  virtual void beginListItem() = 0;

  virtual void endListItem() = 0;

  virtual void beginSuperscript() = 0;

  virtual void endSuperscript() = 0;

  virtual void beginSubscript() = 0;

  virtual void endSubscript() = 0;

  virtual void beginTable(qreal cellpadding, qreal cellspacing,
                          const QString &width)
      = 0;

  virtual void beginTableRow() = 0;

  virtual void beginTableHeaderCell(const QString &width, int colSpan,
                                    int rowSpan)
      = 0;

  virtual void beginTableCell(const QString &width, int colSpan, int rowSpan)
      = 0;

  virtual void endTable() = 0;

  virtual void endTableRow() = 0;

  virtual void endTableHeaderCell() = 0;

  virtual void endTableCell() = 0;

  virtual void beginHeader(int level) = 0;

  virtual void endHeader(int level) = 0;

  virtual void appendLiteralText(const QString &text) = 0;

  virtual void appendRawText(const QString &text) = 0;

  virtual QString getResult() = 0;
};
}

#endif