QGIS API Documentation 3.41.0-Master (d5b93354e9c)
|
A custom dock widget for code editors. More...
#include <qgscodeeditordockwidget.h>
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. | |
A custom dock widget for code editors.
Definition at line 35 of file qgscodeeditordockwidget.h.
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.
|
override |
Definition at line 34 of file qgscodeeditordockwidget.cpp.
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.
bool QgsCodeEditorDockWidget::isUserVisible | ( | ) | const |
Returns true
if the widget is user visible.
Definition at line 54 of file qgscodeeditordockwidget.cpp.
void QgsCodeEditorDockWidget::setDockObjectName | ( | const QString & | name | ) |
Sets the object name of the dock widget.
Definition at line 49 of file qgscodeeditordockwidget.cpp.
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.
|
slot |
Sets whether the editor is user visible.
Definition at line 59 of file qgscodeeditordockwidget.cpp.
|
signal |
Emitted when the editor's visibility is changed.