Unix/Linux Go Back    


CentOS 7.0 - man page for qtextedit (centos section 3qt)

Linux & Unix Commands - Search Man Pages
Man Page or Keyword Search:   man
Select Man Page Set:       apropos Keyword Search (sections above)


QTextEdit(3qt)									   QTextEdit(3qt)

NAME
       QTextEdit - Powerful single-page rich text editor

SYNOPSIS
       #include <qtextedit.h>

       Inherits QScrollView.

       Inherited by QMultiLineEdit, QTextBrowser, and QTextView.

   Public Members
       enum WordWrap { NoWrap, WidgetWidth, FixedPixelWidth, FixedColumnWidth }
       enum WrapPolicy { AtWordBoundary, AtWhiteSpace = AtWordBoundary, Anywhere,
	   AtWordOrDocumentBoundary }
       enum AutoFormatting { AutoNone = 0, AutoBulletList = 0x00000001, AutoAll = 0xffffffff }
       enum KeyboardAction { ActionBackspace, ActionDelete, ActionReturn, ActionKill,
	   ActionWordBackspace, ActionWordDelete }
       enum CursorAction { MoveBackward, MoveForward, MoveWordBackward, MoveWordForward, MoveUp,
	   MoveDown, MoveLineStart, MoveLineEnd, MoveHome, MoveEnd, MovePgUp, MovePgDown }
       enum VerticalAlignment { AlignNormal, AlignSuperScript, AlignSubScript }
       QTextEdit ( const QString & text, const QString & context = QString::null, QWidget *
	   parent = 0, const char * name = 0 )
       QTextEdit ( QWidget * parent = 0, const char * name = 0 )
       QString text () const
       QString text ( int para ) const
       TextFormat textFormat () const
       QString context () const
       QString documentTitle () const
       void getSelection ( int * paraFrom, int * indexFrom, int * paraTo, int * indexTo, int
	   selNum = 0 ) const
       virtual bool find ( const QString & expr, bool cs, bool wo, bool forward = TRUE, int *
	   para = 0, int * index = 0 )
       int paragraphs () const
       int lines () const
       int linesOfParagraph ( int para ) const
       int lineOfChar ( int para, int index )
       int length () const
       QRect paragraphRect ( int para ) const
       int paragraphAt ( const QPoint & pos ) const
       int charAt ( const QPoint & pos, int * para ) const
       int paragraphLength ( int para ) const
       QStyleSheet * styleSheet () const
       QMimeSourceFactory * mimeSourceFactory () const
       QBrush paper () const
       bool linkUnderline () const
       virtual int heightForWidth ( int w ) const
       bool hasSelectedText () const
       QString selectedText () const
       bool isUndoAvailable () const
       bool isRedoAvailable () const
       WordWrap wordWrap () const
       int wrapColumnOrWidth () const
       WrapPolicy wrapPolicy () const
       int tabStopWidth () const
       QString anchorAt ( const QPoint & pos )
       QString anchorAt ( const QPoint & pos, AnchorAttribute attr )
       bool isReadOnly () const
       void getCursorPosition ( int * para, int * index ) const
       bool isModified () const
       bool italic () const
       bool bold () const
       bool underline () const
       QString family () const
       int pointSize () const
       QColor color () const
       QFont font () const  (obsolete)
       QFont currentFont () const
       int alignment () const
       int undoDepth () const
       bool isOverwriteMode () const
       QColor paragraphBackgroundColor ( int para ) const
       bool isUndoRedoEnabled () const
       bool tabChangesFocus () const
       void setAutoFormatting ( uint features )
       uint autoFormatting () const
       QSyntaxHighlighter * syntaxHighlighter () const

   Public Slots
       virtual void setMimeSourceFactory ( QMimeSourceFactory * factory )
       virtual void setStyleSheet ( QStyleSheet * styleSheet )
       virtual void scrollToAnchor ( const QString & name )
       virtual void setPaper ( const QBrush & pap )
       virtual void setLinkUnderline ( bool )
       virtual void setWordWrap ( WordWrap mode )
       virtual void setWrapColumnOrWidth ( int )
       virtual void setWrapPolicy ( WrapPolicy policy )
       virtual void copy ()
       virtual void append ( const QString & text )
       void setText ( const QString & txt )
       virtual void setText ( const QString & text, const QString & context )
       virtual void setTextFormat ( TextFormat f )
       virtual void selectAll ( bool select = TRUE )
       virtual void setTabStopWidth ( int ts )
       virtual void zoomIn ( int range )
       virtual void zoomIn ()
       virtual void zoomOut ( int range )
       virtual void zoomOut ()
       virtual void zoomTo ( int size )
       virtual void sync ()
       virtual void setReadOnly ( bool b )
       virtual void undo ()
       virtual void redo ()
       virtual void cut ()
       virtual void paste ()
       virtual void pasteSubType ( const QCString & subtype )
       virtual void clear ()
       virtual void del ()
       virtual void setItalic ( bool b )
       virtual void setBold ( bool b )
       virtual void setUnderline ( bool b )
       virtual void setFamily ( const QString & fontFamily )
       virtual void setPointSize ( int s )
       virtual void setColor ( const QColor & c )
       virtual void setVerticalAlignment ( VerticalAlignment a )
       virtual void setAlignment ( int a )
       virtual void setCursorPosition ( int para, int index )
       virtual void setSelection ( int paraFrom, int indexFrom, int paraTo, int indexTo, int
	   selNum = 0 )
       virtual void setSelectionAttributes ( int selNum, const QColor & back, bool invertText )
       virtual void setModified ( bool m )
       virtual void setUndoDepth ( int d )
       virtual void ensureCursorVisible ()
       virtual void placeCursor ( const QPoint & pos, QTextCursor * c = 0 )
       virtual void moveCursor ( CursorAction action, bool select )
       virtual void doKeyboardAction ( KeyboardAction action )
       virtual void removeSelectedText ( int selNum = 0 )
       virtual void removeSelection ( int selNum = 0 )
       virtual void setCurrentFont ( const QFont & f )
       virtual void setOverwriteMode ( bool b )
       virtual void scrollToBottom ()
       void insert ( const QString & text, uint insertionFlags = CheckNewLines | RemoveSelected )
       virtual void insert ( const QString & text, bool indent, bool checkNewLine = TRUE, bool
	   removeSelected = TRUE )  (obsolete)
       virtual void insertAt ( const QString & text, int para, int index )
       virtual void removeParagraph ( int para )
       virtual void insertParagraph ( const QString & text, int para )
       virtual void setParagraphBackgroundColor ( int para, const QColor & bg )
       virtual void clearParagraphBackground ( int para )
       virtual void setUndoRedoEnabled ( bool b )
       void setTabChangesFocus ( bool b )
       void setMaxLogLines ( int limit )
       int maxLogLines ()

   Signals
       void textChanged ()
       void selectionChanged ()
       void copyAvailable ( bool yes )
       void undoAvailable ( bool yes )
       void redoAvailable ( bool yes )
       void currentFontChanged ( const QFont & f )
       void currentColorChanged ( const QColor & c )
       void currentAlignmentChanged ( int a )
       void currentVerticalAlignmentChanged ( VerticalAlignment a )
       void cursorPositionChanged ( int para, int pos )
       void returnPressed ()
       void modificationChanged ( bool m )
       void clicked ( int para, int pos )
       void doubleClicked ( int para, int pos )

   Properties
       AutoFormatting autoFormatting - the enabled set of auto formatting features
       QString documentTitle - the title of the document parsed from the text  (read only)
       bool hasSelectedText - whether some text is selected in selection 0  (read only)
       int length - the number of characters in the text  (read only)
       bool linkUnderline - whether hypertext links will be underlined
       bool modified - whether the document has been modified by the user
       bool overwriteMode - the text edit's overwrite mode
       QBrush paper - the background (paper) brush
       bool readOnly - whether the text edit is read-only
       QString selectedText - the selected text (from selection 0) or an empty string if there is
	   no currently selected text (in selection 0)	(read only)
       bool tabChangesFocus - whether TAB changes focus or is accepted as input
       int tabStopWidth - the tab stop width in pixels
       QString text - the text edit's text
       TextFormat textFormat - the text format: rich text, plain text, log text or auto text
       int undoDepth - the depth of the undo history
       bool undoRedoEnabled - whether undo/redo is enabled
       WordWrap wordWrap - the word wrap mode
       int wrapColumnOrWidth - the position (in pixels or columns depending on the wrap mode)
	   where text will be wrapped
       WrapPolicy wrapPolicy - the word wrap policy, at whitespace or anywhere

   Protected Members
       void repaintChanged ()
       virtual void keyPressEvent ( QKeyEvent * e )
       virtual bool focusNextPrevChild ( bool n )
       QTextCursor * textCursor () const
       virtual QPopupMenu * createPopupMenu ( const QPoint & pos )
       virtual QPopupMenu * createPopupMenu ()	(obsolete)

