/***************************************************************************
* Copyright (C) 2008-2018 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 parent Parent widget
*/
QMenu *createMenu(MenuType type, const QString &title = QString(), QWidget *parent = nullptr);
/*!
* Registers existing menu for access from general plugins.
* @param type Menu type.
* @param menu Menu pointer.
* @param before An action, after which the rest are added.
*/
void registerMenu(MenuType type, QMenu *menu, 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();
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;
};
QMap<MenuType, MenuData> m_menus;
QString m_lastDir;
QPointer <JumpToTrackDialog> m_jumpDialog;
PlayListModel *m_model;
static UiHelper* m_instance;
};
#endif
