Files
renderdoc/qrenderdoc/3rdparty/qt/include/QtGui/qtextdocument.h
T
baldurk 768e812e45 Commit binary dependencies necessary for compilation on windows
* On windows it's strongly desired to be able to compile straight out of
  a clean checkout or source download. This means anyone can download
  the source and investigate something quickly, without having to worry
  about the hassle of figuring out how the project downloads 3rd party
  dependencies, fetching them, getting them registered in the right
  place.
* This can't be put in a submodule as git submodules don't get
  downloaded by default so people new to git will get confusing
  compilation messages, and someone downloading the source from github
  directly without cloning via git won't get submodules included.
* It does add some extra size to a fresh download/checkout which is
  unfortunate, but absolutely worth the cost. Shallow checkouts still
  aren't unfeasibly large, and it's only a one-off cost at clone time.
2018-02-02 20:49:35 +00:00

309 lines
9.5 KiB
C++

/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtGui module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QTEXTDOCUMENT_H
#define QTEXTDOCUMENT_H
#include <QtGui/qtguiglobal.h>
#include <QtCore/qobject.h>
#include <QtCore/qsize.h>
#include <QtCore/qrect.h>
#include <QtCore/qvariant.h>
#include <QtGui/qfont.h>
#include <QtCore/qurl.h>
QT_BEGIN_NAMESPACE
class QTextFormatCollection;
class QTextListFormat;
class QRect;
class QPainter;
class QPagedPaintDevice;
class QAbstractTextDocumentLayout;
class QPoint;
class QTextObject;
class QTextFormat;
class QTextFrame;
class QTextBlock;
class QTextCodec;
class QVariant;
class QRectF;
class QTextOption;
class QTextCursor;
template<typename T> class QVector;
namespace Qt
{
Q_GUI_EXPORT bool mightBeRichText(const QString&);
Q_GUI_EXPORT QString convertFromPlainText(const QString &plain, WhiteSpaceMode mode = WhiteSpacePre);
#ifndef QT_NO_TEXTCODEC
Q_GUI_EXPORT QTextCodec *codecForHtml(const QByteArray &ba);
#endif
}
class Q_GUI_EXPORT QAbstractUndoItem
{
public:
virtual ~QAbstractUndoItem() = 0;
virtual void undo() = 0;
virtual void redo() = 0;
};
inline QAbstractUndoItem::~QAbstractUndoItem()
{
}
class QTextDocumentPrivate;
class Q_GUI_EXPORT QTextDocument : public QObject
{
Q_OBJECT
Q_PROPERTY(bool undoRedoEnabled READ isUndoRedoEnabled WRITE setUndoRedoEnabled)
Q_PROPERTY(bool modified READ isModified WRITE setModified DESIGNABLE false)
Q_PROPERTY(QSizeF pageSize READ pageSize WRITE setPageSize)
Q_PROPERTY(QFont defaultFont READ defaultFont WRITE setDefaultFont)
Q_PROPERTY(bool useDesignMetrics READ useDesignMetrics WRITE setUseDesignMetrics)
Q_PROPERTY(QSizeF size READ size)
Q_PROPERTY(qreal textWidth READ textWidth WRITE setTextWidth)
Q_PROPERTY(int blockCount READ blockCount)
Q_PROPERTY(qreal indentWidth READ indentWidth WRITE setIndentWidth)
#ifndef QT_NO_CSSPARSER
Q_PROPERTY(QString defaultStyleSheet READ defaultStyleSheet WRITE setDefaultStyleSheet)
#endif
Q_PROPERTY(int maximumBlockCount READ maximumBlockCount WRITE setMaximumBlockCount)
Q_PROPERTY(qreal documentMargin READ documentMargin WRITE setDocumentMargin)
QDOC_PROPERTY(QTextOption defaultTextOption READ defaultTextOption WRITE setDefaultTextOption)
Q_PROPERTY(QUrl baseUrl READ baseUrl WRITE setBaseUrl NOTIFY baseUrlChanged)
public:
explicit QTextDocument(QObject *parent = Q_NULLPTR);
explicit QTextDocument(const QString &text, QObject *parent = Q_NULLPTR);
~QTextDocument();
QTextDocument *clone(QObject *parent = Q_NULLPTR) const;
bool isEmpty() const;
virtual void clear();
void setUndoRedoEnabled(bool enable);
bool isUndoRedoEnabled() const;
bool isUndoAvailable() const;
bool isRedoAvailable() const;
int availableUndoSteps() const;
int availableRedoSteps() const;
int revision() const;
void setDocumentLayout(QAbstractTextDocumentLayout *layout);
QAbstractTextDocumentLayout *documentLayout() const;
enum MetaInformation {
DocumentTitle,
DocumentUrl
};
void setMetaInformation(MetaInformation info, const QString &);
QString metaInformation(MetaInformation info) const;
#ifndef QT_NO_TEXTHTMLPARSER
QString toHtml(const QByteArray &encoding = QByteArray()) const;
void setHtml(const QString &html);
#endif
QString toRawText() const;
QString toPlainText() const;
void setPlainText(const QString &text);
QChar characterAt(int pos) const;
enum FindFlag
{
FindBackward = 0x00001,
FindCaseSensitively = 0x00002,
FindWholeWords = 0x00004
};
Q_DECLARE_FLAGS(FindFlags, FindFlag)
QTextCursor find(const QString &subString, int from = 0, FindFlags options = FindFlags()) const;
QTextCursor find(const QString &subString, const QTextCursor &cursor, FindFlags options = FindFlags()) const;
#ifndef QT_NO_REGEXP
QTextCursor find(const QRegExp &expr, int from = 0, FindFlags options = FindFlags()) const;
QTextCursor find(const QRegExp &expr, const QTextCursor &cursor, FindFlags options = FindFlags()) const;
#endif
#ifndef QT_NO_REGULAREXPRESSION
QTextCursor find(const QRegularExpression &expr, int from = 0, FindFlags options = FindFlags()) const;
QTextCursor find(const QRegularExpression &expr, const QTextCursor &cursor, FindFlags options = FindFlags()) const;
#endif
QTextFrame *frameAt(int pos) const;
QTextFrame *rootFrame() const;
QTextObject *object(int objectIndex) const;
QTextObject *objectForFormat(const QTextFormat &) const;
QTextBlock findBlock(int pos) const;
QTextBlock findBlockByNumber(int blockNumber) const;
QTextBlock findBlockByLineNumber(int blockNumber) const;
QTextBlock begin() const;
QTextBlock end() const;
QTextBlock firstBlock() const;
QTextBlock lastBlock() const;
void setPageSize(const QSizeF &size);
QSizeF pageSize() const;
void setDefaultFont(const QFont &font);
QFont defaultFont() const;
int pageCount() const;
bool isModified() const;
void print(QPagedPaintDevice *printer) const;
enum ResourceType {
HtmlResource = 1,
ImageResource = 2,
StyleSheetResource = 3,
UserResource = 100
};
QVariant resource(int type, const QUrl &name) const;
void addResource(int type, const QUrl &name, const QVariant &resource);
QVector<QTextFormat> allFormats() const;
void markContentsDirty(int from, int length);
void setUseDesignMetrics(bool b);
bool useDesignMetrics() const;
void drawContents(QPainter *painter, const QRectF &rect = QRectF());
void setTextWidth(qreal width);
qreal textWidth() const;
qreal idealWidth() const;
qreal indentWidth() const;
void setIndentWidth(qreal width);
qreal documentMargin() const;
void setDocumentMargin(qreal margin);
void adjustSize();
QSizeF size() const;
int blockCount() const;
int lineCount() const;
int characterCount() const;
#ifndef QT_NO_CSSPARSER
void setDefaultStyleSheet(const QString &sheet);
QString defaultStyleSheet() const;
#endif
void undo(QTextCursor *cursor);
void redo(QTextCursor *cursor);
enum Stacks {
UndoStack = 0x01,
RedoStack = 0x02,
UndoAndRedoStacks = UndoStack | RedoStack
};
void clearUndoRedoStacks(Stacks historyToClear = UndoAndRedoStacks);
int maximumBlockCount() const;
void setMaximumBlockCount(int maximum);
QTextOption defaultTextOption() const;
void setDefaultTextOption(const QTextOption &option);
QUrl baseUrl() const;
void setBaseUrl(const QUrl &url);
Qt::CursorMoveStyle defaultCursorMoveStyle() const;
void setDefaultCursorMoveStyle(Qt::CursorMoveStyle style);
Q_SIGNALS:
void contentsChange(int from, int charsRemoved, int charsAdded);
void contentsChanged();
void undoAvailable(bool);
void redoAvailable(bool);
void undoCommandAdded();
void modificationChanged(bool m);
void cursorPositionChanged(const QTextCursor &cursor);
void blockCountChanged(int newBlockCount);
void baseUrlChanged(const QUrl &url);
void documentLayoutChanged();
public Q_SLOTS:
void undo();
void redo();
void appendUndoItem(QAbstractUndoItem *);
void setModified(bool m = true);
protected:
virtual QTextObject *createObject(const QTextFormat &f);
Q_INVOKABLE virtual QVariant loadResource(int type, const QUrl &name);
QTextDocument(QTextDocumentPrivate &dd, QObject *parent);
public:
QTextDocumentPrivate *docHandle() const;
private:
Q_DISABLE_COPY(QTextDocument)
Q_DECLARE_PRIVATE(QTextDocument)
friend class QTextObjectPrivate;
};
Q_DECLARE_OPERATORS_FOR_FLAGS(QTextDocument::FindFlags)
QT_END_NAMESPACE
#endif // QTEXTDOCUMENT_H