textdocument/lib/texthtmlbuilder.h

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

  Copyright (c) 2008 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_TEXTHTMLBUILDER_H
#define GRANTLEE_TEXTHTMLBUILDER_H

#ifdef Q_CC_MSVC
#pragma warning(disable : 4250)
#endif

#include "abstractmarkupbuilder.h"
#include "grantlee_textdocument_export.h"
#include "markupdirector.h"

namespace Grantlee
{

class TextHTMLBuilderPrivate;


class GRANTLEE_TEXTDOCUMENT_EXPORT TextHTMLBuilder
    : virtual public AbstractMarkupBuilder
{
public:
  TextHTMLBuilder();
  ~TextHTMLBuilder() override;

  void beginStrong() override;
  void endStrong() override;
  void beginEmph() override;
  void endEmph() override;
  void beginUnderline() override;
  void endUnderline() override;
  void beginStrikeout() override;
  void endStrikeout() override;
  void beginForeground(const QBrush &brush) override;
  void endForeground() override;
  void beginBackground(const QBrush &brush) override;
  void endBackground() override;
  void beginAnchor(const QString &href = QString(),
                   const QString &name = QString()) override;
  void endAnchor() override;

  // Maybe this stuff should just be added to a list, and then when I add
  // literal text,
  // add some kind of style attribute in one span instead of many.
  void beginFontFamily(const QString &family) override;
  void endFontFamily() override;

  void beginFontPointSize(int size) override;
  void endFontPointSize() override;

  void beginParagraph(Qt::Alignment al = Qt::AlignLeft, qreal topMargin = 0.0,
                      qreal bottomMargin = 0.0, qreal leftMargin = 0.0,
                      qreal rightMargin = 0.0) override;

  void beginHeader(int level) override;

  void endHeader(int level) override;

  void endParagraph() override;
  void addNewline() override;

  void insertHorizontalRule(int width = -1) override;

  void insertImage(const QString &src, qreal width, qreal height) override;

  void beginList(QTextListFormat::Style type) override;

  void endList() override;

  void beginListItem() override;
  void endListItem() override;

  void beginSuperscript() override;

  void endSuperscript() override;

  void beginSubscript() override;

  void endSubscript() override;

  void beginTable(qreal cellpadding, qreal cellspacing,
                  const QString &width) override;

  void beginTableRow() override;
  void beginTableHeaderCell(const QString &width, int colspan,
                            int rowspan) override;

  void beginTableCell(const QString &width, int colspan, int rowspan) override;

  void endTable() override;
  void endTableRow() override;
  void endTableHeaderCell() override;
  void endTableCell() override;

  void appendLiteralText(const QString &text) override;

  void appendRawText(const QString &text) override;

  QString getResult() override;

private:
  TextHTMLBuilderPrivate *d_ptr;
  Q_DECLARE_PRIVATE(TextHTMLBuilder)
};
}

#endif