This class is a helper object to attach to a QTextEdit to add Python syntax highlighting to the text that is displayed. More...

#include <pqPythonSyntaxHighlighter.h>

Inherits QObject.

Public Types
typedef QObject	Superclass

Public Member Functions
	pqPythonSyntaxHighlighter (QObject *p, QTextEdit &textEdit)
	Creates a pqPythonSyntaxHighlighter on the given QTextEdit. More...

	~pqPythonSyntaxHighlighter () override=default

bool	isReplacingTabs () const
	Returns true if the tab key is being intercepted to insert spaces in the text edit. More...

void	setReplaceTabs (bool replaceTabs)
	Used to enable/disable tab key capture Passing true will cause the tab key to insert 4 spaces in the QTextEdit. More...

QString	Highlight (const QString &src) const
	Returns the highlighted input text. More...

void	ConnectHighligter () const
	Connects the highlighter to text. More...

Static Public Member Functions
static void	ApplySyntaxFormatting (QTextDocument *dst, const QTextDocument &src)
	Copy character formatting (syntax colors) from `src` into `dst` without modifying `dst's` text. More...

Protected Member Functions
bool	eventFilter (QObject , QEvent ) override
	This event filter is applied to the TextEdit to translate presses of the Tab key into 4 spaces being inserted. More...

Detailed Description

This class is a helper object to attach to a QTextEdit to add Python syntax highlighting to the text that is displayed.

The pygments python module is used to generate syntax highlighting. Since mixing tabs and spaces is an error for python's indentation, tabs are highlighted in red.

The QTextEdit is set up so that it uses a fixed-width font and tabs are the width of 4 spaces by the constructor.

This will also optionally capture presses of the tab key that would go to the QTextEdit and insert 4 spaces instead of the tab. This option is enabled by default.

Definition at line 38 of file pqPythonSyntaxHighlighter.h.

Member Typedef Documentation

◆ Superclass

typedef QObject pqPythonSyntaxHighlighter::Superclass

Definition at line 42 of file pqPythonSyntaxHighlighter.h.

Constructor & Destructor Documentation

◆ pqPythonSyntaxHighlighter()

pqPythonSyntaxHighlighter::pqPythonSyntaxHighlighter	(	QObject *	p,
		QTextEdit &	textEdit
	)

explicit

Creates a pqPythonSyntaxHighlighter on the given QTextEdit.

The highlighter is not directly connected to the QTextEdit object (see ConnectHighligter). NOTE: the optional tab key capture is enabled by the constructor

◆ ~pqPythonSyntaxHighlighter()

pqPythonSyntaxHighlighter::~pqPythonSyntaxHighlighter ( )

overridedefault

Member Function Documentation

◆ isReplacingTabs()

bool pqPythonSyntaxHighlighter::isReplacingTabs ( ) const

Returns true if the tab key is being intercepted to insert spaces in the text edit.

◆ setReplaceTabs()

void pqPythonSyntaxHighlighter::setReplaceTabs ( bool replaceTabs )

Used to enable/disable tab key capture Passing true will cause the tab key to insert 4 spaces in the QTextEdit.

◆ Highlight()

QString pqPythonSyntaxHighlighter::Highlight ( const QString & src ) const

Returns the highlighted input text.

◆ ConnectHighligter()

void pqPythonSyntaxHighlighter::ConnectHighligter ( ) const

Connects the highlighter to text.

This is not automatically called by the constructor as we might want to defer the connection to another widget.

◆ ApplySyntaxFormatting()

static void pqPythonSyntaxHighlighter::ApplySyntaxFormatting	(	QTextDocument *	dst,
		const QTextDocument &	src
	)

static

Copy character formatting (syntax colors) from src into dst without modifying dst's text.

◆ eventFilter()

bool pqPythonSyntaxHighlighter::eventFilter	(	QObject *	,
		QEvent *
	)

overrideprotected

This event filter is applied to the TextEdit to translate presses of the Tab key into 4 spaces being inserted.

The documentation for this class was generated from the following file:

/builds/gitlab-kitware-sciviz-ci/Qt/Python/pqPythonSyntaxHighlighter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions