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

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 (PlayerPlugin::Base *plugin)
 emitted when reloading is requested, after firing this signal the plugin will be painted new. Useful, if the size has changed
 
void sig_opened ()
 
void sig_shown ()
 
void sig_closed ()
 

Public Member Functions

 VisualPlugin (QWidget *parent=nullptr)
 
virtual bool is_title_shown () const override
 indicates if title bar is shown or not
 
virtual void skin_changed () override
 
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 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...
 
Dialog * box_into_dialog ()
 

Public Slots

virtual void update_style (int new_index)=0
 
virtual void update ()
 
virtual void init_ui () override
 

Protected Member Functions

void init_buttons ()
 
Engine::Handlerengine () const
 
virtual void showEvent (QShowEvent *e) override
 
virtual void closeEvent (QCloseEvent *e) override
 
virtual void resizeEvent (QResizeEvent *e) override
 
virtual void mousePressEvent (QMouseEvent *e) override
 
virtual void enterEvent (QEvent *e) override
 
virtual void leaveEvent (QEvent *e) override
 
virtual QWidget * widget ()=0
 
virtual ColorStyle current_style () const =0
 
virtual int current_style_index () const =0
 
virtual bool has_small_buttons () const =0
 
void stop_fadeout_timer ()
 
virtual void finalize_initialization ()
 
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)
 

Protected Slots

virtual void config_clicked ()
 
virtual void next_clicked ()
 
virtual void prev_clicked ()
 
virtual void do_fadeout_step ()=0
 
virtual void playstate_changed (PlayState play_state)
 
virtual void played ()
 
virtual void paused ()
 
virtual void stopped ()
 

Protected Attributes

VisualColorStyleChooserm_ecsc =nullptr
 
Dialog * _boxed_dialog =nullptr
 

Member Function Documentation

◆ get_action()

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

needed by the player ui, final

Returns
action of plugin

◆ get_display_name()

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

must be overwritten

Returns
the translated name of the plugin

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

◆ get_name()

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

must be overwritten

Returns
the NOT translated name of the plugin

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

◆ has_loading_bar()

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

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
protectedinherited

Check if ui already was initialized.

Returns

◆ sig_action_triggered

void PlayerPlugin::Base::sig_action_triggered ( bool  checked)
signalinherited

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 VisualPlugin:
PlayerPlugin::Base Gui::Widget ShortcutWidget Gui::WidgetTemplate< QWidget > Gui::WidgetTemplateParent GUI_LevelPainter GUI_Spectrum