Sayonara Player
Signals | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
PlayerPlugin::Base Class Referenceabstract
Inheritance diagram for PlayerPlugin::Base:
Gui::Widget Gui::WidgetTemplate< QWidget > Gui::WidgetTemplateParent GUI_AudioConverter GUI_Bookmarks GUI_Broadcast GUI_Crossfader GUI_Equalizer GUI_PlaylistChooser GUI_SpectrogramPainter GUI_Speed Gui::AbstractStationPlugin GuiSmartPlaylists VisualPlugin

Signals

void sigActionTriggered (bool checked)
 signal is emitted when the plugin action is triggered
also emitted for when closeEvent is fired More...
 
void sigReload (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 sigOpened ()
 
void sigShown ()
 
void sigClosed ()
 

Public Member Functions

 Base (QWidget *parent=nullptr)
 
virtual QAction * pluginAction () const final
 needed by the player ui, final More...
 
virtual QString name () const =0
 must be overwritten More...
 
virtual QString displayName () const =0
 must be overwritten More...
 
virtual bool hasTitle () const
 indicates if title bar is shown or not More...
 
virtual bool hasLoadingBar () 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 * boxIntoDialog ()
 

Protected Member Functions

virtual void finalizeInitialization ()
 
virtual bool isUiInitialized () const
 Check if ui already was initialized. More...
 
virtual void assignUiVariables ()
 
virtual void retranslate ()=0
 
template<typename T , typename UiClass >
void setupParent (T *widget, UiClass **ui)
 
void closeEvent (QCloseEvent *e) override
 
void showEvent (QShowEvent *e) override
 
virtual void skinChanged ()
 

Protected Attributes

Dialog * mBoxedDialog = nullptr
 

Friends

class Handler
 

Member Function Documentation

◆ closeEvent()

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

Reimplemented from Gui::Widget.

◆ displayName()

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

◆ hasLoadingBar()

virtual bool PlayerPlugin::Base::hasLoadingBar ( ) 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::AbstractStationPlugin.

◆ hasTitle()

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

indicates if title bar is shown or not

Reimplemented in VisualPlugin.

◆ isUiInitialized()

virtual bool PlayerPlugin::Base::isUiInitialized ( ) const
protectedvirtual

Check if ui already was initialized.

Returns

Reimplemented in GUI_SpectrogramPainter.

◆ name()

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

◆ pluginAction()

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

needed by the player ui, final

Returns
action of plugin

◆ showEvent()

void PlayerPlugin::Base::showEvent ( QShowEvent *  e)
overrideprotectedvirtual

Reimplemented from Gui::Widget.

◆ sigActionTriggered

void PlayerPlugin::Base::sigActionTriggered ( 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