Contents

• Public Types
• Properties
• Public Functions
• Reimplemented Public Functions
• Public Slots
• Signals
• Protected Functions
• Reimplemented Protected Functions
• Detailed Description
• Introduction and Concepts
• Using Q3TextEdit as a Display Widget
• Using Q3TextEdit as an Editor

Detailed Description

TheQ3TextEdit widget provides a powerful single-page rich text editor.

Introduction and Concepts

Q3TextEdit is an advanced WYSIWYG viewer/editor supporting rich text formatting using HTML-style tags. It is optimized to handle large documents and to respond quickly to user input.

Q3TextEdit has four modes of operation:

Q3TextEdit can be used as a syntax highlighting editor when used in conjunction withQSyntaxHighlighter.

We recommend that you always callsetTextFormat() to set the mode you want to use. If you useQt::AutoText thensetText() andappend() will try to determine whether the text they are given is plain text or rich text. If you useQt::RichText thensetText() andappend() will assume that the text they are given is rich text.insert() simply inserts the text it is given.

Q3TextEdit works on paragraphs and characters. A paragraph is a formatted string which is word-wrapped to fit into the width of the widget. By default when reading plain text, one newline signify a paragraph. A document consists of zero or more paragraphs, indexed from 0. Characters are indexed on a per-paragraph basis, also indexed from 0. The words in the paragraph are aligned in accordance with the paragraph'salignment(). Paragraphs are separated by hard line breaks. Each character within a paragraph has its own attributes, for example, font and color.

The text edit documentation uses the following concepts:

• current format -- this is the format at the current cursor position,and it is the format of the selected text if any.
• current paragraph -- the paragraph which contains the cursor.

Q3TextEdit can display images (usingQ3MimeSourceFactory), lists and tables. If the text is too large to view within the text edit's viewport, scroll bars will appear. The text edit can load both plain text and HTML files (a subset of HTML 3.2 and 4). The rendering style and the set of valid tags are defined by astyleSheet(). Custom tags can be created and placed in a custom style sheet. Change the style sheet withsetStyleSheet(); seeQ3StyleSheet for details. The images identified by image tags are displayed if they can be interpreted using the text edit'sQ3MimeSourceFactory; seesetMimeSourceFactory().

If you want a text browser with more navigation useQTextBrowser. If you just need to display a small piece of rich text useQLabel orQSimpleRichText.

If you create a newQ3TextEdit, and want to allow the user to edit rich text, callsetTextFormat(Qt::RichText) to ensure that the text is treated as rich text. (Rich text uses HTML tags to set text formatting attributes. SeeQ3StyleSheet for information on the HTML tags that are supported.). If you don't callsetTextFormat() explicitly the text edit will guess from the text itself whether it is rich text or plain text. This means that if the text looks like HTML or XML it will probably be interpreted as rich text, so you should callsetTextFormat(Qt::PlainText) to preserve such text.

