QGIS API Documentation 3.39.0-Master (67e056379ed)
Loading...
Searching...
No Matches
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
23class QgsDockableWidgetHelper;
24class QToolButton;
25
26
35class GUI_EXPORT QgsCodeEditorDockWidget : public QWidget
36{
37 Q_OBJECT
38 public:
39
45 QgsCodeEditorDockWidget( const QString &windowGeometrySettingsKey = QString(), bool usePersistentWidget = false );
46 ~QgsCodeEditorDockWidget() override;
47
51 void setTitle( const QString &title );
52
56 QToolButton *dockToggleButton();
57
59 void setDockObjectName( const QString &name );
60
64 bool isUserVisible() const;
65
66 public slots:
67
71 void setUserVisible( bool visible );
72
73 signals:
74
78 void visibilityChanged( bool isVisible );
79
80 private:
81
82 QgsDockableWidgetHelper *mDockableWidgetHelper = nullptr;
83 QToolButton *mDockToggleButton = nullptr;
84
85
86};
87
88#endif // QGSCODEEDITORDOCKWIDGET_H
A custom dock widget for code editors.
void visibilityChanged(bool isVisible)
Emitted when the editor's visibility is changed.