Sayonara Player
Loading...
Searching...
No Matches
VisualPlugin Class Referenceabstract
Inheritance diagram for VisualPlugin:
PlayerPlugin::Base Gui::Widget Gui::WidgetTemplate< QWidget > Gui::WidgetTemplateParent GUI_LevelPainter GUI_Spectrum

Public Slots

void initUi () override

Signals

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

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

Protected Member Functions

bool isProcessing () const
const ColorStylecurrentStyle () const
virtual QWidget * widget ()=0
virtual bool hasSmallButtons () const =0
virtual bool applyStyle (const ColorStyle &style)=0
virtual ColorStyle extractStyle (const RawColorStyle &rawColorStyle) const =0
virtual int loadStyleIndex () const =0
virtual void saveStyleIndex (int index) const =0
virtual void paint ()=0
virtual bool isFadeoutCompleted () const =0
virtual void doFadeoutStep ()=0
virtual void notifyDataProvider (bool isActive)=0
void paintEvent (QPaintEvent *e) override
void showEvent (QShowEvent *e) override
void closeEvent (QCloseEvent *e) override
void resizeEvent (QResizeEvent *e) override
void mousePressEvent (QMouseEvent *e) override
void enterEvent (QEvent *e) override
void leaveEvent (QEvent *e) override
virtual void finalizeInitialization ()
virtual bool isUiInitialized () const
 Check if ui already was initialized.
virtual void assignUiVariables ()
virtual void retranslate ()=0
template<typename T, typename UiClass>
void setupParent (T *widget, UiClass **ui)
virtual void skinChanged ()

Protected Attributes

Dialog * mBoxedDialog = nullptr

Member Function Documentation

◆ closeEvent()

void VisualPlugin::closeEvent ( QCloseEvent * e)
overrideprotectedvirtual

Reimplemented from PlayerPlugin::Base.

◆ displayName()

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

◆ hasLoadingBar()

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

◆ hasTitle()

bool VisualPlugin::hasTitle ( ) const
nodiscardoverridevirtual

indicates if title bar is shown or not

Reimplemented from PlayerPlugin::Base.

◆ isUiInitialized()

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

Check if ui already was initialized.

Returns

Reimplemented in GUI_SpectrogramPainter.

◆ name()

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

◆ pluginAction()

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

needed by the player ui, final

Returns
action of plugin

◆ showEvent()

void VisualPlugin::showEvent ( QShowEvent * e)
overrideprotectedvirtual

Reimplemented from PlayerPlugin::Base.

◆ sigActionTriggered

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