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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
/***************************************************************************
* Copyright (C) 2008-2021 by Ilya Kotov *
* forkotov02@ya.ru *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
***************************************************************************/
#ifndef UIHELPER_H
#define UIHELPER_H
#include <QObject>
#include <QMap>
#include <QList>
#include <QPointer>
#include <QStringList>
#include <QApplication>
#include <QPointer>
#include "playlistmanager.h"
#include "playlistmodel.h"
#include "qmmpui_export.h"
class QAction;
class QMenu;
class QWidget;
class General;
class GeneralFactory;
class JumpToTrackDialog;
/*! @brief The UiHelper class provides simple api to access general plugins and some gui features.
* @author Ilya Kotov <forkotov02@ya.ru>
*/
class QMMPUI_EXPORT UiHelper : public QObject
{
Q_OBJECT
public:
/*!
* Object constructor,
* @param parent Parent object
*/
UiHelper(QObject *parent = nullptr);
/*!
* Destructor
*/
~UiHelper();
/*!
* Enum of menu type
*/
enum MenuType
{
TOOLS_MENU = 0, /*!< tools menu */
PLAYLIST_MENU, /*!< playlist context menu */
ADD_MENU /*!< "add"/"file" menu */
};
/*!
* Returns \b true if one of the general plugin can change visibility, otherwise returns \b false
*/
bool visibilityControl();
/*!
* Adds the newly created action to the menu with type \b type.
* Menu with type \b type should be created first.
* @param action Pointer of action.
* @param type Menu type.
*/
void addAction(QAction *action, MenuType type = TOOLS_MENU);
/*!
* Removes action \b action from created menus.
*/
void removeAction(QAction *action);
/*!
* Returns a list of actions of the menu type \b type
*/
QList<QAction *> actions(MenuType type = TOOLS_MENU);
/*!
* Creates menu with type \b type
* @param type Menu type.
* @param title Menu title.
* @param autoHide Hide empty menu.
* @param parent Parent widget
*/
QMenu *createMenu(MenuType type, const QString &title = QString(), bool autoHide = true, QWidget *parent = nullptr);
/*!
* Registers existing menu for access from general plugins.
* @param type Menu type.
* @param menu Menu pointer.
* @param autoHide Hide empty menu.
* @param before An action, after which the rest are added.
*/
void registerMenu(MenuType type, QMenu *menu, bool autoHide = false, QAction *before = nullptr);
/*!
* Opens 'Add Files' dialog
* @param parent Parent widget
* @param model Destination playlist model
*/
void addFiles(QWidget *parent = qApp->activeWindow(),
PlayListModel *model = PlayListManager::instance()->selectedPlayList());
/*!
* Opens 'Play Files' dialog
* @param parent Parent widget
* @param model Destination playlist model
*/
void playFiles(QWidget *parent = qApp->activeWindow(),
PlayListModel *model = PlayListManager::instance()->selectedPlayList());
/*!
* Opens 'Add Directory' dialog
* @param parent Parent widget
* @param model Destination playlist model
*/
void addDirectory(QWidget *parent = qApp->activeWindow(),
PlayListModel *model = PlayListManager::instance()->selectedPlayList());
/*!
* Opens 'Add URL' dialog
* @param parent Parent widget
* @param model Destination playlist model
*/
void addUrl(QWidget *parent = qApp->activeWindow(),
PlayListModel *model = PlayListManager::instance()->selectedPlayList());
/*!
* Opens 'Load Playlist' dialog
* @param parent Parent widget
* @param model Destination playlist model
*/
void loadPlayList(QWidget *parent = qApp->activeWindow(),
PlayListModel *model = PlayListManager::instance()->selectedPlayList());
/*!
* Opens 'Save Playlist' dialog
* @param parent Parent widget
* @param model Destination playlist model
*/
void savePlayList(QWidget *parent = qApp->activeWindow(),
PlayListModel *model = PlayListManager::instance()->selectedPlayList());
/*!
* Opens 'Jump To Track' dialog
* @param parent Parent widget
* @param model Destination playlist model
*/
void jumpToTrack(QWidget *parent = qApp->activeWindow(),
PlayListModel *model = PlayListManager::instance()->selectedPlayList());
/*!
* Shows about dialog
* @param parent Parent widget
*/
void about(QWidget *parent = nullptr);
/*!
* Returns a pointer to the object's instance.
*/
static UiHelper* instance();
public slots:
/*!
* Toggles player window visibility.
*/
void toggleVisibility();
/*!
* Shows the main window of the player.
*/
void showMainWindow();
/*!
* Tells the player to exit.
*/
void exit();
signals:
/*!
* Emitted when some general plugin requires to toggle visibility.
* Use it to show/hide player's window.
*/
void toggleVisibilityCalled();
/*!
* Emitted when some general plugin requires to show main window.
* Use it to show player's window and to raise it to the top.
*/
void showMainWindowCalled();
/*!
* Emitted when some general plugin adds widget.
* User interface should create this widget using the given \b id.
*/
void widgetAdded(const QString &id);
/*!
* Emitted when some general plugin removes widget \b id.
* User interface should remove widget with the given \b id.
*/
void widgetRemoved(const QString &id);
/*!
* Emitted when some general plugin changes settings of the widget \b id.
* User interface should recreate widget with the given \b id.
*/
void widgetUpdated(const QString &id);
private slots:
void removeAction(QObject *action);
void addSelectedFiles(const QStringList &files, bool play);
void playSelectedFiles(const QStringList &files);
void disconnectPl();
private:
QMap <GeneralFactory*, General*> m_generals;
struct MenuData
{
QPointer<QMenu> menu;
QPointer<QAction> before;
QList<QAction*> actions;
bool autoHide = false;
};
QMap<MenuType, MenuData> m_menus;
QString m_lastDir;
QPointer <JumpToTrackDialog> m_jumpDialog;
PlayListModel *m_model = nullptr;
static UiHelper* m_instance;
};
#endif
|
