Class: QgsCodeEditorDockWidget

A custom dock widget for code editors.

Warning

Exposed to Python for internal use only – this class is not considered stable API.

Added in version 3.32.

Class Hierarchy

Base classes

QWidget
QObject
QPaintDevice

class qgis.gui.QgsCodeEditorDockWidget

Bases: QWidget

__init__(dockId: str | None = '', usePersistentWidget: bool = False)

Constructor for QgsCodeEditorDockWidget, with the specified window geometry settings key.

If usePersistentWidget is True then the widget (either as a dock or window) cannot be destroyed and must be hidden instead.

Parameters:

• dockId (Optional[str] = '')

• usePersistentWidget (bool = False)

dockToggleButton(self) → QToolButton | None

Returns the dock toggle button for the widget, which is used to toggle between dock or full window mode.

Return type:

Optional[QToolButton]

isUserVisible(self) → bool

Returns True if the widget is user visible.

Return type:

bool

setDockObjectName(self, name: str | None)

Sets the object name of the dock widget

Parameters:

name (Optional[str])

setTitle(self, title: str | None)

Sets the title to use for the code editor dock widget or window.

Parameters:

title (Optional[str])

setUserVisible(self, visible: bool)

Sets whether the editor is user visible.

Parameters:

visible (bool)

signal visibilityChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.