Class: QgsCodeEditorSQL

class qgis.gui.QgsCodeEditorSQL(parent: QWidget = None)

Bases: QgsCodeEditor

Constructor for QgsCodeEditorSQL

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


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

actionEvent(self, QActionEvent)
canInsertFromMimeData(self, QMimeData) bool
changeEvent(self, QEvent)
childEvent(self, QChildEvent)
closeEvent(self, QCloseEvent)
connectNotify(self, QMetaMethod)
contextMenuEvent(self, QContextMenuEvent)
create(self, window: 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, QObject, 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)
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.

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], sip.voidptr) Tuple[bool, int]
paintEvent(self, QPaintEvent)
receivers(self, PYQT_SIGNAL) int
resizeEvent(self, QResizeEvent)

Performs tasks which must be run after a lexer has been set for the widget.

New in version 3.16.

QgsCodeEditorSQL.scrollContentsBy(self, int, int)
sender(self) QObject
senderSignalIndex(self) int
setFields(self, fields: QgsFields)

Set field names to be added to the lexer API.

New in version 3.14.


fields (QgsFields) –

QgsCodeEditorSQL.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
viewportEvent(self, QEvent) bool
viewportMargins(self) QMargins
viewportSizeHint(self) QSize
wheelEvent(self, QWheelEvent)