qt-migration-legatus/qt6-after/qt6-migrated-legatus/include/grantlee/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;

/// @headerfile texthtmlbuilder.h grantlee/texthtmlbuilder.h

/**
  @brief The TextHTMLBuilder creates a clean html markup output.

  This class creates html output which is as minimal as possible and restricted
  to the rich text features supported in %Qt.
  (https://doc.qt.io/qt-5/richtext-html-subset.html)

  The output contains only the body content, not the head element or other
  metadata.

  eg:

  @code
    <p>
      This is some <strong>formatted content</strong> in a paragraph.
    </p>
  @endcode

  instead of the content produced by %Qt:

  @code
    <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN"
  "http://www.w3.org/TR/REC-html40/strict.dtd">
    <html><head><meta name="qrichtext" content="1" /><meta
  http-equiv="Content-Type" content="text/html; charset=UTF-8" /><style
  type="text/css">
    p, li { white-space: pre-wrap; }
    </style></head><body style=" font-family:'Sans Serif'; font-size:10pt;
  font-weight:400; font-style:normal;">
    <p style=" margin-top:12px; margin-bottom:12px; margin-left:0px;
  margin-right:0px; -qt-block-indent:0; text-indent:0px;">This is some <span
  style=" font-weight:600;">formatted content</span> in a paragraph.
  </p></body></html>
  @endcode

  Such tags should be created separately. For example:

  @code
    auto b = new TextHTMLBuilder();
    auto md = new MarkupDirector(b);
    md->constructContent();
    QString cleanHtml(
      "<head>\n<title>%1</title>\n</head>\n<body>%2</body>\n</html>")
                      .arg(document.metaInformation(QTextDocument::DocumentTitle))
                      .arg(b->getOutput());
    file.write(cleanHtml);
  @endcode

  Font formatting information on elements is represented by individual span
  elements.

  eg:
  @code
    <span style"color:blue;">
      <span style="background-color:red;">
        Blue text on red background
      </span>
    </span>
  @endcode

  instead of

  @code
    <span style="color:blue;background-color:red;">
      Blue text on red background
    </span>
  @endcode

  It my be possible to change this if necessary.

  @author Stephen Kelly <steveire@gmail.com>
*/
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 = {}, const QString &name = {}) 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;

  /**
    Begin a new font point size
    @param size The new size to begin.
  */
  void beginFontPointSize(int size) override;
  void endFontPointSize() override;

  /**
    Begin a new paragraph
    @param al The new paragraph alignment
    @param topMargin The new paragraph topMargin
    @param bottomMargin The new paragraph bottomMargin
    @param leftMargin The new paragraph leftMargin
    @param rightMargin The new paragraph rightMargin
  */
  void beginParagraph(Qt::Alignment al = Qt::AlignLeft, qreal topMargin = 0.0,
                      qreal bottomMargin = 0.0, qreal leftMargin = 0.0,
                      qreal rightMargin = 0.0) override;

  /**
    Begin a new header element.
    @param level The new level to begin.
  */
  void beginHeader(int level) override;

  /**
    End a header element.
    @param level The new level to end.
  */
  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;

  /**
    Reimplemented from AbstractMarkupBuilder.

    This implementation escapes the text before appending so that

    @verbatim
      A sample <b>bold</b> word.
    @endverbatim

    becomes

    @verbatim
      A sample &lt;b&gt;bold&lt;/b&gt; word.
    @endverbatim
  */
  void appendLiteralText(const QString &text) override;

  /**
    Append @p text without escaping.

    This is useful if extending MarkupDirector
  */
  void appendRawText(const QString &text) override;

  QString getResult() override;

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

#endif