QGIS API Documentation
4.3.0-Master (16eddb2670e)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
gui
codeeditors
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
16
#include "
qgscodeeditordockwidget.h
"
17
18
#include "
qgsdockablewidgethelper.h
"
19
20
#include "moc_qgscodeeditordockwidget.cpp"
21
22
QgsCodeEditorDockWidget::QgsCodeEditorDockWidget
(
const
QString &dockId,
bool
usePersistentWidget )
23
: QWidget( nullptr )
24
{
25
QgsDockableWidgetHelper::Options options = QgsDockableWidgetHelper::Option::RaiseTab;
26
if
( usePersistentWidget )
27
options.setFlag( QgsDockableWidgetHelper::Option::PermanentWidget );
28
29
mDockableWidgetHelper = std::make_unique<
30
QgsDockableWidgetHelper>( tr(
"Code Editor"
),
this
, QgsDockableWidgetHelper::sOwnerWindow, dockId, QStringList(),
Qgis::DockableWidgetInitialState::RestorePreviousState
,
true
, Qt::BottomDockWidgetArea, options );
31
32
mDockToggleButton = mDockableWidgetHelper->createDockUndockToolButton();
33
mDockToggleButton->setToolTip( tr(
"Dock Code Editor"
) );
34
connect( mDockableWidgetHelper.get(), &QgsDockableWidgetHelper::closed,
this
, [
this
]() { close(); } );
35
36
connect( mDockableWidgetHelper.get(), &QgsDockableWidgetHelper::visibilityChanged,
this
, &
QgsCodeEditorDockWidget::visibilityChanged
);
37
}
38
39
QgsCodeEditorDockWidget::~QgsCodeEditorDockWidget
()
40
{}
41
42
void
QgsCodeEditorDockWidget::setTitle
(
const
QString &title )
43
{
44
mDockableWidgetHelper->setWindowTitle( title );
45
}
46
47
QToolButton *
QgsCodeEditorDockWidget::dockToggleButton
()
48
{
49
return
mDockToggleButton;
50
}
51
52
void
QgsCodeEditorDockWidget::setDockObjectName
(
const
QString &name )
53
{
54
mDockableWidgetHelper->setDockObjectName( name );
55
}
56
57
bool
QgsCodeEditorDockWidget::isUserVisible
()
const
58
{
59
return
mDockableWidgetHelper->isUserVisible();
60
}
61
62
void
QgsCodeEditorDockWidget::setUserVisible
(
bool
visible )
63
{
64
mDockableWidgetHelper->setUserVisible( visible );
65
}
Qgis::DockableWidgetInitialState::RestorePreviousState
@ RestorePreviousState
Restore the previous state of this dock.
Definition
qgis.h:7104
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::~QgsCodeEditorDockWidget
~QgsCodeEditorDockWidget() override
Definition
qgscodeeditordockwidget.cpp:39
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
qgscodeeditordockwidget.h
qgsdockablewidgethelper.h
Generated on
for QGIS API Documentation by
1.17.0