Get started with patching up the Qt GUI docs
[profile/ivi/qtbase.git] / src / gui / text / qtextdocumentfragment.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
5 **
6 ** This file is part of the QtGui module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
16 **
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
20 **
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
28 **
29 ** Other Usage
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** conditions contained in a signed written agreement between you and Nokia.
32 **
33 **
34 **
35 **
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #ifndef QTEXTDOCUMENTFRAGMENT_H
43 #define QTEXTDOCUMENTFRAGMENT_H
44
45 #include <QtCore/qstring.h>
46
47 QT_BEGIN_HEADER
48
49 QT_BEGIN_NAMESPACE
50
51
52 class QTextStream;
53 class QTextDocument;
54 class QTextDocumentFragmentPrivate;
55 class QTextCursor;
56
57 class Q_GUI_EXPORT QTextDocumentFragment
58 {
59 public:
60     QTextDocumentFragment();
61     explicit QTextDocumentFragment(const QTextDocument *document);
62     explicit QTextDocumentFragment(const QTextCursor &range);
63     QTextDocumentFragment(const QTextDocumentFragment &rhs);
64     QTextDocumentFragment &operator=(const QTextDocumentFragment &rhs);
65     ~QTextDocumentFragment();
66
67     bool isEmpty() const;
68
69     QString toPlainText() const;
70 #ifndef QT_NO_TEXTHTMLPARSER
71     QString toHtml(const QByteArray &encoding = QByteArray()) const;
72 #endif // QT_NO_TEXTHTMLPARSER
73
74     static QTextDocumentFragment fromPlainText(const QString &plainText);
75 #ifndef QT_NO_TEXTHTMLPARSER
76     static QTextDocumentFragment fromHtml(const QString &html);
77     static QTextDocumentFragment fromHtml(const QString &html, const QTextDocument *resourceProvider);
78 #endif // QT_NO_TEXTHTMLPARSER
79
80 private:
81     QTextDocumentFragmentPrivate *d;
82     friend class QTextCursor;
83     friend class QTextDocumentWriter;
84 };
85
86 QT_END_NAMESPACE
87
88 QT_END_HEADER
89
90 #endif // QTEXTDOCUMENTFRAGMENT_H