#include <PlayerPlugin.h>
Interface for PlayerPlugin classes. get_name() and language_changed() must be overwritten.
|
class | PlayerPluginHandler |
|
|
| 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...
|
|
SayonaraDialog * | box_into_dialog () |
|
bool | is_dark () const |
| Returns, if the current skin is dark. More...
|
|
|
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) |
|
|
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 () |
|
§ closeEvent()
void PlayerPluginInterface::closeEvent |
( |
QCloseEvent * |
e | ) |
|
|
overrideprotected |
Event fired when closed overrides QWidget::closeEvent.
- Parameters
-
§ 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_identifier | shortcut 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()
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
Playstate has changed, this does nothing in default implementation.
- Parameters
-
§ sig_action_triggered
signal is emitted when the plugin action is triggered
also emitted for when closeEvent is fired
- Parameters
-
plugin | this pointer to current plugin |
checked | indicates whether checked or unchecked |