blob: ab25daeea43f3ba54128aec45999964e634cd7ba (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#ifndef SIDEBAR_H
#define SIDEBAR_H
#include "core_global.h"
#include "minisplitter.h"
#include <QMap>
#include <QList>
QT_BEGIN_NAMESPACE
class QSettings;
class QToolButton;
QT_END_NAMESPACE
namespace Core {
class Command;
struct SideBarPrivate;
namespace Internal { class SideBarWidget; }
/*
* An item in the sidebar. Has a widget that is displayed in the sidebar and
* optionally a list of tool buttons that are added to the toolbar above it.
* The window title of the widget is displayed in the combo box.
*
* The SideBarItem takes ownership over the widget.
*/
class CORE_EXPORT SideBarItem : public QObject
{
Q_OBJECT
public:
// id is non-localized string of the item that's used to store the settings.
explicit SideBarItem(QWidget *widget, const QString &id);
virtual ~SideBarItem();
QWidget *widget() const;
QString id() const;
QString title() const;
/* Should always return a new set of tool buttons.
*
* Workaround since there doesn't seem to be a nice way to remove widgets
* that have been added to a QToolBar without either not deleting the
* associated QAction or causing the QToolButton to be deleted.
*/
virtual QList<QToolButton *> createToolBarWidgets();
private:
const QString m_id;
QWidget *m_widget;
};
class CORE_EXPORT SideBar : public MiniSplitter
{
Q_OBJECT
public:
/*
* The SideBar takes explicit ownership of the SideBarItems
* if you have one SideBar, or shared ownership in case
* of multiple SideBars.
*/
SideBar(QList<SideBarItem *> widgetList, QList<SideBarItem *> defaultVisible);
virtual ~SideBar();
QStringList availableItemIds() const;
QStringList availableItemTitles() const;
QStringList unavailableItemIds() const;
void makeItemAvailable(SideBarItem *item);
void setUnavailableItemIds(const QStringList &itemTitles);
QString idForTitle(const QString &title) const;
SideBarItem *item(const QString &title);
bool closeWhenEmpty() const;
void setCloseWhenEmpty(bool value);
void saveSettings(QSettings *settings, const QString &name);
void readSettings(QSettings *settings, const QString &name);
void closeAllWidgets();
void activateItem(const QString &id);
void setShortcutMap(const QMap<QString, Command *> &shortcutMap);
QMap<QString, Command *> shortcutMap() const;
signals:
void sideBarClosed();
void availableItemsChanged();
private:
void splitSubWidget();
void closeSubWidget();
void updateWidgets();
Internal::SideBarWidget *insertSideBarWidget(int position,
const QString &title = QString());
void removeSideBarWidget(Internal::SideBarWidget *widget);
SideBarPrivate *d;
};
} // namespace Core
#endif // SIDEBAR_H
|