DESCRIPTION
       The QTextEdit widget provides a powerful single-page rich text editor.

       Introduction and Concepts

       Using QTextEdit as a Display Widget

       Read-only key bindings

       Using QTextEdit in LogText Mode

       Using QTextEdit as an Editor

	Editing key bindings

Introduction and Concepts
       QTextEdit 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.

       QTextEdit has four modes of operation: <center>.nf

       </center>

       <sup>1.</sup><small>A more complete API that supports setting margins, images, etc., is
       planned for a later Qt release.</small>

       QTextEdit can be used as a syntax highlighting editor when used in conjunction with
       QSyntaxHighlighter.

       We recommend that you always call setTextFormat() to set the mode you want to use. If you
       use AutoText then setText() and append() will try to determine whether the text they are
       given is plain text or rich text. If you use RichText then setText() and append() will
       assume that the text they are given is rich text. insert() simply inserts the text it is
       given.

       QTextEdit 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's alignment(). 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.

       QTextEdit can display images (using QMimeSourceFactory), lists and tables. If the text is
       too large to view within the text edit's viewport, scrollbars 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 a styleSheet(). Custom tags can be created and
       placed in a custom style sheet. Change the style sheet with setStyleSheet(); see
       QStyleSheet for details. The images identified by image tags are displayed if they can be
       interpreted using the text edit's QMimeSourceFactory; see setMimeSourceFactory().

       If you want a text browser with more navigation use QTextBrowser. If you just need to
       display a small piece of rich text use QLabel or QSimpleRichText.

       If you create a new QTextEdit, and want to allow the user to edit rich text, call
       setTextFormat(Qt::RichText) to ensure that the text is treated as rich text. (Rich text
       uses HTML tags to set text formatting attributes. See QStyleSheet for information on the
       HTML tags that are supported.). If you don't call setTextFormat() 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 call setTextFormat(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 QTextEdit as a Display Widget
       QTextEdit can display a large HTML subset, including tables and images.

       The text is set or replaced using setText() which deletes any existing text and replaces
       it with the text passed in the setText() call. If you call setText() with legacy HTML
       (with setTextFormat(RichText) in force), and then call text(), the text that is returned
       may have different markup, but will render the same. Text can be inserted with insert(),
       paste(), pasteSubType() and append(). Text that is appended does not go into the undo
       history; this makes append() faster and consumes less memory. Text can also be cut(). The
       entire text is deleted with clear() and the selected text is deleted with
       removeSelectedText(). Selected (marked) text can also be deleted with del() (which will
       delete the character to the right of the cursor if no text is selected).

       Loading and saving text is achieved using setText() and text(), for example:

	   QFile file( fileName ); // Read the text from a file
	   if ( file.open( IO_ReadOnly ) ) {
	       QTextStream stream( &file );
	       textEdit->setText( stream.read() );
	   }
	   QFile file( fileName ); // Write the text to a file
	   if ( 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. The
       setWordWrap() function is used to specify the kind of word wrap you want, or NoWrap if you
       don't want any wrapping. Call setWordWrap() to set a fixed pixel width FixedPixelWidth, or
       character column (e.g. 80 column) FixedColumnWidth with the pixels or columns specified
       with setWrapColumnOrWidth(). If you use word wrap to the widget's width WidgetWidth, you
       can specify whether to break on whitespace or anywhere with setWrapPolicy().

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

       Hypertext links are automatically underlined; this can be changed with setLinkUnderline().
       The tab stop width is set with setTabStopWidth().

       The zoomIn() and zoomOut() functions can be used to resize the text by increasing
       (decreasing for zoomOut()) the point size used. Images are not affected by the zoom
       functions.

       The lines() function returns the number of lines in the text and paragraphs() returns the
       number of paragraphs. The number of lines within a particular paragraph is returned by
       linesOfParagraph(). The length of the entire text in characters is returned by length().

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

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

       <h4> Read-only key bindings </h4>

       When QTextEdit is used read-only the key-bindings are limited to navigation, and text may
       only be selected with the mouse: <center>.nf

       </center>

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

       The text displayed in a text edit has a context. The context is a path which the text
       edit's QMimeSourceFactory uses to resolve the locations of files and images. It is passed
       to the mimeSourceFactory() when quering data. (See QTextEdit() and context().)

       <h4> Using QTextEdit in LogText Mode </h4>

       Setting the text format to LogText puts the widget in a special mode which is optimized
       for very large texts. Editing, word wrap, and rich text support are disabled in this mode
       (the widget is explicitly made read-only). 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 &lt;, &gt; and &amp;. 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 in LogText mode. To create and use a custom tag, you could do
       the following:

	   QTextEdit * log = new QTextEdit( this );
	   log->setTextFormat( Qt::LogText );
	   QStyleSheetItem * item = new QStyleSheetItem( 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 a QStyleSheetItem is
       used in LogText mode.

       Note that you can use setMaxLogLines() to limit the number of lines the widget can hold in
       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 QTextEdit as an Editor
       All the information about using QTextEdit as a display widget also applies here.

       The current format's attributes are set with setItalic(), setBold(), setUnderline(),
       setFamily() (font family), setPointSize(), setColor() and setCurrentFont(). The current
       paragraph's alignment is set with setAlignment().

       Use setSelection() to select text. The setSelectionAttributes() function is used to
       indicate how selected text should be displayed. Use hasSelectedText() to find out if any
       text is selected. The currently selected text's position is available using getSelection()
       and the selected text itself is returned by selectedText(). The selection can be copied to
       the clipboard with copy(), or cut to the clipboard with cut(). It can be deleted with
       removeSelectedText(). The entire text can be selected (or unselected) using selectAll().
       QTextEdit 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 with setCursorPosition() and getCursorPosition()
       respectively. When the cursor is moved, the signals currentFontChanged(),
       currentColorChanged() and currentAlignmentChanged() are emitted to reflect the font, color
       and alignment at the new cursor position.

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

       QTextEdit provides command-based undo and redo. To set the depth of the command history
       use setUndoDepth() which defaults to 100 steps. To undo or redo the last operation call
       undo() or redo(). The signals undoAvailable() and redoAvailable() indicate whether the
       undo and redo operations can be executed.

       The indent() function is used to reindent a paragraph. It is useful for code editors, for
       example in Qt Designer's code editor Ctrl+I invokes the indent() function.

       <h4> Editing key bindings </h4>

       The list of key-bindings which are implemented for editing: <center>.nf

       </center>

       To select (mark) text hold down the Shift key whilst pressing one of the movement
       keystrokes, for example, Shift+Right Arrow will select the character to the right, and
       Shift+Ctrl+Right Arrow 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, using setOverwriteMode().

       See also Basic Widgets and Text Related Classes.

   Member Type Documentation
QTextEdit::AutoFormatting
       QTextEdit::AutoNone - Do not perform any automatic formatting

       QTextEdit::AutoBulletList - Only automatically format bulletted lists

       QTextEdit::AutoAll - Apply all available autoformatting

QTextEdit::CursorAction
       This enum is used by moveCursor() to specify in which direction the cursor should be
       moved:

       QTextEdit::MoveBackward - Moves the cursor one character backward

       QTextEdit::MoveWordBackward - Moves the cursor one word backward

       QTextEdit::MoveForward - Moves the cursor one character forward

       QTextEdit::MoveWordForward - Moves the cursor one word forward

       QTextEdit::MoveUp - Moves the cursor up one line

       QTextEdit::MoveDown - Moves the cursor down one line

       QTextEdit::MoveLineStart - Moves the cursor to the beginning of the line

       QTextEdit::MoveLineEnd - Moves the cursor to the end of the line

       QTextEdit::MoveHome - Moves the cursor to the beginning of the document

       QTextEdit::MoveEnd - Moves the cursor to the end of the document

       QTextEdit::MovePgUp - Moves the cursor one viewport page up

       QTextEdit::MovePgDown - Moves the cursor one viewport page down

QTextEdit::KeyboardAction
       This enum is used by doKeyboardAction() to specify which action should be executed:

       QTextEdit::ActionBackspace - Delete the character to the left of the cursor.

       QTextEdit::ActionDelete - Delete the character to the right of the cursor.

       QTextEdit::ActionReturn - Split the paragraph at the cursor position.

       QTextEdit::ActionKill - If the cursor is not at the end of the paragraph, delete the text
       from the cursor position until the end of the paragraph. If the cursor is at the end of
       the paragraph, delete the hard line break at the end of the paragraph: this will cause
       this paragraph to be joined with the following paragraph.

       QTextEdit::ActionWordBackspace - Delete the word to the left of the cursor position.

       QTextEdit::ActionWordDelete - Delete the word to the right of the cursor position

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

       QTextEdit::AlignNormal - Normal alignment

       QTextEdit::AlignSuperScript - Superscript

       QTextEdit::AlignSubScript - Subscript

QTextEdit::WordWrap
       This enum defines the QTextEdit's word wrap modes.

       QTextEdit::NoWrap - Do not wrap the text.

       QTextEdit::WidgetWidth - Wrap the text at the current width of the widget (this is the
       default). Wrapping is at whitespace by default; this can be changed with setWrapPolicy().

       QTextEdit::FixedPixelWidth - Wrap the text at a fixed number of pixels from the widget's
       left side. The number of pixels is set with wrapColumnOrWidth().

       QTextEdit::FixedColumnWidth - Wrap the text at a fixed number of character columns from
       the widget's left side. The number of characters is set with wrapColumnOrWidth(). This is
       useful if you need formatted text that can also be displayed gracefully on devices with
       monospaced fonts, for example a standard VT100 terminal, where you might set
       wrapColumnOrWidth() to 80.

       See also wordWrap and wordWrap.

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

       QTextEdit::AtWhiteSpace - Don't use this deprecated value (it is a synonym for
       AtWordBoundary which you should use instead).

       QTextEdit::Anywhere - Break anywhere, including within words.

       QTextEdit::AtWordBoundary - Break lines at word boundaries, e.g. spaces or newlines

       QTextEdit::AtWordOrDocumentBoundary - Break lines at whitespace, e.g. spaces or newlines
       if possible. Break it anywhere otherwise.

       See also wrapPolicy.

MEMBER FUNCTION DOCUMENTATION
QTextEdit::QTextEdit ( const QString & text, const QString & context = QString::null, QWidget *
       parent = 0, const char * name = 0 )
       Constructs a QTextEdit called name, with parent parent. The text edit will display the
       text text using context context.

       The context is a path which the text edit's QMimeSourceFactory uses to resolve the
       locations of files and images. It is passed to the mimeSourceFactory() when quering data.

       For example if the text contains an image tag, <img src="image.png">, and the context is
       "path/to/look/in", the QMimeSourceFactory 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 (because QMimeSourceFactory recognizes that we have used an absolute path) and will
       try to load "/image.png". The context is applied in exactly the same way to hrefs, for
       example, <a href="target.html">Target</a>, would resolve to" path/to/look/in/target.html".

QTextEdit::QTextEdit ( QWidget * parent = 0, const char * name = 0 )
       Constructs an empty QTextEdit called name, with parent parent.

int QTextEdit::alignment () const
       Returns the alignment of the current paragraph.

       See also setAlignment().

QString QTextEdit::anchorAt ( const QPoint & pos, AnchorAttribute attr )
       If there is an anchor at position pos (in contents coordinates), the text for attribute
       attr is returned, otherwise QString::null is returned.

QString QTextEdit::anchorAt ( const QPoint & pos )
       This is an overloaded member function, provided for convenience. It behaves essentially
       like the above function.

       If there is an anchor at position pos (in contents coordinates), its href is returned,
       otherwise QString::null is returned.

void QTextEdit::append ( const QString & text ) [virtual slot]
       Appends a new paragraph with text 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 than insert()s. If you want to append text which is added to the undo/redo
       history as well, use insertParagraph().

       Examples:

uint QTextEdit::autoFormatting () const
       Returns the enabled set of auto formatting features. See the "autoFormatting" property for
       details.

bool QTextEdit::bold () const
       Returns TRUE if the current format is bold; otherwise returns FALSE.

       See also setBold().

int QTextEdit::charAt ( const QPoint & pos, int * para ) const
       Returns the index of the character (relative to its paragraph) at position pos (in
       contents coordinates). If para is not 0, *para is set to the character's paragraph.

void QTextEdit::clear () [virtual slot]
       Deletes all the text in the text edit.

       See also cut(), removeSelectedText(), and text.

void QTextEdit::clearParagraphBackground ( int para ) [virtual slot]
       Clears the background color of the paragraph para, so that the default color is used
       again.

void QTextEdit::clicked ( int para, int pos ) [signal]
       This signal is emitted when the mouse is clicked on the paragraph para at character
       position pos.

       See also doubleClicked().

QColor QTextEdit::color () const
       Returns the color of the current format.

       See also setColor() and paper.

QString QTextEdit::context () const
       Returns the context of the text edit. The context is a path which the text edit's
       QMimeSourceFactory uses to resolve the locations of files and images.

       See also text.

       Examples:

void QTextEdit::copy () [virtual slot]
       Copies any selected text (from selection 0) to the clipboard.

       See also hasSelectedText and copyAvailable().

void QTextEdit::copyAvailable ( bool yes ) [signal]
       This signal is emitted when text is selected or de-selected in the text edit.

       When text is selected this signal will be emitted with yes set to TRUE. If no text has
       been selected or if the selected text is de-selected this signal is emitted with yes set
       to FALSE.

       If yes is TRUE then copy() can be used to copy the selection to the clipboard. If yes is
       FALSE then copy() does nothing.

       See also selectionChanged().

QPopupMenu * QTextEdit::createPopupMenu ( const QPoint & pos ) [virtual protected]
       This function is called to create a right mouse button popup menu at the document position
       pos. 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: The QPopupMenu 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.

QPopupMenu * QTextEdit::createPopupMenu () [virtual protected]
       This is an overloaded member function, provided for convenience. It behaves essentially
       like the above function.

       This function is obsolete. It is provided to keep old source working. We strongly advise
       against using it in new code.

       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 if createPopupMenu( const QPoint & ) returns 0.

void QTextEdit::currentAlignmentChanged ( int a ) [signal]
       This signal is emitted if the alignment of the current paragraph has changed.

       The new alignment is a.

       See also setAlignment().

void QTextEdit::currentColorChanged ( const QColor & c ) [signal]
       This signal is emitted if the color of the current format has changed.

       The new color is c.

       See also setColor().

QFont QTextEdit::currentFont () const
       Returns the font of the current format.

       See also setCurrentFont(), setFamily(), and setPointSize().

void QTextEdit::currentFontChanged ( const QFont & f ) [signal]
       This signal is emitted if the font of the current format has changed.

       The new font is f.

       See also setCurrentFont().

void QTextEdit::currentVerticalAlignmentChanged ( VerticalAlignment a ) [signal]
       This signal is emitted if the vertical alignment of the current format has changed.

       The new vertical alignment is a.

       See also setVerticalAlignment().

void QTextEdit::cursorPositionChanged ( int para, int pos ) [signal]
       This signal is emitted if the position of the cursor has changed. para contains the
       paragraph index and pos contains the character position within the paragraph.

       See also setCursorPosition().

void QTextEdit::cut () [virtual slot]
       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 also QTextEdit::copy(), paste(), and pasteSubType().

void QTextEdit::del () [virtual slot]
       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 also removeSelectedText() and cut().

void QTextEdit::doKeyboardAction ( KeyboardAction action ) [virtual slot]
       Executes keyboard action action. This is normally called by a key event handler.

QString QTextEdit::documentTitle () const
       Returns the title of the document parsed from the text. See the "documentTitle" property
       for details.

void QTextEdit::doubleClicked ( int para, int pos ) [signal]
       This signal is emitted when the mouse is double-clicked on the paragraph para at character
       position pos.

       See also clicked().

void QTextEdit::ensureCursorVisible () [virtual slot]
       Ensures that the cursor is visible by scrolling the text edit if necessary.

       See also setCursorPosition().

QString QTextEdit::family () const
       Returns the font family of the current format.

       See also setFamily(), setCurrentFont(), and setPointSize().

bool QTextEdit::find ( const QString & expr, bool cs, bool wo, bool forward = TRUE, int * para =
       0, int * index = 0 ) [virtual]
       Finds the next occurrence of the string, expr. Returns TRUE if expr was found; otherwise
       returns FALSE.

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

       If cs is TRUE the search is case sensitive, otherwise it is case insensitive. If wo is
       TRUE the search looks for whole word matches only; otherwise it searches for any matching
       text. If forward 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.

       If expr is found the function returns TRUE. If index and para 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.

       If expr is not found the function returns FALSE. If index and para are not 0 and expr 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 the para and index parameters will not work correctly in case the document contains
       tables.

bool QTextEdit::focusNextPrevChild ( bool n ) [virtual protected]
       Reimplemented to allow tabbing through links. If n is TRUE the tab moves the focus to the
       next child; if n is FALSE the tab moves the focus to the previous child. Returns TRUE if
       the focus was moved; otherwise returns FALSE.

QFont QTextEdit::font () const
       This function is obsolete. It is provided to keep old source working. We strongly advise
       against using it in new code.

       Returns QScrollView::font()

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

       Example: qwerty/qwerty.cpp.

void QTextEdit::getCursorPosition ( int * para, int * index ) const
       This function sets the *para and *index parameters to the current cursor position. para
       and index must not be 0.

       See also setCursorPosition().

void QTextEdit::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.

       If paraFrom, indexFrom, paraTo or indexTo is 0 this function does nothing.

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

       See also setSelection() and selectedText.

bool QTextEdit::hasSelectedText () const
       Returns TRUE if some text is selected in selection 0; otherwise returns FALSE. See the
       "hasSelectedText" property for details.

int QTextEdit::heightForWidth ( int w ) const [virtual]
       Returns how many pixels high the text edit needs to be to display all the text if the text
       edit is w pixels wide.

       Reimplemented from QWidget.

void QTextEdit::insert ( const QString & text, uint insertionFlags = CheckNewLines |
       RemoveSelected ) [slot]
       Inserts text at the current cursor position.

       The insertionFlags define how the text is inserted. If RedoIndentation is set, the
       paragraph is re-indented. If CheckNewLines is set, newline characters in text result in
       hard line breaks (i.e. new paragraphs). If checkNewLine is not set, the behaviour of the
       editor is undefined if the text contains newlines. (It is not possible to change
       QTextEdit's newline handling behavior, but you can use QString::replace() to preprocess
       text before inserting it.) If RemoveSelected is set, any selected text (in selection 0) is
       removed before the text is inserted.

       The default flags are CheckNewLines | RemoveSelected.

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

       See also paste() and pasteSubType().

void QTextEdit::insert ( const QString & text, bool indent, bool checkNewLine = TRUE, bool
       removeSelected = TRUE ) [virtual slot]
       This function is obsolete. It is provided to keep old source working. We strongly advise
       against using it in new code.

void QTextEdit::insertAt ( const QString & text, int para, int index ) [virtual slot]
       Inserts text in the paragraph para at position index.

void QTextEdit::insertParagraph ( const QString & text, int para ) [virtual slot]
       Inserts text as a new paragraph at position para. If para is -1, the text is appended. Use
       append() if the append operation is performance critical.

bool QTextEdit::isModified () const
       Returns TRUE if the document has been modified by the user; otherwise returns FALSE. See
       the "modified" property for details.

bool QTextEdit::isOverwriteMode () const
       Returns the text edit's overwrite mode. See the "overwriteMode" property for details.

bool QTextEdit::isReadOnly () const
       Returns TRUE if the text edit is read-only; otherwise returns FALSE. See the "readOnly"
       property for details.

bool QTextEdit::isRedoAvailable () const
       Returns TRUE if redo is available; otherwise returns FALSE.

bool QTextEdit::isUndoAvailable () const
       Returns TRUE if undo is available; otherwise returns FALSE.

bool QTextEdit::isUndoRedoEnabled () const
       Returns TRUE if undo/redo is enabled; otherwise returns FALSE. See the "undoRedoEnabled"
       property for details.

bool QTextEdit::italic () const
       Returns TRUE if the current format is italic; otherwise returns FALSE.

       See also setItalic().

void QTextEdit::keyPressEvent ( QKeyEvent * e ) [virtual protected]
       Processes the key event, e. By default key events are used to provide keyboard navigation
       and text editing.

       Reimplemented from QWidget.

       Reimplemented in QTextBrowser.

int QTextEdit::length () const
       Returns the number of characters in the text. See the "length" property for details.

int QTextEdit::lineOfChar ( int para, int index )
       Returns the line number of the line in paragraph para in which the character at position
       index appears. The index position is relative to the beginning of the paragraph. If there
       is no such paragraph or no such character at the index position (e.g. the index is out of
       range) -1 is returned.

int QTextEdit::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 QTextEdit::linesOfParagraph ( int para ) const
       Returns the number of lines in paragraph para, or -1 if there is no paragraph with index
       para.

bool QTextEdit::linkUnderline () const
       Returns TRUE if hypertext links will be underlined; otherwise returns FALSE. See the
       "linkUnderline" property for details.

int QTextEdit::maxLogLines () [slot]
       Returns the maximum number of lines QTextEdit can hold in LogText mode. By default the
       number of lines is unlimited, which is signified by a value of -1.

QMimeSourceFactory * QTextEdit::mimeSourceFactory () const
       Returns the QMimeSourceFactory which is being used by this text edit.

       See also setMimeSourceFactory().

       Examples:

void QTextEdit::modificationChanged ( bool m ) [signal]
       This signal is emitted when the modification status of the document has changed. If m is
       TRUE, the document was modified, otherwise the modification state has been reset to
       unmodified.

       See also modified.

void QTextEdit::moveCursor ( CursorAction action, bool select ) [virtual slot]
       Moves the text cursor according to action. 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.

QBrush QTextEdit::paper () const
       Returns the background (paper) brush. See the "paper" property for details.

int QTextEdit::paragraphAt ( const QPoint & pos ) const
       Returns the paragraph which is at position pos (in contents coordinates).

QColor QTextEdit::paragraphBackgroundColor ( int para ) const
       Returns the background color of the paragraph para or an invalid color if para is out of
       range or the paragraph has no background set

int QTextEdit::paragraphLength ( int para ) const
       Returns the length of the paragraph para (i.e. the number of characters), or -1 if there
       is no paragraph with index para.

       This function ignores newlines.

QRect QTextEdit::paragraphRect ( int para ) const
       Returns the rectangle of the paragraph para in contents coordinates, or an invalid
       rectangle if para is out of range.

int QTextEdit::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.

void QTextEdit::paste () [virtual slot]
       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 also pasteSubType(), cut(), and QTextEdit::copy().

void QTextEdit::pasteSubType ( const QCString & subtype ) [virtual slot]
       Pastes the text with format subtype from the clipboard into the text edit at the current
       cursor position. The subtype can be" plain" or "html".

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

       See also paste(), cut(), and QTextEdit::copy().

void QTextEdit::placeCursor ( const QPoint & pos, QTextCursor * c = 0 ) [virtual slot]
       Places the cursor c at the character which is closest to position pos (in contents
       coordinates). If c is 0, the default text cursor is used.

       See also setCursorPosition().

int QTextEdit::pointSize () const
       Returns the point size of the font of the current format.

       See also setFamily(), setCurrentFont(), and setPointSize().

void QTextEdit::redo () [virtual slot]
       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 also redoAvailable(), undo(), and undoDepth.

void QTextEdit::redoAvailable ( bool yes ) [signal]
       This signal is emitted when the availability of redo changes. If yes is TRUE, then redo()
       will work until redoAvailable( FALSE ) is next emitted.

       See also redo() and undoDepth.

void QTextEdit::removeParagraph ( int para ) [virtual slot]
       Removes the paragraph para.

void QTextEdit::removeSelectedText ( int selNum = 0 ) [virtual slot]
       Deletes the text of selection selNum (by default, the default selection, 0). If there is
       no selected text nothing happens.

       See also selectedText and removeSelection().

void QTextEdit::removeSelection ( int selNum = 0 ) [virtual slot]
       Removes the selection selNum (by default 0). This does not remove the selected text.

       See also removeSelectedText().

void QTextEdit::repaintChanged () [protected]
       Repaints any paragraphs that have changed.

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

void QTextEdit::returnPressed () [signal]
       This signal is emitted if the user pressed the Return or the Enter key.

void QTextEdit::scrollToAnchor ( const QString & name ) [virtual slot]
       Scrolls the text edit to make the text at the anchor called name 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">.

void QTextEdit::scrollToBottom () [virtual slot]
       Scrolls to the bottom of the document and does formatting if required.

void QTextEdit::selectAll ( bool select = TRUE ) [virtual slot]
       If select is TRUE (the default), all the text is selected as selection 0. If select is
       FALSE any selected text is unselected, i.e. the default selection (selection 0) is
       cleared.

       See also selectedText.

QString QTextEdit::selectedText () const
       Returns the selected text (from selection 0) or an empty string if there is no currently
       selected text (in selection 0). See the "selectedText" property for details.

void QTextEdit::selectionChanged () [signal]
       This signal is emitted whenever the selection changes.

       See also setSelection() and copyAvailable().

void QTextEdit::setAlignment ( int a ) [virtual slot]
       Sets the alignment of the current paragraph to a. Valid alignments are Qt::AlignLeft,
       Qt::AlignRight, Qt::AlignJustify and Qt::AlignCenter (which centers horizontally).

       Reimplemented in QMultiLineEdit.

void QTextEdit::setAutoFormatting ( uint features )
       Sets the enabled set of auto formatting features to features. See the "autoFormatting"
       property for details.

void QTextEdit::setBold ( bool b ) [virtual slot]
       If b is TRUE sets the current format to bold; otherwise sets the current format to non-
       bold.

       See also bold().

void QTextEdit::setColor ( const QColor & c ) [virtual slot]
       Sets the color of the current format, i.e. of the text, to c.

       See also color() and paper.

void QTextEdit::setCurrentFont ( const QFont & f ) [virtual slot]
       Sets the font of the current format to f.

       If the widget is in LogText mode this function will do nothing. Use setFont() instead.

       See also currentFont(), setPointSize(), and setFamily().

void QTextEdit::setCursorPosition ( int para, int index ) [virtual slot]
       Sets the cursor to position index in paragraph para.

       See also getCursorPosition().

void QTextEdit::setFamily ( const QString & fontFamily ) [virtual slot]
       Sets the font family of the current format to fontFamily.

       See also family() and setCurrentFont().

void QTextEdit::setItalic ( bool b ) [virtual slot]
       If b is TRUE sets the current format to italic; otherwise sets the current format to non-
       italic.

       See also italic().

void QTextEdit::setLinkUnderline ( bool ) [virtual slot]
       Sets whether hypertext links will be underlined. See the "linkUnderline" property for
       details.

void QTextEdit::setMaxLogLines ( int limit ) [slot]
       Sets the maximum number of lines a QTextEdit can hold in LogText mode to limit. If limit
       is -1 (the default), this signifies an unlimited number of lines.

       Warning: Never use formatting tags that span more than one line when the maximum log lines
       is set. When lines are removed from the top of the buffer it could result in an unbalanced
       tag pair, i.e. the left formatting tag is removed before the right one.

void QTextEdit::setMimeSourceFactory ( QMimeSourceFactory * factory ) [virtual slot]
       Sets the text edit's mimesource factory to factory. See QMimeSourceFactory for further
       details.

       See also mimeSourceFactory().

void QTextEdit::setModified ( bool m ) [virtual slot]
       Sets whether the document has been modified by the user to m. See the "modified" property
       for details.

void QTextEdit::setOverwriteMode ( bool b ) [virtual slot]
       Sets the text edit's overwrite mode to b. See the "overwriteMode" property for details.

void QTextEdit::setPaper ( const QBrush & pap ) [virtual slot]
       Sets the background (paper) brush to pap. See the "paper" property for details.

void QTextEdit::setParagraphBackgroundColor ( int para, const QColor & bg ) [virtual slot]
       Sets the background color of the paragraph para to bg.

void QTextEdit::setPointSize ( int s ) [virtual slot]
       Sets the point size of the current format to s.

       Note that if s is zero or negative, the behaviour of this function is not defined.

       See also pointSize(), setCurrentFont(), and setFamily().

void QTextEdit::setReadOnly ( bool b ) [virtual slot]
       Sets whether the text edit is read-only to b. See the "readOnly" property for details.

void QTextEdit::setSelection ( int paraFrom, int indexFrom, int paraTo, int indexTo, int selNum =
       0 ) [virtual slot]
       Sets a selection which starts at position indexFrom in paragraph paraFrom and ends at
       position indexTo in paragraph paraTo.

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

       Uses the selection settings of selection selNum. If selNum is 0, this is the default
       selection.

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

       See also getSelection() and selectedText.

void QTextEdit::setSelectionAttributes ( int selNum, const QColor & back, bool invertText )
       [virtual slot]
       Sets the background color of selection number selNum to back and specifies whether the
       text of this selection should be inverted with invertText.

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

void QTextEdit::setStyleSheet ( QStyleSheet * styleSheet ) [virtual slot]
       Sets the stylesheet to use with this text edit to styleSheet. Changes will only take
       effect for new text added with setText() or append().

       See also styleSheet().

void QTextEdit::setTabChangesFocus ( bool b ) [slot]
       Sets whether TAB changes focus or is accepted as input to b. See the "tabChangesFocus"
       property for details.

void QTextEdit::setTabStopWidth ( int ts ) [virtual slot]
       Sets the tab stop width in pixels to ts. See the "tabStopWidth" property for details.

void QTextEdit::setText ( const QString & txt ) [slot]
       Sets the text edit's text to txt. See the "text" property for details.

void QTextEdit::setText ( const QString & text, const QString & context ) [virtual slot]
       This is an overloaded member function, provided for convenience. It behaves essentially
       like the above function.

       Changes the text of the text edit to the string text and the context to context. Any
       previous text is removed.

       text may be interpreted either as plain text or as rich text, depending on the
       textFormat(). The default setting is AutoText, i.e. the text edit auto-detects the format
       from text.

       For rich text the rendering style and available tags are defined by a styleSheet(); see
       QStyleSheet for details.

       The optional context is a path which the text edit's QMimeSourceFactory uses to resolve
       the locations of files and images. (See QTextEdit::QTextEdit().) It is passed to the text
       edit's QMimeSourceFactory when quering data.

       Note that the undo/redo history is cleared by this function.

       See also text and textFormat.

void QTextEdit::setTextFormat ( TextFormat f ) [virtual slot]
       Sets the text format: rich text, plain text, log text or auto text to f. See the
       "textFormat" property for details.

void QTextEdit::setUnderline ( bool b ) [virtual slot]
       If b is TRUE sets the current format to underline; otherwise sets the current format to
       non-underline.

       See also underline().

void QTextEdit::setUndoDepth ( int d ) [virtual slot]
       Sets the depth of the undo history to d. See the "undoDepth" property for details.

void QTextEdit::setUndoRedoEnabled ( bool b ) [virtual slot]
       Sets whether undo/redo is enabled to b. See the "undoRedoEnabled" property for details.

void QTextEdit::setVerticalAlignment ( VerticalAlignment a ) [virtual slot]
       Sets the vertical alignment of the current format, i.e. of the text, to a.

       See also color() and paper.

void QTextEdit::setWordWrap ( WordWrap mode ) [virtual slot]
       Sets the word wrap mode to mode. See the "wordWrap" property for details.

void QTextEdit::setWrapColumnOrWidth ( int ) [virtual slot]
       Sets the position (in pixels or columns depending on the wrap mode) where text will be
       wrapped. See the "wrapColumnOrWidth" property for details.

void QTextEdit::setWrapPolicy ( WrapPolicy policy ) [virtual slot]
       Sets the word wrap policy, at whitespace or anywhere to policy. See the "wrapPolicy"
       property for details.

QStyleSheet * QTextEdit::styleSheet () const
       Returns the QStyleSheet which is being used by this text edit.

       See also setStyleSheet().

       Examples:

void QTextEdit::sync () [virtual slot]
       QTextEdit 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 calling setText(), you wanted to know the height of the document (using
       contentsHeight()), you would call this function first.

QSyntaxHighlighter * QTextEdit::syntaxHighlighter () const
       Returns the QSyntaxHighlighter set on this QTextEdit. 0 is returned if no syntax
       highlighter is set.

bool QTextEdit::tabChangesFocus () const
       Returns TRUE if TAB changes focus or is accepted as input; otherwise returns FALSE. See
       the "tabChangesFocus" property for details.

int QTextEdit::tabStopWidth () const
       Returns the tab stop width in pixels. See the "tabStopWidth" property for details.

QString QTextEdit::text () const
       Returns the text edit's text. See the "text" property for details.

QString QTextEdit::text ( int para ) const
       This is an overloaded member function, provided for convenience. It behaves essentially
       like the above function.

       Returns the text of paragraph para.

       If textFormat() is RichText the text will contain HTML formatting tags.

void QTextEdit::textChanged () [signal]
       This signal is emitted whenever the text in the text edit changes.

       See also text and append().

       Examples:

QTextCursor * QTextEdit::textCursor () const [protected]
       Returns the text edit's text cursor.

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

TextFormat QTextEdit::textFormat () const
       Returns the text format: rich text, plain text, log text or auto text. See the
       "textFormat" property for details.

bool QTextEdit::underline () const
       Returns TRUE if the current format is underlined; otherwise returns FALSE.

       See also setUnderline().

void QTextEdit::undo () [virtual slot]
       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 also undoAvailable(), redo(), and undoDepth.

void QTextEdit::undoAvailable ( bool yes ) [signal]
       This signal is emitted when the availability of undo changes. If yes is TRUE, then undo()
       will work until undoAvailable( FALSE ) is next emitted.

       See also undo() and undoDepth.

int QTextEdit::undoDepth () const
       Returns the depth of the undo history. See the "undoDepth" property for details.

WordWrap QTextEdit::wordWrap () const
       Returns the word wrap mode. See the "wordWrap" property for details.

int QTextEdit::wrapColumnOrWidth () const
       Returns the position (in pixels or columns depending on the wrap mode) where text will be
       wrapped. See the "wrapColumnOrWidth" property for details.

WrapPolicy QTextEdit::wrapPolicy () const
       Returns the word wrap policy, at whitespace or anywhere. See the "wrapPolicy" property for
       details.

void QTextEdit::zoomIn ( int range ) [virtual slot]
       Zooms in on the text by making the base font size range points larger and recalculating
       all font sizes to be the new size. This does not change the size of any images.

       See also zoomOut().

void QTextEdit::zoomIn () [virtual slot]
       This is an overloaded member function, provided for convenience. It behaves essentially
       like the above 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 also zoomOut().

void QTextEdit::zoomOut ( int range ) [virtual slot]
       Zooms out on the text by making the base font size range points smaller and recalculating
       all font sizes to be the new size. This does not change the size of any images.

       See also zoomIn().

void QTextEdit::zoomOut () [virtual slot]
       This is an overloaded member function, provided for convenience. It behaves essentially
       like the above 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 also zoomIn().

void QTextEdit::zoomTo ( int size ) [virtual slot]
       Zooms the text by making the base font size size points and recalculating all font sizes
       to be the new size. This does not change the size of any images.

   Property Documentation
AutoFormatting autoFormatting
       This property holds the enabled set of auto formatting features.

       The value can be any combination of the values in the AutoFormatting enum. The default is
       AutoAll. Choose AutoNone to disable all automatic formatting.

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

       Set this property's value with setAutoFormatting() and get this property's value with
       autoFormatting().

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

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

       Get this property's value with documentTitle().

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

       Get this property's value with hasSelectedText().

int length
       This property holds the number of characters in the text.

       Get this property's value with length().

bool linkUnderline
       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.

       Set this property's value with setLinkUnderline() and get this property's value with
       linkUnderline().

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

       Set this property's value with setModified() and get this property's value with
       isModified().

bool overwriteMode
       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.

       Set this property's value with setOverwriteMode() and get this property's value with
       isOverwriteMode().

QBrush paper
       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.

       Set this property's value with setPaper() and get this property's value with paper().

bool readOnly
       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.

       Set this property's value with setReadOnly() and get this property's value with
       isReadOnly().

QString selectedText
       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 as PlainText if the textFormat() is PlainText or AutoText,
       otherwise it is returned as HTML.

       See also hasSelectedText.

       Get this property's value with selectedText().

bool tabChangesFocus
       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.

       Set this property's value with setTabChangesFocus() and get this property's value with
       tabChangesFocus().

int tabStopWidth
       This property holds the tab stop width in pixels.

       Set this property's value with setTabStopWidth() and get this property's value with
       tabStopWidth().

QString text
       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 the
       textFormat(). The default setting is AutoText, i.e. the text edit auto-detects the format
       of the text.

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

       See also textFormat.

       Set this property's value with setText() and get this property's value with text().

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

       The text format is one of the following:

       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.

       RichText - rich text rendering. The available styles are defined in the default stylesheet
       QStyleSheet::defaultSheet().

       LogText - optimized mode for very large texts. Supports a very limited set of formatting
       tags (color, bold, underline and italic settings).

       AutoText - this is the default. The text edit autodetects which rendering style is best,
       PlainText or RichText. This is done by using the QStyleSheet::mightBeRichText() function.

       Set this property's value with setTextFormat() and get this property's value with
       textFormat().

int undoDepth
       This property holds the depth of the undo history.

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

       See also undo() and redo().

       Set this property's value with setUndoDepth() and get this property's value with
       undoDepth().

bool undoRedoEnabled
       This property holds whether undo/redo is enabled.

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

       The default is TRUE.

       Set this property's value with setUndoRedoEnabled() and get this property's value with
       isUndoRedoEnabled().

WordWrap wordWrap
       This property holds the word wrap mode.

       The default mode is WidgetWidth 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 use setWrapPolicy(). If you set a wrap mode of FixedPixelWidth or
       FixedColumnWidth you should also call setWrapColumnOrWidth() with the width you want.

       See also WordWrap, wrapColumnOrWidth, and wrapPolicy.

       Set this property's value with setWordWrap() and get this property's value with
       wordWrap().

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

       If the wrap mode is FixedPixelWidth, 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 is FixedColumnWidth,
       the value is the column number (in character columns) from the left edge of the text edit
       at which text should be wrapped.

       See also wordWrap.

       Set this property's value with setWrapColumnOrWidth() and get this property's value with
       wrapColumnOrWidth().

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

       Defines where text can be wrapped when word wrap mode is not NoWrap. The choices are
       AtWordBoundary (the default), Anywhere and AtWordOrDocumentBoundary

       See also wordWrap.

       Set this property's value with setWrapPolicy() and get this property's value with
       wrapPolicy().

SEE ALSO
       http://doc.trolltech.com/qtextedit.html http://www.trolltech.com/faq/tech.html

COPYRIGHT
       Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com.  See the license file
       included in the distribution for a complete license statement.

AUTHOR
       Generated automatically from the source code.

BUGS
       If you find a bug in Qt, please report it as described in
       http://doc.trolltech.com/bughowto.html.	Good bug reports help us to help you. Thank you.

       The definitive Qt documentation is provided in HTML format; it is located at
       $QTDIR/doc/html and can be read using Qt Assistant or with a web browser. This man page is
       provided as a convenience for those users who prefer man pages, although this format is
       not officially supported by Trolltech.

       If you find errors in this manual page, please report them to qt-bugs@trolltech.com.
       Please include the name of the manual page (qtextedit.3qt) and the Qt version (3.3.8).

Trolltech AS				 2 February 2007			   QTextEdit(3qt)
Unix & Linux Commands & Man Pages : ©2000 - 2018 Unix and Linux Forums


All times are GMT -4. The time now is 04:57 AM.