From ea318d1431c89e647598c510c4245c6571aa5f46 Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Thu, 26 Jan 2012 23:32:43 -0600 Subject: Update to latest tqt3 automated conversion --- doc/html/ntqsyntaxhighlighter.html | 158 +++++++++++++++++++++++++++++++++++++ 1 file changed, 158 insertions(+) create mode 100644 doc/html/ntqsyntaxhighlighter.html (limited to 'doc/html/ntqsyntaxhighlighter.html') diff --git a/doc/html/ntqsyntaxhighlighter.html b/doc/html/ntqsyntaxhighlighter.html new file mode 100644 index 000000000..1f6130a4e --- /dev/null +++ b/doc/html/ntqsyntaxhighlighter.html @@ -0,0 +1,158 @@ + + + + + +TQSyntaxHighlighter Class + + + + + + + +
+ +Home + | +All Classes + | +Main Classes + | +Annotated + | +Grouped Classes + | +Functions +

TQSyntaxHighlighter Class Reference

+ +

The TQSyntaxHighlighter class is a base class for +implementing TQTextEdit syntax highlighters. +More... +

#include <ntqsyntaxhighlighter.h> +

Inherits TQt. +

List of all member functions. +

Public Members

+ +

Detailed Description

+ + +The TQSyntaxHighlighter class is a base class for +implementing TQTextEdit syntax highlighters. +

+ +

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. +

To provide your own syntax highlighting for TQTextEdit, you must +subclass TQSyntaxHighlighter and reimplement highlightParagraph(). +

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. +

See also Basic Widgets and Text Related Classes. + +

Member Function Documentation

+

TQSyntaxHighlighter::TQSyntaxHighlighter ( TQTextEdit * textEdit ) +

+Constructs the TQSyntaxHighlighter and installs it on textEdit. +

It is the caller's responsibility to delete the +TQSyntaxHighlighter when it is no longer needed. + +

TQSyntaxHighlighter::~TQSyntaxHighlighter () [virtual] +

+Destructor. Uninstalls this syntax highlighter from the textEdit() + +

int TQSyntaxHighlighter::currentParagraph () const +

+Returns the id of the paragraph which is highlighted, or -1 of no +paragraph is currently highlighted. +

Usually this function is called from within highlightParagraph(). + +

int TQSyntaxHighlighter::highlightParagraph ( const TQString & text, int endStateOfLastPara ) [pure virtual] +

+ +

This function is called when necessary by the rich text engine, +i.e. on paragraphs which have changed. +

In your reimplementation you should parse the paragraph's text +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. +

Some syntaxes can have constructs that span paragraphs. For +example, a C++ syntax highlighter should be able to cope with +/*...*/ comments that span paragraphs. To deal +with these cases it is necessary to know the end state of the +previous paragraph (e.g. "in comment"). +

If your syntax does not have paragraph spanning constructs, simply +ignore the endStateOfLastPara parameter and always return 0. +

Whenever highlightParagraph() is called it is passed a value for +endStateOfLastPara. For the very first paragraph this value is +always -2. For any other paragraph the value is the value returned +by the most recent highlightParagraph() call that applied to the +preceding paragraph. +

The value you return is up to you. We recommend only returning 0 +(to signify that this paragraph's syntax highlighting does not +affect the following paragraph), or a positive integer (to signify +that this paragraph has ended in the middle of a paragraph +spanning construct). +

To find out which paragraph is highlighted, call +currentParagraph(). +

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 endStateOfLastPara was 1, you would highlight the text as a C++ +comment until you reached the closing */. + +

void TQSyntaxHighlighter::rehighlight () +

Redoes the highlighting of the whole document. + +

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). +

The specified font and color are applied to the text from +position start for count characters. (If count is 0, +nothing is done.) + +

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. + +

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. + +

TQTextEdit * TQSyntaxHighlighter::textEdit () const +

+ +

Returns the TQTextEdit on which this syntax highlighter is +installed + + +

+This file is part of the TQt toolkit. +Copyright © 1995-2007 +Trolltech. All Rights Reserved.

+ +
Copyright © 2007 +TrolltechTrademarks +
TQt 3.3.8
+
+ -- cgit v1.2.1