diff options
Diffstat (limited to 'doc/man/man3/tqsyntaxhighlighter.3qt')
| -rw-r--r-- | doc/man/man3/tqsyntaxhighlighter.3qt | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/doc/man/man3/tqsyntaxhighlighter.3qt b/doc/man/man3/tqsyntaxhighlighter.3qt index 058be188e..2d3e92973 100644 --- a/doc/man/man3/tqsyntaxhighlighter.3qt +++ b/doc/man/man3/tqsyntaxhighlighter.3qt @@ -1,5 +1,5 @@ '\" t -.TH QSyntaxHighlighter 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- +.TH TQSyntaxHighlighter 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- .\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the .\" license file included in the distribution for a complete license .\" statement. @@ -7,19 +7,19 @@ .ad l .nh .SH NAME -QSyntaxHighlighter \- Base class for implementing TQTextEdit syntax highlighters +TQSyntaxHighlighter \- Base class for implementing TQTextEdit syntax highlighters .SH SYNOPSIS -\fC#include <ntqsyntaxhighlighter.h>\fR +\fC#include <tqsyntaxhighlighter.h>\fR .PP Inherits Qt. .PP .SS "Public Members" .in +1c .ti -1c -.BI "\fBQSyntaxHighlighter\fR ( TQTextEdit * textEdit )" +.BI "\fBTQSyntaxHighlighter\fR ( TQTextEdit * textEdit )" .br .ti -1c -.BI "virtual \fB~QSyntaxHighlighter\fR ()" +.BI "virtual \fB~TQSyntaxHighlighter\fR ()" .br .ti -1c .BI "virtual int \fBhighlightParagraph\fR ( const TQString & text, int endStateOfLastPara ) = 0" @@ -44,27 +44,27 @@ Inherits Qt. .br .in -1c .SH DESCRIPTION -The QSyntaxHighlighter class is a base class for implementing TQTextEdit syntax highlighters. +The TQSyntaxHighlighter class is a base class for implementing TQTextEdit syntax highlighters. .PP A syntax highligher automatically highlights parts of the text in a TQTextEdit. Syntax highlighters are often used when the user is entering text in a specific format (for example, source code) and help the user to read the text and identify syntax errors. .PP -To provide your own syntax highlighting for TQTextEdit, you must subclass QSyntaxHighlighter and reimplement highlightParagraph(). +To provide your own syntax highlighting for TQTextEdit, you must subclass TQSyntaxHighlighter and reimplement highlightParagraph(). .PP -When you create an instance of your QSyntaxHighlighter subclass, pass it the TQTextEdit that you want the syntax highlighting to be applied to. After this your highlightParagraph() function will be called automatically whenever necessary. Use your highlightParagraph() function to apply formatting (e.g. setting the font and color) to the text that is passed to it. +When you create an instance of your TQSyntaxHighlighter subclass, pass it the TQTextEdit that you want the syntax highlighting to be applied to. After this your highlightParagraph() function will be called automatically whenever necessary. Use your highlightParagraph() function to apply formatting (e.g. setting the font and color) to the text that is passed to it. .PP See also Basic Widgets and Text Related Classes. .SH MEMBER FUNCTION DOCUMENTATION -.SH "QSyntaxHighlighter::QSyntaxHighlighter ( TQTextEdit * textEdit )" -Constructs the QSyntaxHighlighter and installs it on \fItextEdit\fR. +.SH "TQSyntaxHighlighter::TQSyntaxHighlighter ( TQTextEdit * textEdit )" +Constructs the TQSyntaxHighlighter and installs it on \fItextEdit\fR. .PP -It is the caller's responsibility to delete the QSyntaxHighlighter when it is no longer needed. -.SH "QSyntaxHighlighter::~QSyntaxHighlighter ()\fC [virtual]\fR" +It is the caller's responsibility to delete the TQSyntaxHighlighter when it is no longer needed. +.SH "TQSyntaxHighlighter::~TQSyntaxHighlighter ()\fC [virtual]\fR" Destructor. Uninstalls this syntax highlighter from the textEdit() -.SH "int QSyntaxHighlighter::currentParagraph () const" +.SH "int TQSyntaxHighlighter::currentParagraph () const" Returns the id of the paragraph which is highlighted, or -1 of no paragraph is currently highlighted. .PP Usually this function is called from within highlightParagraph(). -.SH "int QSyntaxHighlighter::highlightParagraph ( const TQString & text, int endStateOfLastPara )\fC [pure virtual]\fR" +.SH "int TQSyntaxHighlighter::highlightParagraph ( const TQString & text, int endStateOfLastPara )\fC [pure virtual]\fR" This function is called when necessary by the rich text engine, i.e. on paragraphs which have changed. .PP In your reimplementation you should parse the paragraph's \fItext\fR and call setFormat() as often as necessary to apply any font and color changes that you require. Your function must return a value which indicates the paragraph's end state: see below. @@ -80,22 +80,22 @@ The value you return is up to you. We recommend only returning 0 (to signify tha To find out which paragraph is highlighted, call currentParagraph(). .PP For example, if you're writing a simple C++ syntax highlighter, you might designate 1 to signify "in comment". For a paragraph that ended in the middle of a comment you'd return 1, and for other paragraphs you'd return 0. In your parsing code if \fIendStateOfLastPara\fR was 1, you would highlight the text as a C++ comment until you reached the closing \fC*\fR\fC/\fR. -.SH "void QSyntaxHighlighter::rehighlight ()" +.SH "void TQSyntaxHighlighter::rehighlight ()" Redoes the highlighting of the whole document. -.SH "void QSyntaxHighlighter::setFormat ( int start, int count, const TQFont & font, const TQColor & color )" +.SH "void TQSyntaxHighlighter::setFormat ( int start, int count, const TQFont & font, const TQColor & color )" This function is applied to the syntax highlighter's current paragraph (the text of which is passed to the highlightParagraph() function). .PP The specified \fIfont\fR and \fIcolor\fR are applied to the text from position \fIstart\fR for \fIcount\fR characters. (If \fIcount\fR is 0, nothing is done.) -.SH "void QSyntaxHighlighter::setFormat ( int start, int count, const TQColor & color )" +.SH "void TQSyntaxHighlighter::setFormat ( int start, int count, const TQColor & color )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "void QSyntaxHighlighter::setFormat ( int start, int count, const TQFont & font )" +.SH "void TQSyntaxHighlighter::setFormat ( int start, int count, const TQFont & font )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -.SH "TQTextEdit * QSyntaxHighlighter::textEdit () const" +.SH "TQTextEdit * TQSyntaxHighlighter::textEdit () const" Returns the TQTextEdit on which this syntax highlighter is installed .SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqsyntaxhighlighter.html +.BR http://doc.trolltech.com/tqsyntaxhighlighter.html .BR http://www.trolltech.com/faq/tech.html .SH COPYRIGHT Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the |