QGIS API Documentation 3.41.0-Master (d5b93354e9c)
Loading...
Searching...
No Matches
Public Slots | Signals | Public Member Functions | List of all members
QgsCodeEditorDockWidget Class Reference

A custom dock widget for code editors. More...

#include <qgscodeeditordockwidget.h>

Inheritance diagram for QgsCodeEditorDockWidget:
Inheritance graph
[legend]

Public Slots

void setUserVisible (bool visible)
 Sets whether the editor is user visible.
 

Signals

void visibilityChanged (bool isVisible)
 Emitted when the editor's visibility is changed.
 

Public Member Functions

 QgsCodeEditorDockWidget (const QString &windowGeometrySettingsKey=QString(), bool usePersistentWidget=false)
 Constructor for QgsCodeEditorDockWidget, with the specified window geometry settings key.
 
 ~QgsCodeEditorDockWidget () override
 
QToolButton * dockToggleButton ()
 Returns the dock toggle button for the widget, which is used to toggle between dock or full window mode.
 
bool isUserVisible () const
 Returns true if the widget is user visible.
 
void setDockObjectName (const QString &name)
 Sets the object name of the dock widget.
 
void setTitle (const QString &title)
 Sets the title to use for the code editor dock widget or window.
 

Detailed Description

A custom dock widget for code editors.

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

Definition at line 35 of file qgscodeeditordockwidget.h.

Constructor & Destructor Documentation

◆ QgsCodeEditorDockWidget()

QgsCodeEditorDockWidget::QgsCodeEditorDockWidget ( const QString &  windowGeometrySettingsKey = QString(),
bool  usePersistentWidget = 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.

Definition at line 20 of file qgscodeeditordockwidget.cpp.

◆ ~QgsCodeEditorDockWidget()

QgsCodeEditorDockWidget::~QgsCodeEditorDockWidget ( )
override

Definition at line 34 of file qgscodeeditordockwidget.cpp.

Member Function Documentation

◆ dockToggleButton()

QToolButton * QgsCodeEditorDockWidget::dockToggleButton ( )

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

Definition at line 44 of file qgscodeeditordockwidget.cpp.

◆ isUserVisible()

bool QgsCodeEditorDockWidget::isUserVisible ( ) const

Returns true if the widget is user visible.

Definition at line 54 of file qgscodeeditordockwidget.cpp.

◆ setDockObjectName()

void QgsCodeEditorDockWidget::setDockObjectName ( const QString &  name)

Sets the object name of the dock widget.

Definition at line 49 of file qgscodeeditordockwidget.cpp.

◆ setTitle()

void QgsCodeEditorDockWidget::setTitle ( const QString &  title)

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

Definition at line 39 of file qgscodeeditordockwidget.cpp.

◆ setUserVisible

void QgsCodeEditorDockWidget::setUserVisible ( bool  visible)
slot

Sets whether the editor is user visible.

Definition at line 59 of file qgscodeeditordockwidget.cpp.

◆ visibilityChanged

void QgsCodeEditorDockWidget::visibilityChanged ( bool  isVisible)
signal

Emitted when the editor's visibility is changed.


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