Class: QgsCodeEditorPython¶

class qgis.gui.QgsCodeEditorPython¶

Bases: QgsCodeEditor

A Python editor based on QScintilla2. Adds syntax highlighting and code autocompletion.

Note

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

New in version 2.6.

QgsCodeEditorPython(parent: QWidget = None, filenames: Iterable[str] = []) Construct a new Python editor.

Parameters:

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

New in version 2.6:

Methods

`actionEvent`
`autoComplete`	Triggers the autocompletion popup.
`canInsertFromMimeData`
`changeEvent`
`childEvent`
`closeEvent`
`connectNotify`
`contextMenuEvent`
`create`
`customEvent`
`destroy`
`disconnectNotify`
`dragEnterEvent`
`dragLeaveEvent`
`dragMoveEvent`
`drawFrame`
`dropEvent`
`enterEvent`
`event`
`eventFilter`
`focusInEvent`
`focusNextChild`
`focusNextPrevChild`
`focusOutEvent`
`focusPreviousChild`
`fromMimeData`
`hideEvent`
`initPainter`
`initStyleOption`
`initializeLexer`
`inputMethodEvent`
`inputMethodQuery`
`isFixedPitch`
`isSignalConnected`
`keyPressEvent`
`keyReleaseEvent`
`leaveEvent`
`lexerColor`	Returns the color to use in the lexer for the specified `role`.
`lexerFont`	Returns the font to use in the lexer.
`loadAPIs`	Load APIs from one or more files
`loadScript`	Load a script file
`metric`
`mouseDoubleClickEvent`
`mouseMoveEvent`
`mousePressEvent`
`mouseReleaseEvent`
`moveEvent`
`nativeEvent`
`paintEvent`
`receivers`
`resizeEvent`
`runPostLexerConfigurationTasks`	Performs tasks which must be run after a lexer has been set for the widget.
`scrollContentsBy`
`searchSelectedTextInPyQGISDocs`	Searches the selected text in the official PyQGIS online documentation.
`sender`
`senderSignalIndex`
`setViewportMargins`
`sharedPainter`
`showEvent`
`tabletEvent`
`timerEvent`
`toMimeData`
`updateMicroFocus`
`viewportEvent`
`viewportMargins`
`viewportSizeHint`
`wheelEvent`

actionEvent(self, QActionEvent)¶

autoComplete(self)¶: Triggers the autocompletion popup.

New in version 3.16.

canInsertFromMimeData(self, QMimeData) → bool¶

changeEvent(self, QEvent)¶

childEvent(self, QChildEvent)¶

closeEvent(self, QCloseEvent)¶

connectNotify(self, QMetaMethod)¶

contextMenuEvent(self, QContextMenuEvent)¶

create(self, window: PyQt5.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)¶

customEvent(self, QEvent)¶

destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)¶

disconnectNotify(self, QMetaMethod)¶

dragEnterEvent(self, QDragEnterEvent)¶

dragLeaveEvent(self, QDragLeaveEvent)¶

dragMoveEvent(self, QDragMoveEvent)¶

drawFrame(self, QPainter)¶

dropEvent(self, QDropEvent)¶

enterEvent(self, QEvent)¶

event(self, QEvent) → bool¶

eventFilter(self, watched: QObject, event: QEvent) → bool¶

focusInEvent(self, QFocusEvent)¶

focusNextChild(self) → bool¶

focusNextPrevChild(self, bool) → bool¶

focusOutEvent(self, event: QFocusEvent)¶

focusPreviousChild(self) → bool¶

fromMimeData(self, QMimeData) → Tuple[QByteArray, bool]¶

hideEvent(self, QHideEvent)¶

initPainter(self, QPainter)¶

initStyleOption(self, QStyleOptionFrame)¶

initializeLexer(self)¶

inputMethodEvent(self, QInputMethodEvent)¶

inputMethodQuery(self, Qt.InputMethodQuery) → Any¶

isFixedPitch(self, font: QFont) → bool¶

isSignalConnected(self, QMetaMethod) → bool¶

keyPressEvent(self, event: QKeyEvent)¶

keyReleaseEvent(self, QKeyEvent)¶

leaveEvent(self, QEvent)¶

lexerColor(self, role: QgsCodeEditorColorScheme.ColorRole) → QColor¶: Returns the color to use in the lexer for the specified role.

New in version 3.16.

lexerFont(self) → QFont¶: Returns the font to use in the lexer.

New in version 3.16.

loadAPIs(self, filenames: Iterable[str])¶

Load APIs from one or more files

Parameters:: filenames (Iterable[str]) – The list of apis files to load for the Python lexer

loadScript(self, script: str) → bool¶

Load a script file

Parameters:: script (str) – The script file to load
Return type:: bool

metric(self, QPaintDevice.PaintDeviceMetric) → int¶

mouseDoubleClickEvent(self, QMouseEvent)¶

mouseMoveEvent(self, QMouseEvent)¶

mousePressEvent(self, QMouseEvent)¶

mouseReleaseEvent(self, QMouseEvent)¶

moveEvent(self, QMoveEvent)¶

nativeEvent(self, Union[QByteArray, bytes, bytearray], PyQt5.sip.voidptr) → Tuple[bool, int]¶

paintEvent(self, QPaintEvent)¶

receivers(self, PYQT_SIGNAL) → int¶

resizeEvent(self, QResizeEvent)¶

runPostLexerConfigurationTasks(self)¶: Performs tasks which must be run after a lexer has been set for the widget.

New in version 3.16.

QgsCodeEditorPython.scrollContentsBy(self, int, int)

searchSelectedTextInPyQGISDocs(self)¶: Searches the selected text in the official PyQGIS online documentation.

New in version 3.16.

sender(self) → QObject¶

senderSignalIndex(self) → int¶

QgsCodeEditorPython.setViewportMargins(self, int, int, int, int)
setViewportMargins(self, QMargins) → None¶

sharedPainter(self) → QPainter¶

showEvent(self, QShowEvent)¶

tabletEvent(self, QTabletEvent)¶

timerEvent(self, QTimerEvent)¶

toMimeData(self, Union[QByteArray, bytes, bytearray], bool) → QMimeData¶

updateMicroFocus(self)¶

viewportEvent(self, QEvent) → bool¶

viewportMargins(self) → QMargins¶

viewportSizeHint(self) → QSize¶

wheelEvent(self, QWheelEvent)¶