Note that we do not intend to add a full-featured web browser widget to Qt (because that would easily double Qt's size and only a few applications would benefit from it). The rich text support in Qt is designed to provide a fast, portable and efficient way to add reasonable online help facilities to applications, and to provide a basis for rich text editors.

Using Q3TextEdit as a Display Widget

Q3TextEdit can display a large HTML subset, including tables and images.

The text is set or replaced usingsetText() which deletes any existing text and replaces it with the text passed in thesetText() call. If you callsetText() with legacy HTML (withsetTextFormat(Qt::RichText) in force), and then calltext(), the text that is returned may have different markup, but will render the same. Text can be inserted withinsert(),paste(),pasteSubType() andappend(). Text that is appended does not go into the undo history; this makesappend() faster and consumes less memory. Text can also becut(). The entire text is deleted withclear() and the selected text is deleted withremoveSelectedText(). Selected (marked) text can also be deleted withdel() (which will delete the character to the right of the cursor if no text is selected).

Loading and saving text is achieved usingsetText() andtext(), for example:

QFile file(fileName);// Read the text from a fileif (file.open(IO_ReadOnly)) {QTextStream stream(&file);    textEdit->setText(stream.read());}QFile file(fileName);// Write the text to a fileif (file.open(IO_WriteOnly)) {QTextStream stream(&file);    stream<< textEdit->text();    textEdit->setModified(false);}

By default the text edit wraps words at whitespace to fit within the text edit widget. ThesetWordWrap() function is used to specify the kind of word wrap you want, orNoWrap if you don't want any wrapping. CallsetWordWrap() to set a fixed pixel widthFixedPixelWidth, or character column (e.g. 80 column)FixedColumnWidth with the pixels or columns specified withsetWrapColumnOrWidth(). If you use word wrap to the widget's widthWidgetWidth, you can specify whether to break on whitespace or anywhere withsetWrapPolicy().

The background color is set differently than other widgets, usingsetPaper(). You specify a brush style which could be a plain color or a complex pixmap.

Hypertext links are automatically underlined; this can be changed withsetLinkUnderline(). The tab stop width is set withsetTabStopWidth().

ThezoomIn() andzoomOut() functions can be used to resize the text by increasing (decreasing forzoomOut()) the point size used. Images are not affected by the zoom functions.

Thelines() function returns the number of lines in the text andparagraphs() returns the number of paragraphs. The number of lines within a particular paragraph is returned bylinesOfParagraph(). The length of the entire text in characters is returned bylength().

You can scroll to an anchor in the text, e.g.<a name="anchor"> withscrollToAnchor(). Thefind() function can be used to find and select a given string within the text.

A read-onlyQ3TextEdit provides the same functionality as the (obsolete)QTextView. (QTextView is still supplied for compatibility with old code.)

Read-only key bindings

WhenQ3TextEdit is used read-only the key-bindings are limited to navigation, and text may only be selected with the mouse:

The text edit may be able to provide some meta-information. For example, thedocumentTitle() function will return the text from within HTML<title> tags.

The text displayed in a text edit has acontext. The context is a path which the text edit'sQ3MimeSourceFactory uses to resolve the locations of files and images. It is passed to themimeSourceFactory() when quering data. (SeeQ3TextEdit() andcontext().)

Using Q3TextEdit in Qt::LogText Mode

Setting the text format toQt::LogText puts the widget in a special mode which is optimized for very large texts. In this mode editing and rich text support are disabled (the widget is explicitly set to read-only mode). This allows the text to be stored in a different, more memory efficient manner. However, a certain degree of text formatting is supported through the use of formatting tags. A tag is delimited by< and>. The characters<,> and& are escaped by using<,> and&. A tag pair consists of a left and a right tag (or open/close tags). Left-tags mark the starting point for formatting, while right-tags mark the ending point. A right-tag always start with a/ before the tag keyword. For example<b> and</b> are a tag pair. Tags can be nested, but they have to be closed in the same order as they are opened. For example,<b><u></u></b> is valid, while<b><u></b></u> will output an error message.

By using tags it is possible to change the color, bold, italic and underline settings for a piece of text. A color can be specified by using the HTML font tag<font color=colorname>. The color name can be one of the color names from the X11 color database, or a RGB hex value (e.g#00ff00). Example of valid color tags:<font color=red>,<font color="light blue">,<font color="#223344">. Bold, italic and underline settings can be specified by the tags<b>,<i> and<u>. Note that a tag does not necessarily have to be closed. A valid example:

This is<font color=red>red</font>while<b>this</b> is<font color=blue>blue</font>.<font color=green><font color=yellow>Yellow,</font> and<u>green</u>.

Stylesheets can also be used inQt::LogText mode. To create and use a custom tag, you could do the following:

Q3TextEdit* log=newQ3TextEdit(this);log->setTextFormat(Qt::LogText);Q3StyleSheetItem* item=newQ3StyleSheetItem(log->styleSheet(),"mytag");item->setColor("red");item->setFontWeight(QFont::Bold);item->setFontUnderline(true);log->append("This is a <mytag>custom tag</mytag>!");

Note that only the color, bold, underline and italic attributes of aQ3StyleSheetItem is used inQt::LogText mode.

Note that you can use setMaxLogLines() to limit the number of lines the widget can hold inQt::LogText mode.

There are a few things that you need to be aware of when the widget is in this mode:

• Functions that deal with rich text formatting and cursor movement will not work or return anything valid.
• Lines are equivalent to paragraphs.

Using Q3TextEdit as an Editor

All the information about usingQ3TextEdit as a display widget also applies here.

The current format's attributes are set withsetItalic(),setBold(),setUnderline(),setFamily() (font family),setPointSize(),setColor() andsetCurrentFont(). The current paragraph's alignment is set withsetAlignment().

UsesetSelection() to select text. ThesetSelectionAttributes() function is used to indicate how selected text should be displayed. UsehasSelectedText() to find out if any text is selected. The currently selected text's position is available usinggetSelection() and the selected text itself is returned byselectedText(). The selection can be copied to the clipboard withcopy(), or cut to the clipboard withcut(). It can be deleted withremoveSelectedText(). The entire text can be selected (or unselected) usingselectAll().Q3TextEdit supports multiple selections. Most of the selection functions operate on the default selection, selection 0. If the user presses a non-selecting key, e.g. a cursor key without also holding down Shift, all selections are cleared.

Set and get the position of the cursor withsetCursorPosition() andgetCursorPosition() respectively. When the cursor is moved, the signalscurrentFontChanged(),currentColorChanged() andcurrentAlignmentChanged() are emitted to reflect the font, color and alignment at the new cursor position.

If the text changes, thetextChanged() signal is emitted, and if the user inserts a new line by pressing Return or Enter,returnPressed() is emitted. TheisModified() function will return true if the text has been modified.

Q3TextEdit provides command-based undo and redo. To set the depth of the command history usesetUndoDepth() which defaults to 100 steps. To undo or redo the last operation callundo() orredo(). The signalsundoAvailable() andredoAvailable() indicate whether the undo and redo operations can be executed.

Editing key bindings

The list of key-bindings which are implemented for editing:

To select (mark) text hold down the Shift key whilst pressing one of the movement keystrokes, for example,Shift+Right will select the character to the right, andShift+Ctrl+Right will select the word to the right, etc.

By default the text edit widget operates in insert mode so all text that the user enters is inserted into the text edit and any text to the right of the cursor is moved out of the way. The mode can be changed to overwrite, where new text overwrites any text to the right of the cursor, usingsetOverwriteMode().

Member Type Documentation

enum Q3TextEdit::AutoFormattingFlag
flags Q3TextEdit::AutoFormatting

The AutoFormatting type is a typedef forQFlags<AutoFormattingFlag>. It stores an OR combination of AutoFormattingFlag values.

enum Q3TextEdit::CursorAction

This enum is used bymoveCursor() to specify in which direction the cursor should be moved:

enum Q3TextEdit::KeyboardAction

This enum is used bydoKeyboardAction() to specify which action should be executed:

enum Q3TextEdit::VerticalAlignment

This enum is used to set the vertical alignment of the text.

enum Q3TextEdit::WordWrap

This enum defines theQ3TextEdit's word wrap modes.

See alsosetWordWrap() andwordWrap().

enum Q3TextEdit::WrapPolicy

This enum defines where text can be wrapped in word wrap mode.

See alsosetWrapPolicy().

Property Documentation

autoFormatting :AutoFormattingFlag

This property holds the enabled set of auto formatting features.

The value can be any combination of the values in theAutoFormattingFlag enum. The default isAutoAll. ChooseAutoNone to disable all automatic formatting.

Currently, the only automatic formatting feature provided isAutoBulletList; future versions of Qt may offer more.

Access functions:

documentTitle : constQString

This property holds the title of the document parsed from the text.

ForQt::PlainText the title will be an empty string. ForQt::RichText the title will be the text between the<title> tags, if present, otherwise an empty string.

Access functions:

hasSelectedText : constbool

This property holds whether some text is selected in selection 0.

Access functions:

length : constint

This property holds the number of characters in the text.

Access functions:

linkUnderline :bool

This property holds whether hypertext links will be underlined.

If true (the default) hypertext links will be displayed underlined. If false links will not be displayed underlined.

Access functions:

modified :bool

This property holds whether the document has been modified by the user.

Access functions:

overwriteMode :bool

This property holds the text edit's overwrite mode.

If false (the default) characters entered by the user are inserted with any characters to the right being moved out of the way. If true, the editor is in overwrite mode, i.e. characters entered by the user overwrite any characters to the right of the cursor position.

Access functions:

paper :QBrush

This property holds the background (paper) brush.

The brush that is currently used to draw the background of the text edit. The initial setting is an empty brush.

Access functions:

readOnly :bool

This property holds whether the text edit is read-only.

In a read-only text edit the user can only navigate through the text and select text; modifying the text is not possible.

This property's default is false.

Access functions:

selectedText : constQString

This property holds the selected text (from selection 0) or an empty string if there is no currently selected text (in selection 0).

The text is always returned asQt::PlainText if thetextFormat() isQt::PlainText orQt::AutoText, otherwise it is returned as HTML.

Access functions:

See alsohasSelectedText.

tabChangesFocus :bool

This property holds whether TAB changes focus or is accepted as input.

In some occasions text edits should not allow the user to input tabulators or change indentation using the TAB key, as this breaks the focus chain. The default is false.

Access functions:

tabStopWidth :int

This property holds the tab stop width in pixels.

Access functions:

text :QString

This property holds the text edit's text.

There is no default text.

On setting, any previous text is deleted.

The text may be interpreted either as plain text or as rich text, depending on thetextFormat(). The default setting isQt::AutoText, i.e. the text edit auto-detects the format of the text.

For richtext, calling text() on an editableQ3TextEdit will cause the text to be regenerated from the textedit. This may mean that theQString returned may not be exactly the same as the one that was set.

Access functions:

See alsotextFormat.

textFormat :Qt::TextFormat

This property holds the text format: rich text, plain text, log text or auto text.

The text format is one of the following:

• Qt::PlainText - all characters, except newlines, are displayed verbatim, including spaces. Whenever a newline appears in the text the text edit inserts a hard line break and begins a new paragraph.
• Qt::RichText - rich text rendering. The available styles are defined in the default stylesheetQ3StyleSheet::defaultSheet().
• Qt::LogText - optimized mode for very large texts. Supports a very limited set of formatting tags (color, bold, underline and italic settings).
• Qt::AutoText - this is the default. The text edit autodetects which rendering style is best,Qt::PlainText orQt::RichText. This is done by using theQ3StyleSheet::mightBeRichText() function.

Access functions:

undoDepth :int

This property holds the depth of the undo history.

The maximum number of steps in the undo/redo history. The default is 100.

Access functions:

See alsoundo() andredo().

undoRedoEnabled :bool

This property holds whether undo/redo is enabled.

When changing this property, the undo/redo history is cleared.

The default is true.

Access functions:

wordWrap :WordWrap

This property holds the word wrap mode.

The default mode isWidgetWidth which causes words to be wrapped at the right edge of the text edit. Wrapping occurs at whitespace, keeping whole words intact. If you want wrapping to occur within words usesetWrapPolicy(). If you set a wrap mode ofFixedPixelWidth orFixedColumnWidth you should also callsetWrapColumnOrWidth() with the width you want.

Access functions:

See alsoWordWrap,wrapColumnOrWidth, andwrapPolicy.

wrapColumnOrWidth :int

This property holds the position (in pixels or columns depending on the wrap mode) where text will be wrapped.

If the wrap mode isFixedPixelWidth, the value is the number of pixels from the left edge of the text edit at which text should be wrapped. If the wrap mode isFixedColumnWidth, the value is the column number (in character columns) from the left edge of the text edit at which text should be wrapped.

Access functions:

See alsowordWrap.

wrapPolicy :WrapPolicy

This property holds the word wrap policy, at whitespace or anywhere.

Defines where text can be wrapped when word wrap mode is notNoWrap. The choices areAtWordBoundary (the default),Anywhere andAtWordOrDocumentBoundary

Access functions:

See alsowordWrap.

Member Function Documentation

Q3TextEdit::Q3TextEdit(constQString & text, constQString & context = QString(),QWidget * parent = 0, constchar * name = 0)

Constructs aQ3TextEdit calledname, with parentparent. The text edit will display the texttext using contextcontext.

Thecontext is a path which the text edit'sQ3MimeSourceFactory uses to resolve the locations of files and images. It is passed to themimeSourceFactory() when quering data.

For example if the text contains an image tag,<img src="image.png">, and the context is "path/to/look/in", theQ3MimeSourceFactory will try to load the image from "path/to/look/in/image.png". If the tag was<img src="/image.png">, the context will not be used (becauseQ3MimeSourceFactory recognizes that we have used an absolute path) and will try to load "/image.png". The context is applied in exactly the same way tohrefs, for example,<a href="target.html">Target</a>, would resolve to "path/to/look/in/target.html".

Q3TextEdit::Q3TextEdit(QWidget * parent = 0, constchar * name = 0)

Constructs an emptyQ3TextEdit calledname, with parentparent.

[virtual]Q3TextEdit::~Q3TextEdit()

Destructor.

int Q3TextEdit::alignment() const

Returns the alignment of the current paragraph.

See alsosetAlignment().

QString Q3TextEdit::anchorAt(constQPoint & pos,Qt::AnchorAttribute attr = Qt::AnchorHref)

Returns the text for the attributeattr (Qt::AnchorHref by default) if there is an anchor at positionpos (in contents coordinates); otherwise returns an empty string.

[virtual slot]void Q3TextEdit::append(constQString & text)

Appends a new paragraph withtext to the end of the text edit. Note that the undo/redo history is cleared by this function, and no undo history is kept for appends which makes them faster thaninsert()s. If you want to append text which is added to the undo/redo history as well, useinsertParagraph().

bool Q3TextEdit::bold() const

Returns true if the current format is bold; otherwise returns false.

See alsosetBold().

[virtual protected]void Q3TextEdit::changeEvent(QEvent * ev)

Reimplemented fromQWidget::changeEvent().

int Q3TextEdit::charAt(constQPoint & pos,int * para) const

Returns the index of the character (relative to its paragraph) at positionpos (in contents coordinates). Ifpara is not 0,*para is set to the character's paragraph.

[virtual slot]void Q3TextEdit::clear()

Deletes all the text in the text edit.

See alsocut(),removeSelectedText(), andsetText().

[virtual slot]void Q3TextEdit::clearParagraphBackground(int para)

Clears the background color of the paragraphpara, so that the default color is used again.

[signal]void Q3TextEdit::clicked(int para,int pos)

This signal is emitted when the mouse is clicked on the paragraphpara at character positionpos.

See alsodoubleClicked().

QColor Q3TextEdit::color() const

Returns the color of the current format.

See alsosetColor() andsetPaper().

[virtual protected]void Q3TextEdit::contentsContextMenuEvent(QContextMenuEvent * e)

Reimplemented fromQ3ScrollView::contentsContextMenuEvent().

[virtual protected]void Q3TextEdit::contentsDragEnterEvent(QDragEnterEvent * e)

Reimplemented fromQ3ScrollView::contentsDragEnterEvent().

[virtual protected]void Q3TextEdit::contentsDragLeaveEvent(QDragLeaveEvent * e)

Reimplemented fromQ3ScrollView::contentsDragLeaveEvent().

[virtual protected]void Q3TextEdit::contentsDragMoveEvent(QDragMoveEvent * e)

Reimplemented fromQ3ScrollView::contentsDragMoveEvent().

[virtual protected]void Q3TextEdit::contentsDropEvent(QDropEvent * e)

Reimplemented fromQ3ScrollView::contentsDropEvent().

[virtual protected]void Q3TextEdit::contentsMouseDoubleClickEvent(QMouseEvent * e)

Reimplemented fromQ3ScrollView::contentsMouseDoubleClickEvent().

[virtual protected]void Q3TextEdit::contentsMouseMoveEvent(QMouseEvent * e)

Reimplemented fromQ3ScrollView::contentsMouseMoveEvent().

[virtual protected]void Q3TextEdit::contentsMousePressEvent(QMouseEvent * e)

Reimplemented fromQ3ScrollView::contentsMousePressEvent().

[virtual protected]void Q3TextEdit::contentsMouseReleaseEvent(QMouseEvent * e)

Reimplemented fromQ3ScrollView::contentsMouseReleaseEvent().

[virtual protected]void Q3TextEdit::contentsWheelEvent(QWheelEvent * e)

Reimplemented fromQ3ScrollView::contentsWheelEvent().

QString Q3TextEdit::context() const

Returns the context of the text edit. The context is a path which the text edit'sQ3MimeSourceFactory uses to resolve the locations of files and images.

See alsotext.

[virtual slot]void Q3TextEdit::copy()

Copies any selected text (from selection 0) to the clipboard.

See alsohasSelectedText() andcopyAvailable().

[signal]void Q3TextEdit::copyAvailable(bool yes)

This signal is emitted when text is selected or de-selected in the text edit.

When text is selected this signal will be emitted withyes set to true. If no text has been selected or if the selected text is de-selected this signal is emitted withyes set to false.

Ifyes is true thencopy() can be used to copy the selection to the clipboard. Ifyes is false thencopy() does nothing.

See alsoselectionChanged().

[virtual protected]Q3PopupMenu * Q3TextEdit::createPopupMenu(constQPoint & pos)

This function is called to create a right mouse button popup menu at the document positionpos. If you want to create a custom popup menu, reimplement this function and return the created popup menu. Ownership of the popup menu is transferred to the caller.

Warning: TheQPopupMenu ID values 0-7 are reserved, and they map to the standard operations. When inserting items into your custom popup menu, be sure to specify ID values larger than 7.

[virtual protected]Q3PopupMenu * Q3TextEdit::createPopupMenu()

This is an overloaded function.

This function is called to create a right mouse button popup menu. If you want to create a custom popup menu, reimplement this function and return the created popup menu. Ownership of the popup menu is transferred to the caller.

This function is only called ifcreatePopupMenu(constQPoint &) returns 0.

[signal]void Q3TextEdit::currentAlignmentChanged(int a)

This signal is emitted if the alignment of the current paragraph has changed.

The new alignment isa.

See alsosetAlignment().

[signal]void Q3TextEdit::currentColorChanged(constQColor & c)

This signal is emitted if the color of the current format has changed.

The new color isc.

See alsosetColor().

QFont Q3TextEdit::currentFont() const

Returns the font of the current format.

See alsosetCurrentFont(),setFamily(), andsetPointSize().

[signal]void Q3TextEdit::currentFontChanged(constQFont & f)

This signal is emitted if the font of the current format has changed.

The new font isf.

See alsosetCurrentFont().

[signal]void Q3TextEdit::currentVerticalAlignmentChanged(Q3TextEdit::VerticalAlignment a)

This signal is emitted if the vertical alignment of the current format has changed.

The new vertical alignment isa.

[signal]void Q3TextEdit::cursorPositionChanged(int para,int pos)

This is an overloaded function.

This signal is emitted if the position of the cursor has changed.para contains the paragraph index andpos contains the character position within the paragraph.

Note:SignalcursorPositionChanged is overloaded in this class. To connect to this one using the function pointer syntax, you must specify the signal type in a static cast, as shown in this example:

connect(3TextEdit,static_cast<void(Q3TextEdit::*)(int,int)>(&Q3TextEdit::cursorPositionChanged),[=](int para,int pos){/* ... */ });

See alsosetCursorPosition().

[virtual slot]void Q3TextEdit::cut()

Copies the selected text (from selection 0) to the clipboard and deletes it from the text edit.

If there is no selected text (in selection 0) nothing happens.

See alsoQ3TextEdit::copy(),paste(), andpasteSubType().

[virtual slot]void Q3TextEdit::del()

If there is some selected text (in selection 0) it is deleted. If there is no selected text (in selection 0) the character to the right of the text cursor is deleted.

See alsoremoveSelectedText() andcut().

[virtual slot]void Q3TextEdit::doKeyboardAction(Q3TextEdit::KeyboardAction action)

Executes keyboard actionaction. This is normally called by a key event handler.

[signal]void Q3TextEdit::doubleClicked(int para,int pos)

This signal is emitted when the mouse is double-clicked on the paragraphpara at character positionpos.

See alsoclicked().

[virtual protected]void Q3TextEdit::drawContents(QPainter * p,int cx,int cy,int cw,int ch)

Reimplemented fromQ3ScrollView::drawContents().

[virtual slot]void Q3TextEdit::ensureCursorVisible()

Ensures that the cursor is visible by scrolling the text edit if necessary.

See alsosetCursorPosition().

[virtual protected]bool Q3TextEdit::event(QEvent * e)

Reimplemented fromQObject::event().

[virtual]bool Q3TextEdit::eventFilter(QObject * o,QEvent * e)

Reimplemented fromQObject::eventFilter().

QString Q3TextEdit::family() const

Returns the font family of the current format.

See alsosetFamily(),setCurrentFont(), andsetPointSize().

[virtual]bool Q3TextEdit::find(constQString & expr,bool cs,bool wo,bool forward = true,int * para = 0,int * index = 0)

Finds the next occurrence of the string,expr. Returns true ifexpr was found; otherwise returns false.

Ifpara andindex are both 0 the search begins from the current cursor position. Ifpara andindex are both not 0, the search begins from the*index character position in the*para paragraph.

Ifcs is true the search is case sensitive, otherwise it is case insensitive. Ifwo is true the search looks for whole word matches only; otherwise it searches for any matching text. Ifforward is true (the default) the search works forward from the starting position to the end of the text, otherwise it works backwards to the beginning of the text.

Ifexpr is found the function returns true. Ifindex andpara are not 0, the number of the paragraph in which the first character of the match was found is put into*para, and the index position of that character within the paragraph is put into*index.

Ifexpr is not found the function returns false. Ifindex andpara are not 0 andexpr is not found,*index and*para are undefined.

Please note that this function will make the next occurrence of the string (if found) the current selection, and will thus modify the cursor position.

Using thepara andindex parameters will not work correctly in case the document contains tables.

[virtual protected]bool Q3TextEdit::focusNextPrevChild(bool n)

Reimplemented fromQWidget::focusNextPrevChild().

Reimplemented to allow tabbing through links. Ifn is true the tab moves the focus to the next child; ifn is false the tab moves the focus to the previous child. Returns true if the focus was moved; otherwise returns false.

QFont Q3TextEdit::font() const

ReturnsQ3ScrollView::font()

Warning: In previous versions this function returned the font of the current format. This lead to confusion. Please usecurrentFont() instead.

void Q3TextEdit::getCursorPosition(int * para,int * index) const

This function sets the*para and*index parameters to the current cursor position.para andindex must not be 0.

See alsosetCursorPosition().

void Q3TextEdit::getSelection(int * paraFrom,int * indexFrom,int * paraTo,int * indexTo,int selNum = 0) const

If there is a selection,*paraFrom is set to the number of the paragraph in which the selection begins and*paraTo is set to the number of the paragraph in which the selection ends. (They could be the same.)*indexFrom is set to the index at which the selection begins within*paraFrom, and*indexTo is set to the index at which the selection ends within*paraTo.

If there is no selection,*paraFrom,*indexFrom,*paraTo and*indexTo are all set to -1.

IfparaFrom,indexFrom,paraTo orindexTo is 0 this function does nothing.

TheselNum is the number of the selection (multiple selections are supported). It defaults to 0 (the default selection).

See alsosetSelection() andselectedText.

[virtual]int Q3TextEdit::heightForWidth(int w) const

Reimplemented fromQWidget::heightForWidth().

Returns how many pixels high the text edit needs to be to display all the text if the text edit isw pixels wide.

[virtual protected]void Q3TextEdit::inputMethodEvent(QInputMethodEvent * e)

Reimplemented fromQWidget::inputMethodEvent().

[virtual slot]void Q3TextEdit::insert(constQString & text,uint insertionFlags = CheckNewLines | RemoveSelected)

Insertstext at the current cursor position.

TheinsertionFlags define how the text is inserted. IfRedoIndentation is set, the paragraph is re-indented. IfCheckNewLines is set, newline characters intext result in hard line breaks (i.e. new paragraphs). IfcheckNewLine is not set, the behavior of the editor is undefined if thetext contains newlines. (It is not possible to changeQ3TextEdit's newline handling behavior, but you can useQString::replace() to preprocess text before inserting it.) IfRemoveSelected is set, any selected text (in selection 0) is removed before the text is inserted.

The default flags areCheckNewLines |RemoveSelected.

If the widget is inQt::LogText mode this function will do nothing.

See alsopaste() andpasteSubType().

[virtual slot]void Q3TextEdit::insert(constQString & text,bool indent,bool checkNewLine = true,bool removeSelected = true)

Inserts the giventext. Ifindent is true the paragraph that contains the text is reindented; ifcheckNewLine is true thetext is checked for newlines and relaid out. IfremoveSelected is true and there is a selection, the insertion replaces the selected text.

[virtual slot]void Q3TextEdit::insertAt(constQString & text,int para,int index)

Insertstext in the paragraphpara at positionindex.

[virtual slot]void Q3TextEdit::insertParagraph(constQString & text,int para)

Insertstext as a new paragraph at positionpara. Ifpara is -1, the text is appended. Useappend() if the append operation is performance critical.

bool Q3TextEdit::isRedoAvailable() const

Returns true if redo is available; otherwise returns false.

bool Q3TextEdit::isUndoAvailable() const

Returns true if undo is available; otherwise returns false.

bool Q3TextEdit::italic() const

Returns true if the current format is italic; otherwise returns false.

See alsosetItalic().

[virtual protected]void Q3TextEdit::keyPressEvent(QKeyEvent * e)

Reimplemented fromQWidget::keyPressEvent().

Processes the key event,e. By default key events are used to provide keyboard navigation and text editing.

int Q3TextEdit::lineOfChar(int para,int index)

Returns the line number of the line in paragraphpara in which the character at positionindex appears. Theindex position is relative to the beginning of the paragraph. If there is no such paragraph or no such character at theindex position (e.g. the index is out of range) -1 is returned.

int Q3TextEdit::lines() const

Returns the number of lines in the text edit; this could be 0.

Warning: This function may be slow. Lines change all the time during word wrapping, so this function has to iterate over all the paragraphs and get the number of lines from each one individually.

int Q3TextEdit::linesOfParagraph(int para) const

Returns the number of lines in paragraphpara, or -1 if there is no paragraph with indexpara.

Q3MimeSourceFactory * Q3TextEdit::mimeSourceFactory() const

Returns theQ3MimeSourceFactory which is being used by this text edit.

See alsosetMimeSourceFactory().

[signal]void Q3TextEdit::modificationChanged(bool m)

This signal is emitted when the modification status of the document has changed. Ifm is true, the document was modified, otherwise the modification state has been reset to unmodified.

See alsomodified.

[virtual slot]void Q3TextEdit::moveCursor(Q3TextEdit::CursorAction action,bool select)

Moves the text cursor according toaction. This is normally used by some key event handler.select specifies whether the text between the current cursor position and the new position should be selected.

int Q3TextEdit::paragraphAt(constQPoint & pos) const

Returns the paragraph which is at positionpos (in contents coordinates).

QColor Q3TextEdit::paragraphBackgroundColor(int para) const

Returns the background color of the paragraphpara or an invalid color ifpara is out of range or the paragraph has no background set

See alsosetParagraphBackgroundColor().

int Q3TextEdit::paragraphLength(int para) const

Returns the length of the paragraphpara (i.e. the number of characters), or -1 if there is no paragraph with indexpara.

This function ignores newlines.

QRect Q3TextEdit::paragraphRect(int para) const

Returns the rectangle of the paragraphpara in contents coordinates, or an invalid rectangle ifpara is out of range.

int Q3TextEdit::paragraphs() const

Returns the number of paragraphs in the text; an empty textedit is always considered to have one paragraph, so 1 is returned in this case.

[virtual slot]void Q3TextEdit::paste()

Pastes the text from the clipboard into the text edit at the current cursor position. Only plain text is pasted.

If there is no text in the clipboard nothing happens.

See alsopasteSubType(),cut(), andQ3TextEdit::copy().

[virtual slot]void Q3TextEdit::pasteSubType(constQByteArray & subtype)

Pastes the text with formatsubtype from the clipboard into the text edit at the current cursor position. Thesubtype can be "plain" or "html".

If there is no text with formatsubtype in the clipboard nothing happens.

See alsopaste(),cut(), andQ3TextEdit::copy().

[virtual slot]void Q3TextEdit::placeCursor(constQPoint & pos,Q3TextCursor * c = 0)

Places the cursorc at the character which is closest to positionpos (in contents coordinates). Ifc is 0, the default text cursor is used.

See alsosetCursorPosition().

int Q3TextEdit::pointSize() const

Returns the point size of the font of the current format.

See alsosetFamily(),setCurrentFont(), andsetPointSize().

[virtual slot]void Q3TextEdit::redo()

Redoes the last operation.

If there is no operation to redo, i.e. there is no redo step in the undo/redo history, nothing happens.

See alsoredoAvailable(),undo(), andundoDepth().

[signal]void Q3TextEdit::redoAvailable(bool yes)

This signal is emitted when the availability of redo changes. Ifyes is true, thenredo() will work until redoAvailable(false) is next emitted.

See alsoredo() andundoDepth().

[virtual slot]void Q3TextEdit::removeParagraph(int para)

Removes the paragraphpara.

[virtual slot]void Q3TextEdit::removeSelectedText(int selNum = 0)

Deletes the text of selectionselNum (by default, the default selection, 0). If there is no selected text nothing happens.

See alsoselectedText andremoveSelection().

[virtual slot]void Q3TextEdit::removeSelection(int selNum = 0)

Removes the selectionselNum (by default 0). This does not remove the selected text.

See alsoremoveSelectedText().

[protected]void Q3TextEdit::repaintChanged()

Repaints any paragraphs that have changed.

Although used extensively internally you shouldn't need to call this yourself.

[virtual protected]void Q3TextEdit::resizeEvent(QResizeEvent * e)

Reimplemented fromQWidget::resizeEvent().

[signal]void Q3TextEdit::returnPressed()

This signal is emitted if the user pressed the Return or the Enter key.

[virtual slot]void Q3TextEdit::scrollToAnchor(constQString & name)

Scrolls the text edit to make the text at the anchor calledname visible, if it can be found in the document. If the anchor isn't found no scrolling will occur. An anchor is defined using the HTML anchor tag, e.g.<a name="target">.

[virtual slot]void Q3TextEdit::scrollToBottom()

Scrolls to the bottom of the document and does formatting if required.

[virtual slot]void Q3TextEdit::selectAll(bool select = true)

Ifselect is true (the default), all the text is selected as selection 0. Ifselect is false any selected text is unselected, i.e. the default selection (selection 0) is cleared.

See alsoselectedText.

[signal]void Q3TextEdit::selectionChanged()

This signal is emitted whenever the selection changes.

See alsosetSelection() andcopyAvailable().

[virtual slot]void Q3TextEdit::setAlignment(int a)

Sets the alignment of the current paragraph toa. Valid alignments areQt::AlignLeft,Qt::AlignRight,Qt::AlignJustify andQt::AlignCenter (which centers horizontally).

See alsoalignment().

[virtual slot]void Q3TextEdit::setBold(bool b)

Ifb is true sets the current format to bold; otherwise sets the current format to non-bold.

See alsobold().

[virtual slot]void Q3TextEdit::setColor(constQColor & c)

Sets the color of the current format, i.e. of the text, toc.

See alsocolor() andsetPaper().

[virtual slot]void Q3TextEdit::setCurrentFont(constQFont & f)

Sets the font of the current format tof.

If the widget is inQt::LogText mode this function will do nothing. UsesetFont() instead.

See alsocurrentFont(),setPointSize(), andsetFamily().

[virtual slot]void Q3TextEdit::setCursorPosition(int para,int index)

Sets the cursor to positionindex in paragraphpara.

See alsogetCursorPosition().

[virtual slot]void Q3TextEdit::setFamily(constQString & fontFamily)

Sets the font family of the current format tofontFamily.

See alsofamily() andsetCurrentFont().

[virtual slot]void Q3TextEdit::setItalic(bool b)

Ifb is true sets the current format to italic; otherwise sets the current format to non-italic.

See alsoitalic().

[virtual slot]void Q3TextEdit::setMimeSourceFactory(Q3MimeSourceFactory * factory)

Sets the text edit's mimesource factory tofactory. SeeQ3MimeSourceFactory for further details.

See alsomimeSourceFactory().

[virtual slot]void Q3TextEdit::setParagraphBackgroundColor(int para, constQColor & bg)

Sets the background color of the paragraphpara tobg.

See alsoparagraphBackgroundColor().

[virtual slot]void Q3TextEdit::setPointSize(int s)

Sets the point size of the current format tos.

Note that ifs is zero or negative, the behavior of this function is not defined.

See alsopointSize(),setCurrentFont(), andsetFamily().

[virtual slot]void Q3TextEdit::setSelection(int paraFrom,int indexFrom,int paraTo,int indexTo,int selNum = 0)

Sets a selection which starts at positionindexFrom in paragraphparaFrom and ends at positionindexTo in paragraphparaTo.

Any existing selections which have a different id (selNum) are left alone, but if an existing selection has the same id asselNum it is removed and replaced by this selection.

Uses the selection settings of selectionselNum. IfselNum is 0, this is the default selection.

The cursor is moved to the end of the selection ifselNum is 0, otherwise the cursor position remains unchanged.

See alsogetSelection() andselectedText.

[virtual slot]void Q3TextEdit::setSelectionAttributes(int selNum, constQColor & back,bool invertText)

Sets the background color of selection numberselNum toback and specifies whether the text of this selection should be inverted withinvertText.

This only works forselNum > 0. The default selection (selNum == 0) gets its attributes from the text edit'spalette().

[virtual slot]void Q3TextEdit::setStyleSheet(Q3StyleSheet * styleSheet)

Sets the stylesheet to use with this text edit tostyleSheet. Changes will only take effect for new text added withsetText() orappend().

See alsostyleSheet().

[virtual slot]void Q3TextEdit::setUnderline(bool b)

Ifb is true sets the current format to underline; otherwise sets the current format to non-underline.

See alsounderline().

[virtual slot]void Q3TextEdit::setVerticalAlignment(Q3TextEdit::VerticalAlignment a)

Sets the vertical alignment of the current format, i.e. of the text, toa.

See alsoverticalAlignment(),color(), andsetPaper().

[virtual]QSize Q3TextEdit::sizeHint() const

Reimplemented fromQWidget::sizeHint().

Q3StyleSheet * Q3TextEdit::styleSheet() const

Returns theQ3StyleSheet which is being used by this text edit.

See alsosetStyleSheet().

[virtual slot]void Q3TextEdit::sync()

Q3TextEdit is optimized for large amounts text. One of its optimizations is to format only the visible text, formatting the rest on demand, e.g. as the user scrolls, so you don't usually need to call this function.

In some situations you may want to force the whole text to be formatted. For example, if after callingsetText(), you wanted to know the height of the document (usingcontentsHeight()), you would call this function first.

Q3SyntaxHighlighter * Q3TextEdit::syntaxHighlighter() const

Returns theQSyntaxHighlighter set on thisQ3TextEdit. 0 is returned if no syntax highlighter is set.

[signal]void Q3TextEdit::textChanged()

This signal is emitted whenever the text in the text edit changes.

See alsosetText() andappend().

[protected]Q3TextCursor * Q3TextEdit::textCursor() const

Returns the text edit's text cursor.

Warning: Q3TextCursor is not in the public API, but in special circumstances you might wish to use it.

bool Q3TextEdit::underline() const

Returns true if the current format is underlined; otherwise returns false.

See alsosetUnderline().

[virtual slot]void Q3TextEdit::undo()

Undoes the last operation.

If there is no operation to undo, i.e. there is no undo step in the undo/redo history, nothing happens.

See alsoundoAvailable(),redo(), andundoDepth().

[signal]void Q3TextEdit::undoAvailable(bool yes)

This signal is emitted when the availability of undo changes. Ifyes is true, thenundo() will work until undoAvailable(false) is next emitted.

See alsoundo() andundoDepth().

VerticalAlignment Q3TextEdit::verticalAlignment() const

Returns the vertical alignment of the current format.

See alsosetVerticalAlignment().

[virtual protected]void Q3TextEdit::viewportResizeEvent(QResizeEvent * e)

Reimplemented fromQ3ScrollView::viewportResizeEvent().

[virtual slot]void Q3TextEdit::zoomIn(int range)

Zooms in on the text by making the base font sizerange points larger and recalculating all font sizes to be the new size. This does not change the size of any images.

See alsozoomOut().

[virtual slot]void Q3TextEdit::zoomIn()

This is an overloaded function.

Zooms in on the text by making the base font size one point larger and recalculating all font sizes to be the new size. This does not change the size of any images.

See alsozoomOut().

[virtual slot]void Q3TextEdit::zoomOut(int range)

Zooms out on the text by making the base font sizerange points smaller and recalculating all font sizes to be the new size. This does not change the size of any images.

See alsozoomIn().

[virtual slot]void Q3TextEdit::zoomOut()

This is an overloaded function.

Zooms out on the text by making the base font size one point smaller and recalculating all font sizes to be the new size. This does not change the size of any images.

See alsozoomIn().

[virtual slot]void Q3TextEdit::zoomTo(int size)

Zooms the text by making the base font sizesize points and recalculating all font sizes to be the new size. This does not change the size of any images.