QGIS API Documentation 3.43.0-Master (9e873c7bc91)
Loading...
Searching...
No Matches
qgscodeeditordockwidget.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgscodeeditordockwidget.cpp
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
17#include "moc_qgscodeeditordockwidget.cpp"
19
20QgsCodeEditorDockWidget::QgsCodeEditorDockWidget( const QString &dockId, bool usePersistentWidget )
21 : QWidget( nullptr )
22{
23 QgsDockableWidgetHelper::Options options = QgsDockableWidgetHelper::Option::RaiseTab;
24 if ( usePersistentWidget )
25 options.setFlag( QgsDockableWidgetHelper::Option::PermanentWidget );
26
27 mDockableWidgetHelper = new QgsDockableWidgetHelper(
28 tr( "Code Editor" ),
29 this,
30 QgsDockableWidgetHelper::sOwnerWindow,
31 dockId,
32 QStringList(),
33 QgsDockableWidgetHelper::OpeningMode::RespectSetting,
34 true,
35 Qt::BottomDockWidgetArea,
36 options
37 );
38
39 mDockToggleButton = mDockableWidgetHelper->createDockUndockToolButton();
40 mDockToggleButton->setToolTip( tr( "Dock Code Editor" ) );
41 connect( mDockableWidgetHelper, &QgsDockableWidgetHelper::closed, this, [=]() {
42 close();
43 } );
44
45 connect( mDockableWidgetHelper, &QgsDockableWidgetHelper::visibilityChanged, this, &QgsCodeEditorDockWidget::visibilityChanged );
46}
47
49{
50 delete mDockableWidgetHelper;
51}
52
53void QgsCodeEditorDockWidget::setTitle( const QString &title )
54{
55 mDockableWidgetHelper->setWindowTitle( title );
56}
57
59{
60 return mDockToggleButton;
61}
62
64{
65 mDockableWidgetHelper->setDockObjectName( name );
66}
67
69{
70 return mDockableWidgetHelper->isUserVisible();
71}
72
74{
75 mDockableWidgetHelper->setUserVisible( visible );
76}
void setDockObjectName(const QString &name)
Sets the object name of the dock widget.
void visibilityChanged(bool isVisible)
Emitted when the editor's visibility is changed.
void setTitle(const QString &title)
Sets the title to use for the code editor dock widget or window.
bool isUserVisible() const
Returns true if the widget is user visible.
QgsCodeEditorDockWidget(const QString &dockId=QString(), bool usePersistentWidget=false)
Constructor for QgsCodeEditorDockWidget, with the specified window geometry settings key.
void setUserVisible(bool visible)
Sets whether the editor is user visible.
QToolButton * dockToggleButton()
Returns the dock toggle button for the widget, which is used to toggle between dock or full window mo...