QgsCodeEditorPython Class Reference

A Python editor based on QScintilla2. More...

#include <qgscodeeditorpython.h>

Inheritance diagram for QgsCodeEditorPython:

Public Slots
void	searchSelectedTextInPyQGISDocs ()
	Searches the selected text in the official PyQGIS online documentation. More...

Public Member Functions
	QgsCodeEditorPython (QWidget *parent=nullptr, const QList< QString > &filenames=QList< QString >())
	Construct a new Python editor. More...
void	loadAPIs (const QList< QString > &filenames)
	Load APIs from one or more files. More...
bool	loadScript (const QString &script)
	Load a script file. More...
Public Member Functions inherited from QgsCodeEditor
	QgsCodeEditor (QWidget *parent=nullptr, const QString &title=QString(), bool folding=false, bool margin=false)
	Construct a new code editor. More...
void	addWarning (int lineNumber, const QString &warning)
	Adds a warning message and indicator to the specified a lineNumber. More...
void	clearWarnings ()
	Clears all warning messages from the editor. More...
bool	foldingVisible ()
	Returns true if the folding controls are visible in the editor. More...
void	insertText (const QString &text)
	Insert text at cursor position, or replace any selected text if user has made a selection. More...
bool	lineNumbersVisible () const
	Returns whether line numbers are visible in the editor. More...
Q_DECL_DEPRECATED bool	marginVisible ()
	Returns whether margins are in a visible state. More...
void	setCustomAppearance (const QString &scheme=QString(), const QMap< QgsCodeEditorColorScheme::ColorRole, QColor > &customColors=QMap< QgsCodeEditorColorScheme::ColorRole, QColor >(), const QString &fontFamily=QString(), int fontSize=0)
	Sets a custom appearance for the widget, disconnecting it from using the standard appearance taken from QSettings. More...
void	setFoldingVisible (bool folding)
	Set whether the folding controls are visible in the editor. More...
void	setLineNumbersVisible (bool visible)
	Sets whether line numbers should be visible in the editor. More...
Q_DECL_DEPRECATED void	setMarginVisible (bool margin)
	Set margin visible state. More...
void	setTitle (const QString &title)
	Set the widget title. More...

Protected Slots
void	autoComplete ()
	Triggers the autocompletion popup. More...

Protected Member Functions
void	initializeLexer () override
	Called when the dialect specific code lexer needs to be initialized (or reinitialized). More...
Protected Member Functions inherited from QgsCodeEditor
void	focusOutEvent (QFocusEvent *event) override
bool	isFixedPitch (const QFont &font)
void	keyPressEvent (QKeyEvent *event) override
QColor	lexerColor (QgsCodeEditorColorScheme::ColorRole role) const
	Returns the color to use in the lexer for the specified role. More...
QFont	lexerFont () const
	Returns the font to use in the lexer. More...
void	runPostLexerConfigurationTasks ()
	Performs tasks which must be run after a lexer has been set for the widget. More...

Additional Inherited Members
Public Types inherited from QgsCodeEditor
enum	MarginRole { LineNumbers = 0 , ErrorIndicators = 1 , FoldingControls = 2 }
	Margin roles. More...
Static Public Member Functions inherited from QgsCodeEditor
static QColor	color (QgsCodeEditorColorScheme::ColorRole role)
	Returns the color to use in the editor for the specified role. More...
static QColor	defaultColor (QgsCodeEditorColorScheme::ColorRole role, const QString &theme=QString())
	Returns the default color for the specified role. More...
static QFont	getMonospaceFont ()
	Returns the monospaced font to use for code editors. More...
static void	setColor (QgsCodeEditorColorScheme::ColorRole role, const QColor &color)
	Sets the color to use in the editor for the specified role. More...

Detailed Description

A Python editor based on QScintilla2.

Adds syntax highlighting and code autocompletion.

Note

may not be available in Python bindings, depending on platform support

Since

QGIS 2.6

Definition at line 48 of file qgscodeeditorpython.h.

Constructor & Destructor Documentation

QgsCodeEditorPython()

QgsCodeEditorPython::QgsCodeEditorPython	(	QWidget *	parent = nullptr,
		const QList< QString > &	filenames = QList<QString>()
	)

Construct a new Python editor.

Parameters

parent	The parent QWidget
filenames	The list of apis files to load for the Python lexer

Since

QGIS 2.6

Definition at line 33 of file qgscodeeditorpython.cpp.

Member Function Documentation

autoComplete

void QgsCodeEditorPython::autoComplete ( )

protectedslot

Triggers the autocompletion popup.

Since

QGIS 3.16

Definition at line 180 of file qgscodeeditorpython.cpp.

initializeLexer()

void QgsCodeEditorPython::initializeLexer ( )

overrideprotectedvirtual

Called when the dialect specific code lexer needs to be initialized (or reinitialized).

The default implementation does nothing.

Since

QGIS 3.16

Reimplemented from QgsCodeEditor.

Definition at line 47 of file qgscodeeditorpython.cpp.

loadAPIs()

void QgsCodeEditorPython::loadAPIs

(

const QList< QString > &

filenames

)

Load APIs from one or more files.

Parameters

filenames

The list of apis files to load for the Python lexer

Definition at line 201 of file qgscodeeditorpython.cpp.

loadScript()

bool QgsCodeEditorPython::loadScript

(

const QString &

script

)

Load a script file.

Parameters

script

The script file to load

Definition at line 208 of file qgscodeeditorpython.cpp.

searchSelectedTextInPyQGISDocs

void QgsCodeEditorPython::searchSelectedTextInPyQGISDocs ( )

slot

Searches the selected text in the official PyQGIS online documentation.

Since

QGIS 3.16

Definition at line 226 of file qgscodeeditorpython.cpp.

---

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

• /build/qgis-3.24.2+99sid/src/gui/codeeditors/qgscodeeditorpython.h
• /build/qgis-3.24.2+99sid/src/gui/codeeditors/qgscodeeditorpython.cpp