diff options
Diffstat (limited to 'doc/man/man3/tqtextedit.3qt')
| -rw-r--r-- | doc/man/man3/tqtextedit.3qt | 80 |
1 files changed, 40 insertions, 40 deletions
diff --git a/doc/man/man3/tqtextedit.3qt b/doc/man/man3/tqtextedit.3qt index deaa68ba2..148c877f4 100644 --- a/doc/man/man3/tqtextedit.3qt +++ b/doc/man/man3/tqtextedit.3qt @@ -60,7 +60,7 @@ Inherited by TQMultiLineEdit, TQTextBrowser, and TQTextView. .BI "void \fBgetSelection\fR ( int * paraFrom, int * indexFrom, int * paraTo, int * indexTo, int selNum = 0 ) const" .br .ti -1c -.BI "virtual bool \fBfind\fR ( const TQString & expr, bool cs, bool wo, bool forward = TRUE, int * para = 0, int * index = 0 )" +.BI "virtual bool \fBfind\fR ( const TQString & expr, bool cs, bool wo, bool forward = true, int * para = 0, int * index = 0 )" .br .ti -1c .BI "int \fBparagraphs\fR () const" @@ -237,7 +237,7 @@ Inherited by TQMultiLineEdit, TQTextBrowser, and TQTextView. .BI "virtual void \fBsetTextFormat\fR ( TextFormat f )" .br .ti -1c -.BI "virtual void \fBselectAll\fR ( bool select = TRUE )" +.BI "virtual void \fBselectAll\fR ( bool select = true )" .br .ti -1c .BI "virtual void \fBsetTabStopWidth\fR ( int ts )" @@ -354,7 +354,7 @@ Inherited by TQMultiLineEdit, TQTextBrowser, and TQTextView. .BI "void \fBinsert\fR ( const TQString & text, uint insertionFlags = CheckNewLines | RemoveSelected )" .br .ti -1c -.BI "virtual void insert ( const TQString & text, bool indent, bool checkNewLine = TRUE, bool removeSelected = TRUE ) \fI(obsolete)\fR" +.BI "virtual void insert ( const TQString & text, bool indent, bool checkNewLine = true, bool removeSelected = true ) \fI(obsolete)\fR" .br .ti -1c .BI "virtual void \fBinsertAt\fR ( const TQString & text, int para, int index )" @@ -532,7 +532,7 @@ TQTextEdit is an advanced WYSIWYG viewer/editor supporting rich text formatting .PP TQTextEdit has four modes of operation: <center>.nf .TS -l - l. Mode Command Notes Plain Text Editor setTextFormat(PlainText) Set text with setText(); text() returns plain text. Text attributes (e.g. colors) can be set, but plain text is always returned. Rich Text Editor setTextFormat(RichText) Set text with setText(); text() returns rich text. Rich text editing is fairly limited. You can't set margins or insert images for example (although you can read and correctly display files that have margins set and that include images). This mode is mostly useful for editing small amounts of rich text. Text Viewer setReadOnly(TRUE) Set text with setText() or append() (which has no undo history so is faster and uses less memory); text() returns plain or rich text depending on the textFormat(). This mode can correctly display a large subset of HTML tags. Log Viewer setTextFormat(LogText) +l - l. Mode Command Notes Plain Text Editor setTextFormat(PlainText) Set text with setText(); text() returns plain text. Text attributes (e.g. colors) can be set, but plain text is always returned. Rich Text Editor setTextFormat(RichText) Set text with setText(); text() returns rich text. Rich text editing is fairly limited. You can't set margins or insert images for example (although you can read and correctly display files that have margins set and that include images). This mode is mostly useful for editing small amounts of rich text. Text Viewer setReadOnly(true) Set text with setText() or append() (which has no undo history so is faster and uses less memory); text() returns plain or rich text depending on the textFormat(). This mode can correctly display a large subset of HTML tags. Log Viewer setTextFormat(LogText) .TE .fi </center> @@ -586,7 +586,7 @@ Loading and saving text is achieved using setText() and text(), for example: .br stream << textEdit->text(); .br - textEdit->setModified( FALSE ); + textEdit->setModified( false ); .br } .br @@ -647,7 +647,7 @@ Stylesheets can also be used in LogText mode. To create and use a custom tag, yo .br item->setFontWeight( TQFont::Bold ); .br - item->setFontUnderline( TRUE ); + item->setFontUnderline( true ); .br log->append( "This is a <mytag>custom tag</mytag>!" ); .br @@ -670,7 +670,7 @@ Use setSelection() to select text. The setSelectionAttributes() function is used .PP 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. .PP -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. +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. .PP TQTextEdit 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. .PP @@ -797,7 +797,7 @@ Examples: .SH "uint TQTextEdit::autoFormatting () const" Returns the enabled set of auto formatting features. See the "autoFormatting" property for details. .SH "bool TQTextEdit::bold () const" -Returns TRUE if the current format is bold; otherwise returns FALSE. +Returns true if the current format is bold; otherwise returns false. .PP See also setBold(). .SH "int TQTextEdit::charAt ( const TQPoint & pos, int * para ) const" @@ -830,9 +830,9 @@ See also hasSelectedText and copyAvailable(). .SH "void TQTextEdit::copyAvailable ( bool yes )\fC [signal]\fR" This signal is emitted when text is selected or de-selected in the text edit. .PP -When text is selected this signal will be emitted with \fIyes\fR set to TRUE. If no text has been selected or if the selected text is de-selected this signal is emitted with \fIyes\fR set to FALSE. +When text is selected this signal will be emitted with \fIyes\fR set to true. If no text has been selected or if the selected text is de-selected this signal is emitted with \fIyes\fR set to false. .PP -If \fIyes\fR is TRUE then copy() can be used to copy the selection to the clipboard. If \fIyes\fR is FALSE then copy() does nothing. +If \fIyes\fR is true then copy() can be used to copy the selection to the clipboard. If \fIyes\fR is false then copy() does nothing. .PP See also selectionChanged(). .SH "TQPopupMenu * TQTextEdit::createPopupMenu ( const TQPoint & pos )\fC [virtual protected]\fR" @@ -905,22 +905,22 @@ See also setCursorPosition(). Returns the font family of the current format. .PP See also setFamily(), setCurrentFont(), and setPointSize(). -.SH "bool TQTextEdit::find ( const TQString & expr, bool cs, bool wo, bool forward = TRUE, int * para = 0, int * index = 0 )\fC [virtual]\fR" -Finds the next occurrence of the string, \fIexpr\fR. Returns TRUE if \fIexpr\fR was found; otherwise returns FALSE. +.SH "bool TQTextEdit::find ( const TQString & expr, bool cs, bool wo, bool forward = true, int * para = 0, int * index = 0 )\fC [virtual]\fR" +Finds the next occurrence of the string, \fIexpr\fR. Returns true if \fIexpr\fR was found; otherwise returns false. .PP If \fIpara\fR and \fIindex\fR are both 0 the search begins from the current cursor position. If \fIpara\fR and \fIindex\fR are both not 0, the search begins from the \fI*index\fR character position in the \fI*para\fR paragraph. .PP -If \fIcs\fR is TRUE the search is case sensitive, otherwise it is case insensitive. If \fIwo\fR is TRUE the search looks for whole word matches only; otherwise it searches for any matching text. If \fIforward\fR 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 \fIcs\fR is true the search is case sensitive, otherwise it is case insensitive. If \fIwo\fR is true the search looks for whole word matches only; otherwise it searches for any matching text. If \fIforward\fR 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. .PP -If \fIexpr\fR is found the function returns TRUE. If \fIindex\fR and \fIpara\fR are not 0, the number of the paragraph in which the first character of the match was found is put into \fI*para\fR, and the index position of that character within the paragraph is put into \fI*index\fR. +If \fIexpr\fR is found the function returns true. If \fIindex\fR and \fIpara\fR are not 0, the number of the paragraph in which the first character of the match was found is put into \fI*para\fR, and the index position of that character within the paragraph is put into \fI*index\fR. .PP -If \fIexpr\fR is not found the function returns FALSE. If \fIindex\fR and \fIpara\fR are not 0 and \fIexpr\fR is not found, \fI*index\fR and \fI*para\fR are undefined. +If \fIexpr\fR is not found the function returns false. If \fIindex\fR and \fIpara\fR are not 0 and \fIexpr\fR is not found, \fI*index\fR and \fI*para\fR are undefined. .PP 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. .PP Using the \fIpara\fR and \fIindex\fR parameters will not work correctly in case the document contains tables. .SH "bool TQTextEdit::focusNextPrevChild ( bool n )\fC [virtual protected]\fR" -Reimplemented to allow tabbing through links. If \fIn\fR is TRUE the tab moves the focus to the next child; if \fIn\fR is FALSE the tab moves the focus to the previous child. Returns TRUE if the focus was moved; otherwise returns FALSE. +Reimplemented to allow tabbing through links. If \fIn\fR is true the tab moves the focus to the next child; if \fIn\fR is false the tab moves the focus to the previous child. Returns true if the focus was moved; otherwise returns false. .SH "TQFont TQTextEdit::font () const" \fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. .PP @@ -944,7 +944,7 @@ The \fIselNum\fR is the number of the selection (multiple selections are support .PP See also setSelection() and selectedText. .SH "bool TQTextEdit::hasSelectedText () const" -Returns TRUE if some text is selected in selection 0; otherwise returns FALSE. See the "hasSelectedText" property for details. +Returns true if some text is selected in selection 0; otherwise returns false. See the "hasSelectedText" property for details. .SH "int TQTextEdit::heightForWidth ( int w ) const\fC [virtual]\fR" Returns how many pixels high the text edit needs to be to display all the text if the text edit is \fIw\fR pixels wide. .PP @@ -959,26 +959,26 @@ The default flags are CheckNewLines | RemoveSelected. If the widget is in LogText mode this function will do nothing. .PP See also paste() and pasteSubType(). -.SH "void TQTextEdit::insert ( const TQString & text, bool indent, bool checkNewLine = TRUE, bool removeSelected = TRUE )\fC [virtual slot]\fR" +.SH "void TQTextEdit::insert ( const TQString & text, bool indent, bool checkNewLine = true, bool removeSelected = true )\fC [virtual slot]\fR" \fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. .SH "void TQTextEdit::insertAt ( const TQString & text, int para, int index )\fC [virtual slot]\fR" Inserts \fItext\fR in the paragraph \fIpara\fR at position \fIindex\fR. .SH "void TQTextEdit::insertParagraph ( const TQString & text, int para )\fC [virtual slot]\fR" Inserts \fItext\fR as a new paragraph at position \fIpara\fR. If \fIpara\fR is -1, the text is appended. Use append() if the append operation is performance critical. .SH "bool TQTextEdit::isModified () const" -Returns TRUE if the document has been modified by the user; otherwise returns FALSE. See the "modified" property for details. +Returns true if the document has been modified by the user; otherwise returns false. See the "modified" property for details. .SH "bool TQTextEdit::isOverwriteMode () const" Returns the text edit's overwrite mode. See the "overwriteMode" property for details. .SH "bool TQTextEdit::isReadOnly () const" -Returns TRUE if the text edit is read-only; otherwise returns FALSE. See the "readOnly" property for details. +Returns true if the text edit is read-only; otherwise returns false. See the "readOnly" property for details. .SH "bool TQTextEdit::isRedoAvailable () const" -Returns TRUE if redo is available; otherwise returns FALSE. +Returns true if redo is available; otherwise returns false. .SH "bool TQTextEdit::isUndoAvailable () const" -Returns TRUE if undo is available; otherwise returns FALSE. +Returns true if undo is available; otherwise returns false. .SH "bool TQTextEdit::isUndoRedoEnabled () const" -Returns TRUE if undo/redo is enabled; otherwise returns FALSE. See the "undoRedoEnabled" property for details. +Returns true if undo/redo is enabled; otherwise returns false. See the "undoRedoEnabled" property for details. .SH "bool TQTextEdit::italic () const" -Returns TRUE if the current format is italic; otherwise returns FALSE. +Returns true if the current format is italic; otherwise returns false. .PP See also setItalic(). .SH "void TQTextEdit::keyPressEvent ( TQKeyEvent * e )\fC [virtual protected]\fR" @@ -998,7 +998,7 @@ Returns the number of lines in the text edit; this could be 0. .SH "int TQTextEdit::linesOfParagraph ( int para ) const" Returns the number of lines in paragraph \fIpara\fR, or -1 if there is no paragraph with index \fIpara\fR. .SH "bool TQTextEdit::linkUnderline () const" -Returns TRUE if hypertext links will be underlined; otherwise returns FALSE. See the "linkUnderline" property for details. +Returns true if hypertext links will be underlined; otherwise returns false. See the "linkUnderline" property for details. .SH "int TQTextEdit::maxLogLines ()\fC [slot]\fR" Returns the maximum number of lines TQTextEdit can hold in LogText mode. By default the number of lines is unlimited, which is signified by a value of -1. .SH "TQMimeSourceFactory * TQTextEdit::mimeSourceFactory () const" @@ -1009,7 +1009,7 @@ See also setMimeSourceFactory(). Examples: .)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, mdi/application.cpp, and tqdir/tqdir.cpp. .SH "void TQTextEdit::modificationChanged ( bool m )\fC [signal]\fR" -This signal is emitted when the modification status of the document has changed. If \fIm\fR is TRUE, the document was modified, otherwise the modification state has been reset to unmodified. +This signal is emitted when the modification status of the document has changed. If \fIm\fR is true, the document was modified, otherwise the modification state has been reset to unmodified. .PP See also modified. .SH "void TQTextEdit::moveCursor ( CursorAction action, bool select )\fC [virtual slot]\fR" @@ -1055,7 +1055,7 @@ If there is no operation to redo, i.e. there is no redo step in the undo/redo hi .PP See also redoAvailable(), undo(), and undoDepth. .SH "void TQTextEdit::redoAvailable ( bool yes )\fC [signal]\fR" -This signal is emitted when the availability of redo changes. If \fIyes\fR is TRUE, then redo() will work until redoAvailable( FALSE ) is next emitted. +This signal is emitted when the availability of redo changes. If \fIyes\fR is true, then redo() will work until redoAvailable( false ) is next emitted. .PP See also redo() and undoDepth. .SH "void TQTextEdit::removeParagraph ( int para )\fC [virtual slot]\fR" @@ -1078,8 +1078,8 @@ This signal is emitted if the user pressed the Return or the Enter key. Scrolls the text edit to make the text at the anchor called \fIname\fR 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. \fC<a name="target">\fR. .SH "void TQTextEdit::scrollToBottom ()\fC [virtual slot]\fR" Scrolls to the bottom of the document and does formatting if required. -.SH "void TQTextEdit::selectAll ( bool select = TRUE )\fC [virtual slot]\fR" -If \fIselect\fR is TRUE (the default), all the text is selected as selection 0. If \fIselect\fR is FALSE any selected text is unselected, i.e. the default selection (selection 0) is cleared. +.SH "void TQTextEdit::selectAll ( bool select = true )\fC [virtual slot]\fR" +If \fIselect\fR is true (the default), all the text is selected as selection 0. If \fIselect\fR is false any selected text is unselected, i.e. the default selection (selection 0) is cleared. .PP See also selectedText. .SH "TQString TQTextEdit::selectedText () const" @@ -1095,7 +1095,7 @@ Reimplemented in TQMultiLineEdit. .SH "void TQTextEdit::setAutoFormatting ( uint features )" Sets the enabled set of auto formatting features to \fIfeatures\fR. See the "autoFormatting" property for details. .SH "void TQTextEdit::setBold ( bool b )\fC [virtual slot]\fR" -If \fIb\fR is TRUE sets the current format to bold; otherwise sets the current format to non-bold. +If \fIb\fR is true sets the current format to bold; otherwise sets the current format to non-bold. .PP See also bold(). .SH "void TQTextEdit::setColor ( const TQColor & c )\fC [virtual slot]\fR" @@ -1117,7 +1117,7 @@ Sets the font family of the current format to \fIfontFamily\fR. .PP See also family() and setCurrentFont(). .SH "void TQTextEdit::setItalic ( bool b )\fC [virtual slot]\fR" -If \fIb\fR is TRUE sets the current format to italic; otherwise sets the current format to non-italic. +If \fIb\fR is true sets the current format to italic; otherwise sets the current format to non-italic. .PP See also italic(). .SH "void TQTextEdit::setLinkUnderline ( bool )\fC [virtual slot]\fR" @@ -1187,7 +1187,7 @@ See also text and textFormat. .SH "void TQTextEdit::setTextFormat ( TextFormat f )\fC [virtual slot]\fR" Sets the text format: rich text, plain text, log text or auto text to \fIf\fR. See the "textFormat" property for details. .SH "void TQTextEdit::setUnderline ( bool b )\fC [virtual slot]\fR" -If \fIb\fR is TRUE sets the current format to underline; otherwise sets the current format to non-underline. +If \fIb\fR is true sets the current format to underline; otherwise sets the current format to non-underline. .PP See also underline(). .SH "void TQTextEdit::setUndoDepth ( int d )\fC [virtual slot]\fR" @@ -1218,7 +1218,7 @@ In some situations you may want to force the whole text to be formatted. For exa .SH "TQSyntaxHighlighter * TQTextEdit::syntaxHighlighter () const" Returns the TQSyntaxHighlighter set on this TQTextEdit. 0 is returned if no syntax highlighter is set. .SH "bool TQTextEdit::tabChangesFocus () const" -Returns TRUE if TAB changes focus or is accepted as input; otherwise returns FALSE. See the "tabChangesFocus" property for details. +Returns true if TAB changes focus or is accepted as input; otherwise returns false. See the "tabChangesFocus" property for details. .SH "int TQTextEdit::tabStopWidth () const" Returns the tab stop width in pixels. See the "tabStopWidth" property for details. .SH "TQString TQTextEdit::text () const" @@ -1243,7 +1243,7 @@ Returns the text edit's text cursor. .SH "TextFormat TQTextEdit::textFormat () const" Returns the text format: rich text, plain text, log text or auto text. See the "textFormat" property for details. .SH "bool TQTextEdit::underline () const" -Returns TRUE if the current format is underlined; otherwise returns FALSE. +Returns true if the current format is underlined; otherwise returns false. .PP See also setUnderline(). .SH "void TQTextEdit::undo ()\fC [virtual slot]\fR" @@ -1253,7 +1253,7 @@ If there is no operation to undo, i.e. there is no undo step in the undo/redo hi .PP See also undoAvailable(), redo(), and undoDepth. .SH "void TQTextEdit::undoAvailable ( bool yes )\fC [signal]\fR" -This signal is emitted when the availability of undo changes. If \fIyes\fR is TRUE, then undo() will work until undoAvailable( FALSE ) is next emitted. +This signal is emitted when the availability of undo changes. If \fIyes\fR is true, then undo() will work until undoAvailable( false ) is next emitted. .PP See also undo() and undoDepth. .SH "int TQTextEdit::undoDepth () const" @@ -1312,7 +1312,7 @@ Get this property's value with length(). .SH "bool linkUnderline" This property holds whether hypertext links will be underlined. .PP -If TRUE (the default) hypertext links will be displayed underlined. If FALSE links will not be displayed underlined. +If true (the default) hypertext links will be displayed underlined. If false links will not be displayed underlined. .PP Set this property's value with setLinkUnderline() and get this property's value with linkUnderline(). .SH "bool modified" @@ -1322,7 +1322,7 @@ Set this property's value with setModified() and get this property's value with .SH "bool overwriteMode" This property holds the text edit's overwrite mode. .PP -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. +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. .PP Set this property's value with setOverwriteMode() and get this property's value with isOverwriteMode(). .SH "TQBrush paper" @@ -1336,7 +1336,7 @@ This property holds whether the text edit is read-only. .PP In a read-only text edit the user can only navigate through the text and select text; modifying the text is not possible. .PP -This property's default is FALSE. +This property's default is false. .PP Set this property's value with setReadOnly() and get this property's value with isReadOnly(). .SH "TQString selectedText" @@ -1350,7 +1350,7 @@ Get this property's value with selectedText(). .SH "bool tabChangesFocus" This property holds whether TAB changes focus or is accepted as input. .PP -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. +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. .PP Set this property's value with setTabChangesFocus() and get this property's value with tabChangesFocus(). .SH "int tabStopWidth" @@ -1398,7 +1398,7 @@ This property holds whether undo/redo is enabled. .PP When changing this property, the undo/redo history is cleared. .PP -The default is TRUE. +The default is true. .PP Set this property's value with setUndoRedoEnabled() and get this property's value with isUndoRedoEnabled(). .SH "WordWrap wordWrap" |