UiHelper Class Reference

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

#include <uihelper.h>

List of all members.

Public Types

enum  MenuType { TOOLS_MENU = 0, PLAYLIST_MENU }

Public Slots

void toggleVisibility ()
void exit ()

Signals

void toggleVisibilityCalled ()

Public Member Functions

 UiHelper (QObject *parent=0)
 ~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(), QWidget *parent=0)
void addFile (QWidget *parent=qApp->activeWindow(), PlayListModel *model=PlayListManager::instance()->selectedPlayList())
void addDirectory (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=0)

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 <forkotov02@hotmail.ru>

Member Enumeration Documentation

enum MenuType

Enum of menu type

Enumerator:
TOOLS_MENU  tools menu
PLAYLIST_MENU  playlist context menu


Constructor & Destructor Documentation

UiHelper ( QObject *  parent = 0  ) 

Object constructor,

Parameters:
parent Parent object

~UiHelper (  ) 

Destructor


Member Function Documentation

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

Returns a list of actions of the menu type type

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:
action Pointer of action.
type Menu type.

QMenu* createMenu ( MenuType  type,
const QString &  title = QString(),
QWidget *  parent = 0 
)

Creates menu with type type

Parameters:
type Menu type.
title Menu title.
parent Parent widget

void exit (  )  [slot]

Tells the player to exit.

static UiHelper* instance (  )  [static]

Returns a pointer to the object's instance.

void removeAction ( QAction *  action  ) 

Removes action action from created menus.

void toggleVisibility (  )  [slot]

Toggles player window visibility.

void toggleVisibilityCalled (  )  [signal]

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

bool visibilityControl (  ) 

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


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

Generated on Thu Nov 10 20:39:11 2011 for Qmmp by  doxygen 1.5.9