CopperSpice API  1.9.1
Public Methods | Static Public Methods | Friends | List of all members
QTextDocumentFragment Class Reference
CsGui | Implicit Sharing | Rich Text Processing

The QTextDocumentFragment class represents a piece of formatted text from a QTextDocument. More...

Public Methods

 QTextDocumentFragment ()
 
 QTextDocumentFragment (const QTextCursor &cursor)
 
 QTextDocumentFragment (const QTextDocument *document)
 
 QTextDocumentFragment (const QTextDocumentFragment &other)
 
 ~QTextDocumentFragment ()
 
bool isEmpty () const
 
QTextDocumentFragment & operator= (const QTextDocumentFragment &other)
 
QString toHtml (const QByteArray &encoding=QByteArray ()) const
 
QString toPlainText () const
 

Static Public Methods

static QTextDocumentFragment fromHtml (const QString &text)
 
static QTextDocumentFragment fromHtml (const QString &text, const QTextDocument *resourceProvider)
 
static QTextDocumentFragment fromPlainText (const QString &plainText)
 

Friends

class QTextCursor
 
class QTextDocumentWriter
 

Detailed Description

The QTextDocumentFragment class represents a piece of formatted text from a QTextDocument.

A QTextDocumentFragment is a fragment of rich text, that can be inserted into a QTextDocument. A document fragment can be created from a QTextDocument, from a QTextCursor's selection, or from another document fragment. Document fragments can also be created by the static functions, fromPlainText() and fromHtml().

The contents of a document fragment can be obtained as plain text by using the toPlainText() function, or it can be obtained as HTML with toHtml().

See also
isEmpty()

Constructor & Destructor Documentation

QTextDocumentFragment::QTextDocumentFragment ( )

Constructs an empty QTextDocumentFragment.

See also
isEmpty()
QTextDocumentFragment::QTextDocumentFragment ( const QTextDocument *  document)
explicit

Converts the given document into a QTextDocumentFragment. Note that the QTextDocumentFragment only stores the document contents, not meta information like the document's title.

QTextDocumentFragment::QTextDocumentFragment ( const QTextCursor &  cursor)
explicit

Creates a QTextDocumentFragment from the cursor's selection. If the cursor does not have a selection, the created fragment is empty.

See also
isEmpty(), QTextCursor::selection()
QTextDocumentFragment::QTextDocumentFragment ( const QTextDocumentFragment &  other)

Copy constructs a new QTextDocumentFragment from other.

QTextDocumentFragment::~QTextDocumentFragment ( )

Destroys the document fragment.

Method Documentation

QTextDocumentFragment QTextDocumentFragment::fromHtml ( const QString &  text)
static

Returns a QTextDocumentFragment based on the arbitrary piece of HTML in the given text. The formatting is preserved as much as possible; for example, "<b>bold</b>" will become a document fragment with the text "bold" with a bold character format.

QTextDocumentFragment QTextDocumentFragment::fromHtml ( const QString &  text,
const QTextDocument *  resourceProvider 
)
static

Returns a QTextDocumentFragment based on the arbitrary piece of HTML in the given text. The formatting is preserved as much as possible; for example, "<b>bold</b>" will become a document fragment with the text "bold" with a bold character format.

If the provided HTML contains references to external resources such as imported style sheets, then they will be loaded through the resourceProvider.

QTextDocumentFragment QTextDocumentFragment::fromPlainText ( const QString &  plainText)
static

Returns a document fragment that contains the given plainText.

When inserting such a fragment into a QTextDocument the current char format of the QTextCursor used for insertion is used as format for the text.

bool QTextDocumentFragment::isEmpty ( ) const

Returns true if the fragment is empty, otherwise returns false.

QTextDocumentFragment & QTextDocumentFragment::operator= ( const QTextDocumentFragment &  other)

Copy assigns from other and returns a reference to this object.

QString QTextDocumentFragment::toHtml ( const QByteArray &  encoding = QByteArray()) const

Returns the contents of the document fragment as HTML, using the specified encoding. For example, "UTF-8" or "ISO 8859-1".

See also
toPlainText(), QTextDocument::toHtml(), QTextCodec
QString QTextDocumentFragment::toPlainText ( ) const

Returns the document fragment's text as plain text (i.e. with no formatting information).

See also
toHtml()