Sayonara Player
Signals | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
GUI_PlayerPreferences Class Reference
Inheritance diagram for GUI_PlayerPreferences:
Preferences::Base Gui::Widget Gui::WidgetTemplate< QWidget > Gui::WidgetTemplateParent

Signals

void sigShown ()
 
void sigClosed ()
 

Public Member Functions

 GUI_PlayerPreferences (const QString &identifier)
 
bool commit () override
 This method is called, when OK or apply is pressed. So all settings should be written there.
 
void revert () override
 This method is called, when cancel is clicked. So the gui should be re-initialized when this method is called. This method should also be called in the init_ui() method.
 
QString actionName () const override
 has to be implemented and should return the translated action text More...
 
QString identifier () const
 return the unique identifier More...
 
virtual bool isUiInitialized () const final
 checks if ui has already been initialized. More...
 
virtual QAction * action () final
 get action with translated text More...
 
virtual bool hasError () const
 indicates if there was an error on the settings page like an invalid expression or combination of settings More...
 
virtual QString errorString () const
 A closer description of the error. More...
 
Dialog * boxIntoDialog ()
 

Protected Member Functions

void initUi () override
 call setup_parent(this) here.
initialize compoenents and connections here.
After calling setup_parent(this), the preference Dialog is ready to use, language_changed() is called automatically
 
void retranslate () override
 call the Qt retranslateUi method here
 
void logLevelChanged ()
 
template<typename W , typename UiClass >
void setupParent (W *widget, UiClass **ui)
 Sets up the Preference dialog. After this method, the dialog is "ready to use"
This method should be the first to be called when calling init_ui() More...
 
virtual void languageChanged () override final
 automatically called when language has changed. When overriding this method. Overriding this method should look like this: void GUI_FontConfig::language_changed()
{
translate_action();

More...
 
void translationAction ()
 Sets the new translated action name.
 
void showEvent (QShowEvent *e) override
 shows the widget and automatically calls init_ui() More...
 
void closeEvent (QCloseEvent *e) override
 
virtual void skinChanged ()
 

Protected Attributes

Dialog * mBoxedDialog =nullptr
 

Member Function Documentation

◆ action()

virtual QAction* Preferences::Base::action ( )
finalvirtualinherited

get action with translated text

Returns

◆ actionName()

QString GUI_PlayerPreferences::actionName ( ) const
overridevirtual

has to be implemented and should return the translated action text

Returns
translated action name

Implements Preferences::Base.

◆ errorString()

virtual QString Preferences::Base::errorString ( ) const
virtualinherited

◆ hasError()

virtual bool Preferences::Base::hasError ( ) const
virtualinherited

indicates if there was an error on the settings page like an invalid expression or combination of settings

Returns

Reimplemented in GUI_RemoteControlPreferences, and GUI_BroadcastPreferences.

◆ identifier()

QString Preferences::Base::identifier ( ) const
inherited

return the unique identifier

Returns

◆ isUiInitialized()

virtual bool Preferences::Base::isUiInitialized ( ) const
finalvirtualinherited

checks if ui has already been initialized.

Returns
false, if the widget has never been activated before, true else

◆ languageChanged()

virtual void Preferences::Base::languageChanged ( )
finaloverrideprotectedvirtualinherited

automatically called when language has changed. When overriding this method. Overriding this method should look like this: void GUI_FontConfig::language_changed()
{
translate_action();

if(!is_ui_initialized()){
return;
}

retranslateUi(this);
PreferenceWidgetInterface::language_changed();
}

Reimplemented from Gui::WidgetTemplateParent.

◆ setupParent()

template<typename W , typename UiClass >
void Preferences::Base::setupParent ( W *  widget,
UiClass **  ui 
)
inlineprotectedinherited

Sets up the Preference dialog. After this method, the dialog is "ready to use"
This method should be the first to be called when calling init_ui()

Parameters
widgetshould always be "this"

◆ showEvent()

void Preferences::Base::showEvent ( QShowEvent *  e)
overrideprotectedvirtualinherited

shows the widget and automatically calls init_ui()

Parameters
e

Reimplemented from Gui::Widget.