HighlightingGhostTextEdit Class Reference

#include <Tools/Widgets/highlightingghosttextedit.h>

Inheritance diagram for HighlightingGhostTextEdit:

Public Slots
void	tempHighlightGhostLine (int referenceLineNumber, int offset)
void	tempHighlightLine (int lineNumber)
Public Slots inherited from HighlightingTextEdit
virtual void	tempHighlightBlock (int blockNumber)
virtual void	tempHighlightCurrentBlock ()

Signals
void	ghostLineTempHighlighted (int referenceLineNumber, int offset)
Signals inherited from HighlightingTextEdit
void	columnNumberChanged (int columnNumber)
void	lineTempHighlighted (int blockNumber)

Public Member Functions
	HighlightingGhostTextEdit (const QString &text, QBrush highlightBrush, bool readOnly, QWidget *parent=nullptr)
	HighlightingGhostTextEdit (const QString &text, QColor highlightColor, bool readOnly, QWidget *parent=nullptr)
	~HighlightingGhostTextEdit ()=default
void	clearHighlights () override
void	highlightInsertionPoint (const int lineNumber, int column, bool moveCursor=true) override
void	highlightLine (const int lineNumber, bool moveCursor=true)
void	highlightText (const int lineNumber, bool moveCursor=true)
void	highlightText (const int lineNumber, int start, int count, bool isInline, bool moveCursor=true)
bool	insertGhostSection (int referenceLineNumber, int length)
void	lineNumberAreaPaintEvent (QPaintEvent *event) override
Public Member Functions inherited from HighlightingTextEdit
	HighlightingTextEdit (const QString &text, QBrush highlightBrush, bool readOnlyEditor=true, QWidget *parent=nullptr)
	HighlightingTextEdit (const QString &text, QColor highlightColor, bool readOnlyEditor=true, QWidget *parent=nullptr)
virtual void	clearHighlights ()
void	highlightBlock (const int blockNumber, bool moveCursor=true)
void	highlightBlockFragment (const int blockNumber, int start, int count, bool isInline, bool moveCursor=true)
void	highlightFromBlock (const int blockNumber, bool moveCursor=true)
virtual void	highlightInsertionPoint (const int blockNumber, int column, bool moveCursor=true)
virtual void	lineNumberAreaPaintEvent (QPaintEvent *event)
int	lineNumberAreaWidth ()
void	paintEvent (QPaintEvent *event) override
QTextCharFormat	selectedLineFormat ()
void	setAlternativeHighlightBrush (const QBrush &brush)
void	setBackgroundColor (const QColor &colour)
void	setBackgroundHighlight (const QBrush &brush)
void	setBackgroundHighlight (const QColor &colour)
bool	setDocumentCursor (const int blockNumber)
void	setForegroundHighlight (const QBrush &brush)
void	setForegroundHighlight (const QColor &colour)
virtual void	updateExtraSelections ()

Protected Slots
void	tempHighlightCurrentBlock () override

Additional Inherited Members
Protected Member Functions inherited from HighlightingTextEdit
void	contextMenuEvent (QContextMenuEvent *event) override
void	init (bool readOnly)
virtual QString	lineNumberStr (int blockNumber)
void	resizeEvent (QResizeEvent *event) override
Protected Attributes inherited from HighlightingTextEdit
TextHighlighter	highlighter_
QTextEdit::ExtraSelection	lineMatchSelection_
QWidget *	lineNumberArea_
bool	readOnlyEditor_ {true}
int	selectedBlockNumber_ {-1}
QTextCharFormat	selectedLineFormat_
int	selectionScrollPosition_ {-1}

Detailed Description

Adds "ghost" lines to a Highlighting text editor (so that matching lines are kept in synch)

Constructor & Destructor Documentation

HighlightingGhostTextEdit() [1/2]

HighlightingGhostTextEdit	(	const QString &	text,
		QColor	highlightColor,
		bool	readOnly,
		QWidget *	parent = nullptr
	)

HighlightingGhostTextEdit() [2/2]

HighlightingGhostTextEdit	(	const QString &	text,
		QBrush	highlightBrush,
		bool	readOnly,
		QWidget *	parent = nullptr
	)

~HighlightingGhostTextEdit()

~HighlightingGhostTextEdit ( )

default

Member Function Documentation

clearHighlights()

void clearHighlights ( )

overridevirtual

Reimplemented from HighlightingTextEdit.

ghostLineTempHighlighted

void ghostLineTempHighlighted ( int  referenceLineNumber, int  offset  )

signal

highlightInsertionPoint()

void highlightInsertionPoint ( const int  lineNumber, int  column, bool  moveCursor = true  )

overridevirtual

Reimplemented from HighlightingTextEdit.

highlightLine()

void highlightLine	(	const int	lineNumber,
		bool	moveCursor = true
	)

highlightText() [1/2]

void highlightText	(	const int	lineNumber,
		bool	moveCursor = true
	)

highlightText() [2/2]

void highlightText	(	const int	lineNumber,
		int	start,
		int	count,
		bool	isInline,
		bool	moveCursor = true
	)

insertGhostSection()

bool insertGhostSection	(	int	referenceLineNumber,
		int	length
	)

lineNumberAreaPaintEvent()

void lineNumberAreaPaintEvent ( QPaintEvent *  event )

overridevirtual

Reimplemented from HighlightingTextEdit.

tempHighlightCurrentBlock

void tempHighlightCurrentBlock ( )

overrideprotectedslot

Also called when the cursor position changes

tempHighlightGhostLine

void tempHighlightGhostLine ( int  referenceLineNumber, int  offset  )

slot

tempHighlightLine

void tempHighlightLine ( int  lineNumber )

slot