Sayonara Player
Friends | Signals | Public Member Functions | Protected Member Functions | Protected Slots | Protected Attributes | List of all members
PlayerPluginInterface Class Referenceabstract

#include <PlayerPlugin.h>

Detailed Description

Interface for PlayerPlugin classes. get_name() and language_changed() must be overwritten.

Friends

class PlayerPluginHandler
 

Signals

void sig_action_triggered (PlayerPluginInterface *plugin, bool checked)
 signal is emitted when the plugin action is triggered
also emitted for when closeEvent is fired More...
 
void sig_reload (PlayerPluginInterface *)
 emitted when reloading is requested, after firing this signal the plugin will be painted new. Useful, if the size has changed
 

Public Member Functions

 PlayerPluginInterface (QWidget *parent=nullptr)
 
virtual QSize get_size () const final
 needed by the player ui, final More...
 
virtual QAction * get_action () const final
 needed by the player ui, final More...
 
virtual bool is_closed () const final
 needed by the player ui, final More...
 
virtual QString get_name () const =0
 must be overwritten More...
 
virtual QString get_display_name () const =0
 must be overwritten More...
 
virtual void show ()
 show Plugin
 
virtual bool is_title_shown () const
 
QString get_shortcut_text (const QString &shortcut_identifier) const override
 get translated text of shortcut (overridden) More...
 
SayonaraDialogbox_into_dialog ()
 
bool is_dark () const
 Returns, if the current skin is dark. More...
 

Protected Member Functions

void closeEvent (QCloseEvent *e) override
 Event fired when closed overrides QWidget::closeEvent. More...
 
virtual void language_changed () override=0
 language_changed Has to be implemented and is called when language has changed
 
virtual void init_ui ()=0
 GUI will be initialized on first show up. Please use this to make Sayonara starting fast.
 
bool is_ui_initialized () const
 Check if ui already was initialized. More...
 
void set_ui_initialized ()
 mark ui as initialized
 
template<typename T >
void setup_parent (T *widget)
 
QString elide_text (const QString &text, QWidget *widget, int max_lines)
 

Protected Slots

virtual void playstate_changed (PlayManager::PlayState state)
 Playstate has changed, this does nothing in default implementation. More...
 
virtual void played ()
 Playstate has changed to playing.
 
virtual void paused ()
 Playstate has changed to paused.
 
virtual void stopped ()
 Playstate has changed to stop.
 
virtual void skin_changed ()
 

Protected Attributes

PlayManager_play_manager =nullptr
 _play_manager Notifies about playstate
 
QAction * _pp_action =nullptr
 _pp_action already allocated, displays name of the plugin by calling get_name()
 
SayonaraDialog_boxed_dialog =nullptr
 
Settings_settings =nullptr
 

Member Function Documentation

§ closeEvent()

void PlayerPluginInterface::closeEvent ( QCloseEvent *  e)
overrideprotected

Event fired when closed overrides QWidget::closeEvent.

Parameters
ethe event

§ get_action()

virtual QAction* PlayerPluginInterface::get_action ( ) const
finalvirtual

needed by the player ui, final

Returns
action of plugin

§ get_display_name()

virtual QString PlayerPluginInterface::get_display_name ( ) const
pure virtual

must be overwritten

Returns
the translated name of the plugin

Implemented in GUI_PlaylistChooser, GUI_Equalizer, GUI_Podcasts, GUI_Stream, GUI_AudioConverter, GUI_Bookmarks, GUI_Spectrum, GUI_Broadcast, GUI_LevelPainter, GUI_Crossfader, and GUI_Speed.

§ get_name()

virtual QString PlayerPluginInterface::get_name ( ) const
pure virtual

must be overwritten

Returns
the NOT translated name of the plugin

Implemented in GUI_PlaylistChooser, GUI_Equalizer, GUI_Podcasts, GUI_Stream, GUI_AudioConverter, GUI_Bookmarks, GUI_Spectrum, GUI_Broadcast, GUI_LevelPainter, GUI_Crossfader, and GUI_Speed.

§ get_shortcut_text()

QString PlayerPluginInterface::get_shortcut_text ( const QString &  shortcut_identifier) const
overridevirtual

get translated text of shortcut (overridden)

Parameters
shortcut_identifiershortcut id
Returns
translated shortcut text

Implements ShortcutWidget.

§ get_size()

virtual QSize PlayerPluginInterface::get_size ( ) const
finalvirtual

needed by the player ui, final

Returns
miminum size of plugin

§ is_closed()

virtual bool PlayerPluginInterface::is_closed ( ) const
finalvirtual

needed by the player ui, final

Returns
visibility of plugin

§ is_dark()

bool SayonaraWidgetTemplate< QWidget >::is_dark ( ) const
inlineinherited

Returns, if the current skin is dark.

Returns
true, if dark. false else

§ is_ui_initialized()

bool PlayerPluginInterface::is_ui_initialized ( ) const
protected

Check if ui already was initialized.

Returns

§ playstate_changed

virtual void PlayerPluginInterface::playstate_changed ( PlayManager::PlayState  state)
protectedvirtualslot

Playstate has changed, this does nothing in default implementation.

Parameters
thenew State

§ sig_action_triggered

void PlayerPluginInterface::sig_action_triggered ( PlayerPluginInterface plugin,
bool  checked 
)
signal

signal is emitted when the plugin action is triggered
also emitted for when closeEvent is fired

Parameters
pluginthis pointer to current plugin
checkedindicates whether checked or unchecked
Inheritance diagram for PlayerPluginInterface:
SayonaraWidget ShortcutWidget SayonaraWidgetTemplate< QWidget > SayonaraClass EnginePlugin GUI_AbstractStream GUI_AudioConverter GUI_Bookmarks GUI_Broadcast GUI_Crossfader GUI_Equalizer GUI_PlaylistChooser GUI_Speed