Sayonara Player
Friends | Signals | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
PlayerPlugin::Base Class Referenceabstract

Friends

class Handler
 

Signals

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

Public Member Functions

 Base (QWidget *parent=nullptr)
 
virtual void skin_changed () override
 
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 QString get_name () const =0
 must be overwritten More...
 
virtual QString get_display_name () const =0
 must be overwritten More...
 
virtual bool is_title_shown () const
 indicates if title bar is shown or not
 
virtual bool has_loading_bar () const
 indicates if the widget has a loading bar. If yes, there will be reserved some extra space at the bottom of the widget More...
 
QString get_shortcut_text (const QString &shortcut_identifier) const override
 get translated text of shortcut (overridden) More...
 
Dialog * box_into_dialog ()
 

Protected Member Functions

bool is_ui_initialized () const
 Check if ui already was initialized. More...
 
virtual void assign_ui_vars ()
 
virtual void retranslate_ui ()=0
 
template<typename T , typename UiClass >
void setup_parent (T *widget, UiClass **ui)
 
void closeEvent (QCloseEvent *e) override
 Event fired when closed overrides QWidget::closeEvent. More...
 
void showEvent (QShowEvent *e) override
 

Protected Attributes

Dialog * _boxed_dialog =nullptr
 
Settings_settings =nullptr
 

Member Function Documentation

◆ closeEvent()

void PlayerPlugin::Base::closeEvent ( QCloseEvent *  e)
overrideprotectedvirtual

Event fired when closed overrides QWidget::closeEvent.

Parameters
ethe event

Reimplemented from Gui::Widget.

◆ get_action()

virtual QAction* PlayerPlugin::Base::get_action ( ) const
finalvirtual

needed by the player ui, final

Returns
action of plugin

◆ get_display_name()

virtual QString PlayerPlugin::Base::get_display_name ( ) const
pure virtual

must be overwritten

Returns
the translated name of the plugin

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

◆ get_name()

virtual QString PlayerPlugin::Base::get_name ( ) const
pure virtual

must be overwritten

Returns
the NOT translated name of the plugin

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

◆ get_shortcut_text()

QString PlayerPlugin::Base::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 PlayerPlugin::Base::get_size ( ) const
finalvirtual

needed by the player ui, final

Returns
miminum size of plugin

◆ has_loading_bar()

virtual bool PlayerPlugin::Base::has_loading_bar ( ) const
virtual

indicates if the widget has a loading bar. If yes, there will be reserved some extra space at the bottom of the widget

Returns

Reimplemented in GUI_AbstractStream.

◆ is_ui_initialized()

bool PlayerPlugin::Base::is_ui_initialized ( ) const
protected

Check if ui already was initialized.

Returns

◆ sig_action_triggered

void PlayerPlugin::Base::sig_action_triggered ( 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 PlayerPlugin::Base:
Gui::Widget ShortcutWidget Gui::WidgetTemplate< QWidget > SayonaraClass EnginePlugin GUI_AbstractStream GUI_AudioConverter GUI_Bookmarks GUI_Broadcast GUI_Crossfader GUI_Equalizer GUI_PlaylistChooser GUI_Speed