Qmmp
Loading...
Searching...
No Matches
Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | List of all members
UiHelper Class Reference

#include <uihelper.h>

Inherits QObject.

Public Types

enum  MenuType { TOOLS_MENU = 0 , PLAYLIST_MENU , ADD_MENU }
 

Public Slots

void toggleVisibility ()
 
void showMainWindow ()
 
void exit ()
 

Signals

void toggleVisibilityCalled ()
 
void showMainWindowCalled ()
 
void widgetAdded (const QString &id)
 
void widgetRemoved (const QString &id)
 
void widgetUpdated (const QString &id)
 

Public Member Functions

 UiHelper (QObject *parent=nullptr)
 
 ~UiHelper ()
 
bool visibilityControl ()
 
void addAction (QAction *action, MenuType type=TOOLS_MENU)
 
void removeAction (QAction *action)
 
QList< QAction * > actions (MenuType type=TOOLS_MENU)
 
QMenu * createMenu (MenuType type, const QString &title=QString(), bool autoHide=true, QWidget *parent=nullptr)
 
void registerMenu (MenuType type, QMenu *menu, bool autoHide=false, QAction *before=nullptr)
 
void addFiles (QWidget *parent=qApp->activeWindow(), PlayListModel *model=PlayListManager::instance() ->selectedPlayList())
 
void playFiles (QWidget *parent=qApp->activeWindow(), PlayListModel *model=PlayListManager::instance() ->selectedPlayList())
 
void addDirectory (QWidget *parent=qApp->activeWindow(), PlayListModel *model=PlayListManager::instance() ->selectedPlayList())
 
void addUrl (QWidget *parent=qApp->activeWindow(), PlayListModel *model=PlayListManager::instance() ->selectedPlayList())
 
void loadPlayList (QWidget *parent=qApp->activeWindow(), PlayListModel *model=PlayListManager::instance() ->selectedPlayList())
 
void savePlayList (QWidget *parent=qApp->activeWindow(), PlayListModel *model=PlayListManager::instance() ->selectedPlayList())
 
void jumpToTrack (QWidget *parent=qApp->activeWindow(), PlayListModel *model=PlayListManager::instance() ->selectedPlayList())
 
void about (QWidget *parent=nullptr)
 

Static Public Member Functions

static UiHelperinstance ()
 

Detailed Description

The UiHelper class provides simple api to access general plugins and some gui features.

Author
Ilya Kotov forko.nosp@m.tov0.nosp@m.2@ya..nosp@m.ru

Member Enumeration Documentation

◆ MenuType

enum MenuType

Enum of menu type

Enumerator
TOOLS_MENU 

tools menu

PLAYLIST_MENU 

playlist context menu

ADD_MENU 

"add"/"file" menu

Constructor & Destructor Documentation

◆ UiHelper()

UiHelper ( QObject * parent = nullptr)

Object constructor,

Parameters
parentParent object

◆ ~UiHelper()

~UiHelper ( )

Destructor

Member Function Documentation

◆ about()

void about ( QWidget * parent = nullptr)

Shows about dialog

Parameters
parentParent widget

◆ actions()

QList< QAction * > actions ( MenuType type = TOOLS_MENU)

Returns a list of actions of the menu type type

◆ addAction()

void addAction ( QAction * action,
MenuType type = TOOLS_MENU )

Adds the newly created action to the menu with type type. Menu with type type should be created first.

Parameters
actionPointer of action.
typeMenu type.

◆ addDirectory()

void addDirectory ( QWidget * parent = qApp->activeWindow(),
PlayListModel * model = PlayListManager::instance() ->selectedPlayList() )

Opens 'Add Directory' dialog

Parameters
parentParent widget
modelDestination playlist model

◆ addFiles()

void addFiles ( QWidget * parent = qApp->activeWindow(),
PlayListModel * model = PlayListManager::instance() ->selectedPlayList() )

Opens 'Add Files' dialog

Parameters
parentParent widget
modelDestination playlist model

◆ addUrl()

void addUrl ( QWidget * parent = qApp->activeWindow(),
PlayListModel * model = PlayListManager::instance() ->selectedPlayList() )

Opens 'Add URL' dialog

Parameters
parentParent widget
modelDestination playlist model

◆ createMenu()

QMenu * createMenu ( MenuType type,
const QString & title = QString(),
bool autoHide = true,
QWidget * parent = nullptr )

Creates menu with type type

Parameters
typeMenu type.
titleMenu title.
autoHideHide empty menu.
parentParent widget

◆ exit

void exit ( )
slot

Tells the player to exit.

◆ instance()

static UiHelper * instance ( )
static

Returns a pointer to the object's instance.

◆ jumpToTrack()

void jumpToTrack ( QWidget * parent = qApp->activeWindow(),
PlayListModel * model = PlayListManager::instance() ->selectedPlayList() )

Opens 'Jump To Track' dialog

Parameters
parentParent widget
modelDestination playlist model

◆ loadPlayList()

void loadPlayList ( QWidget * parent = qApp->activeWindow(),
PlayListModel * model = PlayListManager::instance() ->selectedPlayList() )

Opens 'Load Playlist' dialog

Parameters
parentParent widget
modelDestination playlist model

◆ playFiles()

void playFiles ( QWidget * parent = qApp->activeWindow(),
PlayListModel * model = PlayListManager::instance() ->selectedPlayList() )

Opens 'Play Files' dialog

Parameters
parentParent widget
modelDestination playlist model

◆ registerMenu()

void registerMenu ( MenuType type,
QMenu * menu,
bool autoHide = false,
QAction * before = nullptr )

Registers existing menu for access from general plugins.

Parameters
typeMenu type.
menuMenu pointer.
autoHideHide empty menu.
beforeAn action, after which the rest are added.

◆ removeAction()

void removeAction ( QAction * action)

Removes action action from created menus.

◆ savePlayList()

void savePlayList ( QWidget * parent = qApp->activeWindow(),
PlayListModel * model = PlayListManager::instance() ->selectedPlayList() )

Opens 'Save Playlist' dialog

Parameters
parentParent widget
modelDestination playlist model

◆ showMainWindow

void showMainWindow ( )
slot

Shows the main window of the player.

◆ showMainWindowCalled

void showMainWindowCalled ( )
signal

Emitted when some general plugin requires to show main window. Use it to show player's window and to raise it to the top.

◆ toggleVisibility

void toggleVisibility ( )
slot

Toggles player window visibility.

◆ toggleVisibilityCalled

void toggleVisibilityCalled ( )
signal

Emitted when some general plugin requires to toggle visibility. Use it to show/hide player's window.

◆ visibilityControl()

bool visibilityControl ( )

Returns true if one of the general plugin can change visibility, otherwise returns false

◆ widgetAdded

void widgetAdded ( const QString & id)
signal

Emitted when some general plugin adds widget. User interface should create this widget using the given id.

◆ widgetRemoved

void widgetRemoved ( const QString & id)
signal

Emitted when some general plugin removes widget id. User interface should remove widget with the given id.

◆ widgetUpdated

void widgetUpdated ( const QString & id)
signal

Emitted when some general plugin changes settings of the widget id. User interface should recreate widget with the given id.


The documentation for this class was generated from the following file: