QTextDocument Class Reference

QTextDocument Class Reference
Public Types | Public Slots | Signals | Public Member Functions | Protected Member Functions | Properties | Friends

#include <qtextdocument.h>

Class Description

Definition at line 109 of file qtextdocument.h.

+ Inheritance diagram for QTextDocument:

Public Types

enum  MetaInformation { DocumentTitle, DocumentUrl }
 
enum  FindFlag { FindBackward = 0x00001, FindCaseSensitively = 0x00002, FindWholeWords = 0x00004 }
 
enum  ResourceType { HtmlResource = 1, ImageResource = 2, StyleSheetResource = 3, UserResource = 100 }
 
enum  Stacks { UndoStack = 0x01, RedoStack = 0x02, UndoAndRedoStacks = UndoStack | RedoStack }
 

Public Slots

void undo ()
 
void redo ()
 
void appendUndoItem (QAbstractUndoItem *)
 
void setModified (bool m=true)
 
- Public Slots inherited from QObject
void deleteLater ()
 

Signals

void contentsChange (int from, int charsRemoves, 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 documentLayoutChanged ()
 
- Signals inherited from QObject
void destroyed (QObject *=0)
 

Public Member Functions

 QTextDocument (QObject *parent=0)
 
 QTextDocument (const QString &text, QObject *parent=0)
 
 ~QTextDocument ()
 
QTextDocument * clone (QObject *parent=0) 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
 
void setMetaInformation (MetaInformation info, const QString &)
 
QString metaInformation (MetaInformation info) const
 
QString toHtml (const QByteArray &encoding=QByteArray()) const
 
void setHtml (const QString &html)
 
QString toPlainText () const
 
void setPlainText (const QString &text)
 
QChar characterAt (int pos) const
 
QTextCursor find (const QString &subString, int from=0, FindFlags options=0) const
 
QTextCursor find (const QString &subString, const QTextCursor &from, FindFlags options=0) const
 
QTextCursor find (const QRegExp &expr, int from=0, FindFlags options=0) const
 
QTextCursor find (const QRegExp &expr, const QTextCursor &from, FindFlags options=0) const
 
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 (QPrinter *printer) const
 
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
 
void setDefaultStyleSheet (const QString &sheet)
 
QString defaultStyleSheet () const
 
void undo (QTextCursor *cursor)
 
void redo (QTextCursor *cursor)
 
void clearUndoRedoStacks (Stacks historyToClear=UndoAndRedoStacks)
 
int maximumBlockCount () const
 
void setMaximumBlockCount (int maximum)
 
QTextOption defaultTextOption () const
 
void setDefaultTextOption (const QTextOption &option)
 
Qt::CursorMoveStyle defaultCursorMoveStyle () const
 
void setDefaultCursorMoveStyle (Qt::CursorMoveStyle style)
 
QTextDocumentPrivate * docHandle () const
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=0)
 
virtual ~QObject ()
 
virtual bool event (QEvent *)
 
virtual bool eventFilter (QObject *, QEvent *)
 
QString objectName () const
 
void setObjectName (const QString &name)
 
bool isWidgetType () const
 
bool signalsBlocked () const
 
bool blockSignals (bool b)
 
QThread * thread () const
 
void moveToThread (QThread *thread)
 
int startTimer (int interval)
 
void killTimer (int id)
 
template<typename T >
T findChild (const QString &aName=QString()) const
 
template<typename T >
QList< T > findChildren (const QString &aName=QString()) const
 
template<typename T >
QList< T > findChildren (const QRegExp &re) const
 
const QObjectList & children () const
 
void setParent (QObject *)
 
void installEventFilter (QObject *)
 
void removeEventFilter (QObject *)
 
bool connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=0, const QObject *receiver=0, const char *member=0)
 
bool disconnect (const QObject *receiver, const char *member=0)
 
void dumpObjectTree ()
 
void dumpObjectInfo ()
 
bool setProperty (const char *name, const QVariant &value)
 
QVariant property (const char *name) const
 
QList< QByteArray > dynamicPropertyNames () const
 
void setUserData (uint id, QObjectUserData *data)
 
QObjectUserData * userData (uint id) const
 
QObject * parent () const
 
bool inherits (const char *classname) const
 

Protected Member Functions

virtual QTextObject * createObject (const QTextFormat &f)
 
virtual QVariant loadResource (int type, const QUrl &name)
 
 QTextDocument (QTextDocumentPrivate &dd, QObject *parent)
 
- Protected Member Functions inherited from QObject
QObject * sender () const
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 
virtual void timerEvent (QTimerEvent *)
 
virtual void childEvent (QChildEvent *)
 
virtual void customEvent (QEvent *)
 
virtual void connectNotify (const char *signal)
 
virtual void disconnectNotify (const char *signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=0)
 

Properties

bool undoRedoEnabled
 
bool modified
 
QSizeF pageSize
 
QFont defaultFont
 
bool useDesignMetrics
 
QSizeF size
 
qreal textWidth
 
int blockCount
 
qreal indentWidth
 
QString defaultStyleSheet
 
int maximumBlockCount
 
qreal documentMargin
 
- Properties inherited from QObject
QString objectName
 

Friends

class QTextObjectPrivate
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
static bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 
static bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static uint registerUserData ()
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 
- Static Protected Attributes inherited from QObject
static const QMetaObject staticQtMetaObject
 

Member Enumeration Documentation

enum MetaInformation
Enumerator
DocumentTitle 
DocumentUrl 

Definition at line 153 of file qtextdocument.h.

153  {
154  DocumentTitle,
155  DocumentUrl
156  };
QTextDocument::DocumentTitle
Definition: qtextdocument.h:154
QTextDocument::DocumentUrl
Definition: qtextdocument.h:155
enum FindFlag
Enumerator
FindBackward 
FindCaseSensitively 
FindWholeWords 

