Your IP : 216.73.216.48
/*
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_gui_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. (http://doc.trolltech.com/4.4/richtext-html-subset.htm)
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
AbstractMarkupBuilder *b = new TextHTMLBuilder();
MarkupDirector *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());
QFile.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_GUI_EXPORT TextHTMLBuilder : virtual public AbstractMarkupBuilder
{
public:
/**
Creates a new TextHTMLBuilder.
*/
TextHTMLBuilder();
virtual ~TextHTMLBuilder();
/* reimp */ void beginStrong();
/* reimp */ void endStrong();
/* reimp */ void beginEmph();
/* reimp */ void endEmph();
/* reimp */ void beginUnderline();
/* reimp */ void endUnderline();
/* reimp */ void beginStrikeout();
/* reimp */ void endStrikeout();
/* reimp */ void beginForeground( const QBrush &brush );
/* reimp */ void endForeground();
/* reimp */ void beginBackground( const QBrush &brush );
/* reimp */ void endBackground();
/* reimp */ void beginAnchor( const QString &href = QString(), const QString &name = QString() );
/* reimp */ void endAnchor();
// 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.
/* reimp */ void beginFontFamily( const QString &family );
/* reimp */ void endFontFamily();
/**
Begin a new font point size
@param size The new size to begin.
*/
/* reimp */ void beginFontPointSize( int size );
/* reimp */ void endFontPointSize();
/**
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
*/
/* reimp */ void beginParagraph( Qt::Alignment al = Qt::AlignLeft, qreal topMargin = 0.0, qreal bottomMargin = 0.0, qreal leftMargin = 0.0, qreal rightMargin = 0.0 );
/**
Begin a new header element.
@param level The new level to begin.
*/
/* reimp */ void beginHeader( int level );
/**
End a header element.
@param level The new level to end.
*/
/* reimp */ void endHeader( int level );
/* reimp */ void endParagraph();
/* reimp */ void addNewline();
/* reimp */ void insertHorizontalRule( int width = -1 );
/* reimp */ void insertImage( const QString &src, qreal width, qreal height );
/* reimp */ void beginList( QTextListFormat::Style type );
/* reimp */ void endList();
/* reimp */ void beginListItem();
/* reimp */ void endListItem();
/* reimp */ void beginSuperscript();
/* reimp */ void endSuperscript();
/* reimp */ void beginSubscript();
/* reimp */ void endSubscript();
/* reimp */ void beginTable( qreal cellpadding, qreal cellspacing, const QString &width );
/* reimp */ void beginTableRow();
/* reimp */ void beginTableHeaderCell( const QString &width, int colspan, int rowspan );
/* reimp */ void beginTableCell( const QString &width, int colspan, int rowspan );
/* reimp */ void endTable();
/* reimp */ void endTableRow();
/* reimp */ void endTableHeaderCell();
/* reimp */ void endTableCell();
/**
Reimplemented from AbstractMarkupBuilder.
This implementation escapes the text before appending so that
@verbatim
A sample <b>bold</b> word.
@endverbatim
becomes
@verbatim
A sample <b>bold</b> word.
@endverbatim
*/
/* reimp */ void appendLiteralText( const QString &text );
/**
Append @p text without escaping.
This is useful if extending MarkupDirector
*/
/* reimp */ void appendRawText( const QString &text );
/* reimp */ QString getResult();
private:
TextHTMLBuilderPrivate *d_ptr;
Q_DECLARE_PRIVATE( TextHTMLBuilder )
};
}
#endif