Sayonara Player
Public Member Functions | List of all members
Library::DirectoryContainer Class Reference

The DirectoryContainer class. More...

#include <DirectoryWidgetContainer.h>

Inheritance diagram for Library::DirectoryContainer:
Library::Container

Public Member Functions

 DirectoryContainer (QObject *parent=nullptr)
 
QString display_name () const override
 Should return the translated name displayed in the library view combobox. More...
 
QString name () const override
 Should return an untranslated name used for identifying this widget. More...
 
QWidget * widget () const override
 Should return the UI for the library view. More...
 
QFrame * header () const override
 this is a frame at the top left of the container where the combo box will be located More...
 
QPixmap icon () const override
 Every library should show a icon in the combo box. More...
 
void init_ui () override
 Should initialize the ui. The ui constructor should be called within this function.
 
virtual void set_name (const QString &name)
 
virtual QMenu * menu ()
 return actions menu (may be nullptr). The title does not have to be set More...
 
void set_menu_action (QAction *action)
 sets the action member field used in the player menu bar. This is called by the player if the language has changed More...
 
QAction * menu_action () const
 get the action in the player menubar. More...
 
bool is_initialized () const
 tests, if the ui already has been initialized More...
 
virtual bool is_local () const
 a local library is a library which writes to the library field of the database. This should be false for every new plugin More...
 
virtual void show ()
 
virtual void hide ()
 
void retranslate ()
 

Detailed Description

The DirectoryContainer class.

Member Function Documentation

◆ display_name()

QString Library::DirectoryContainer::display_name ( ) const
overridevirtual

Should return the translated name displayed in the library view combobox.

Returns
display name

Reimplemented from Library::Container.

◆ header()

QFrame* Library::DirectoryContainer::header ( ) const
overridevirtual

this is a frame at the top left of the container where the combo box will be located

Returns

Implements Library::Container.

◆ icon()

QPixmap Library::DirectoryContainer::icon ( ) const
overridevirtual

Every library should show a icon in the combo box.

Returns

Implements Library::Container.

◆ is_initialized()

bool Library::Container::is_initialized ( ) const
inherited

tests, if the ui already has been initialized

Returns
true if ui has been initialized, false else

◆ is_local()

virtual bool Library::Container::is_local ( ) const
virtualinherited

a local library is a library which writes to the library field of the database. This should be false for every new plugin

Returns

Reimplemented in LocalLibraryContainer.

◆ menu()

virtual QMenu* Library::Container::menu ( )
virtualinherited

return actions menu (may be nullptr). The title does not have to be set

Returns
the translated menu relevant for the corresponding library

Reimplemented in SomaFM::LibraryContainer, SC::LibraryContainer, LocalLibraryContainer, and EmptyLibraryContainer.

◆ menu_action()

QAction* Library::Container::menu_action ( ) const
inherited

get the action in the player menubar.

Returns
pointer to action field

◆ name()

QString Library::DirectoryContainer::name ( ) const
overridevirtual

Should return an untranslated name used for identifying this widget.

Returns
name

Implements Library::Container.

◆ set_menu_action()

void Library::Container::set_menu_action ( QAction *  action)
inherited

sets the action member field used in the player menu bar. This is called by the player if the language has changed

Parameters
actionthe new translated action

◆ widget()

QWidget* Library::DirectoryContainer::widget ( ) const
overridevirtual

Should return the UI for the library view.

Returns
pointer to the ui

Implements Library::Container.