Definition at line 170 of file qtextdocument.h.

171  {
172  FindBackward = 0x00001,
173  FindCaseSensitively = 0x00002,
174  FindWholeWords = 0x00004
175  };
QTextDocument::FindBackward
Definition: qtextdocument.h:172
QTextDocument::FindWholeWords
Definition: qtextdocument.h:174
QTextDocument::FindCaseSensitively
Definition: qtextdocument.h:173
enum ResourceType
Enumerator
HtmlResource 
ImageResource 
StyleSheetResource 
UserResource 

Definition at line 213 of file qtextdocument.h.

213  {
214  HtmlResource = 1,
215  ImageResource = 2,
216  StyleSheetResource = 3,
217 
218  UserResource = 100
219  };
QTextDocument::UserResource
Definition: qtextdocument.h:218
QTextDocument::HtmlResource
Definition: qtextdocument.h:214
QTextDocument::ImageResource
Definition: qtextdocument.h:215
QTextDocument::StyleSheetResource
Definition: qtextdocument.h:216
enum Stacks
Enumerator
UndoStack 
RedoStack 
UndoAndRedoStacks 

Definition at line 259 of file qtextdocument.h.

259  {
260  UndoStack = 0x01,
261  RedoStack = 0x02,
262  UndoAndRedoStacks = UndoStack | RedoStack
263  };
QTextDocument::RedoStack
Definition: qtextdocument.h:261
QTextDocument::UndoAndRedoStacks
Definition: qtextdocument.h:262
QTextDocument::UndoStack
Definition: qtextdocument.h:260

Constructor & Destructor Documentation

QTextDocument ( QObject *  parent = 0)
explicit
QTextDocument ( const QString &  text,
QObject *  parent = 0 
)
explicit
~QTextDocument ( )
QTextDocument ( QTextDocumentPrivate &  dd,
QObject *  parent 
)
protected

Member Function Documentation

QTextDocument* clone ( QObject *  parent = 0) const
bool isEmpty ( ) const
virtual void clear ( )
virtual
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
void setMetaInformation ( MetaInformation  info,
const QString &   
)
QString metaInformation ( MetaInformation  info) const
QString toHtml ( const QByteArray &  encoding = QByteArray()) const
void setHtml ( const QString &  html)
QString toPlainText ( ) const
void setPlainText ( const QString &  text)
QChar characterAt ( int  pos) const
QTextCursor find ( const QString &  subString,
int  from = 0,
FindFlags  options = 0 
) const
QTextCursor find ( const QString &  subString,
const QTextCursor &  from,
FindFlags  options = 0 
) const
QTextCursor find ( const QRegExp &  expr,
int  from = 0,
FindFlags  options = 0 
) const
QTextCursor find ( const QRegExp &  expr,
const QTextCursor &  from,
FindFlags  options = 0 
) const
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 ( QPrinter *  printer) const
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
void setDefaultStyleSheet ( const QString &  sheet)
QString defaultStyleSheet ( ) const
void undo ( QTextCursor *  cursor)
void redo ( QTextCursor *  cursor)
void clearUndoRedoStacks ( Stacks  historyToClear = UndoAndRedoStacks)
int maximumBlockCount ( ) const
void setMaximumBlockCount ( int  maximum)
QTextOption defaultTextOption ( ) const
void setDefaultTextOption ( const QTextOption &  option)
Qt::CursorMoveStyle defaultCursorMoveStyle ( ) const
void setDefaultCursorMoveStyle ( Qt::CursorMoveStyle  style)
void contentsChange ( int  from,
int  charsRemoves,
int  charsAdded 
)
signal
void contentsChanged ( )
signal
void undoAvailable ( bool  )
signal
void redoAvailable ( bool  )
signal
void undoCommandAdded ( )
signal
void modificationChanged ( bool  m)
signal
void cursorPositionChanged ( const QTextCursor &  cursor)
signal
void blockCountChanged ( int  newBlockCount)
signal
void documentLayoutChanged ( )
signal
void undo ( )
slot
void redo ( )
slot
void appendUndoItem ( QAbstractUndoItem *  )
slot
void setModified ( bool  m = true)
slot
virtual QTextObject* createObject ( const QTextFormat &  f)
protectedvirtual
virtual QVariant loadResource ( int  type,
const QUrl &  name 
)
protectedvirtual
QTextDocumentPrivate* docHandle ( ) const

Friends And Related Function Documentation

friend class QTextObjectPrivate
friend

Definition at line 303 of file qtextdocument.h.

Property Documentation

bool undoRedoEnabled
readwrite

Definition at line 113 of file qtextdocument.h.

bool modified
readwrite

Definition at line 114 of file qtextdocument.h.

QSizeF pageSize
readwrite

Definition at line 115 of file qtextdocument.h.

QFont defaultFont
readwrite

Definition at line 116 of file qtextdocument.h.

bool useDesignMetrics
readwrite

Definition at line 117 of file qtextdocument.h.

QSizeF size
read

Definition at line 118 of file qtextdocument.h.

qreal textWidth
readwrite

Definition at line 119 of file qtextdocument.h.

int blockCount
read

Definition at line 120 of file qtextdocument.h.

qreal indentWidth
readwrite

Definition at line 121 of file qtextdocument.h.

QString defaultStyleSheet
readwrite

Definition at line 123 of file qtextdocument.h.

int maximumBlockCount
readwrite

Definition at line 125 of file qtextdocument.h.

qreal documentMargin
readwrite

Definition at line 126 of file qtextdocument.h.

The documentation for this class was generated from the following file:
Please send us your comment about this page