QGIS API Documentation
4.3.0-Master (16eddb2670e)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
gui
codeeditors
qgscodeeditordockwidget.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgscodeeditordockwidget.h
3
--------------------------------------
4
Date : March 2023
5
Copyright : (C) 2023 by Nyall Dawson
6
Email : nyall dot dawson at gmail dot com
7
***************************************************************************
8
* *
9
* This program is free software; you can redistribute it and/or modify *
10
* it under the terms of the GNU General Public License as published by *
11
* the Free Software Foundation; either version 2 of the License, or *
12
* (at your option) any later version. *
13
* *
14
***************************************************************************/
15
16
#ifndef QGSCODEEDITORDOCKWIDGET_H
17
#define QGSCODEEDITORDOCKWIDGET_H
18
19
#include "qgis_gui.h"
20
21
#include <QWidget>
22
23
class
QgsDockableWidgetHelper;
24
class
QToolButton;
25
26
35
class
GUI_EXPORT
QgsCodeEditorDockWidget
:
public
QWidget
36
{
37
Q_OBJECT
38
public
:
44
QgsCodeEditorDockWidget
(
const
QString &dockId = QString(),
bool
usePersistentWidget =
false
);
45
~QgsCodeEditorDockWidget
()
override
;
46
50
void
setTitle
(
const
QString &title );
51
55
QToolButton *
dockToggleButton
();
56
58
void
setDockObjectName
(
const
QString &name );
59
63
bool
isUserVisible
()
const
;
64
65
public
slots:
66
70
void
setUserVisible
(
bool
visible );
71
72
signals:
73
77
void
visibilityChanged
(
bool
isVisible );
78
79
private
:
80
std::unique_ptr<QgsDockableWidgetHelper> mDockableWidgetHelper;
81
QToolButton *mDockToggleButton =
nullptr
;
82
};
83
84
#endif
// QGSCODEEDITORDOCKWIDGET_H
QgsCodeEditorDockWidget::setDockObjectName
void setDockObjectName(const QString &name)
Sets the object name of the dock widget.
Definition
qgscodeeditordockwidget.cpp:52
QgsCodeEditorDockWidget::visibilityChanged
void visibilityChanged(bool isVisible)
Emitted when the editor's visibility is changed.
QgsCodeEditorDockWidget::setTitle
void setTitle(const QString &title)
Sets the title to use for the code editor dock widget or window.
Definition
qgscodeeditordockwidget.cpp:42
QgsCodeEditorDockWidget::isUserVisible
bool isUserVisible() const
Returns true if the widget is user visible.
Definition
qgscodeeditordockwidget.cpp:57
QgsCodeEditorDockWidget::QgsCodeEditorDockWidget
QgsCodeEditorDockWidget(const QString &dockId=QString(), bool usePersistentWidget=false)
Constructor for QgsCodeEditorDockWidget, with the specified window geometry settings key.
Definition
qgscodeeditordockwidget.cpp:22
QgsCodeEditorDockWidget::setUserVisible
void setUserVisible(bool visible)
Sets whether the editor is user visible.
Definition
qgscodeeditordockwidget.cpp:62
QgsCodeEditorDockWidget::dockToggleButton
QToolButton * dockToggleButton()
Returns the dock toggle button for the widget, which is used to toggle between dock or full window mo...
Definition
qgscodeeditordockwidget.cpp:47
Generated on
for QGIS API Documentation by
1.17.0