GUI_ShortcutPreferences Class Reference

The GUI_ShortcutPreferences class. More...

#include <GUI_ShortcutPreferences.h>

Inheritance diagram for GUI_ShortcutPreferences:

Signals
void	sigShown ()
void	sigClosed ()

Public Member Functions
	GUI_ShortcutPreferences (const QString &identifier)
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. More...
bool	commit () override
	This method is called, when OK or apply is pressed. So all settings should be written there. More...
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...
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 More...
void	retranslate () override
	call the Qt retranslateUi method here More...
QString	errorString () const override
	A closer description of the error. More...
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

Detailed Description

The GUI_ShortcutPreferences class.

Member Function Documentation

action()

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

finalvirtualinherited

get action with translated text

Returns

actionName()

QString GUI_ShortcutPreferences::actionName ( ) const

overridevirtual

has to be implemented and should return the translated action text

Returns

translated action name

Implements Preferences::Base.

closeEvent()

void Preferences::Base::closeEvent ( QCloseEvent *  e )

overrideprotectedvirtualinherited

Reimplemented from Gui::Widget.

commit()

bool GUI_ShortcutPreferences::commit ( )

overridevirtual

This method is called, when OK or apply is pressed. So all settings should be written there.

Implements Preferences::Base.

errorString()

QString GUI_ShortcutPreferences::errorString ( ) const

overrideprotectedvirtual

A closer description of the error.

Returns

Reimplemented from Preferences::Base.

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_BroadcastPreferences, and GUI_RemoteControlPreferences.

identifier()

QString Preferences::Base::identifier ( ) const

inherited

return the unique identifier

Returns

initUi()

void GUI_ShortcutPreferences::initUi ( )

overrideprotectedvirtual

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

Implements Preferences::Base.

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.

retranslate()

void GUI_ShortcutPreferences::retranslate ( )

overrideprotectedvirtual

call the Qt retranslateUi method here

Implements Preferences::Base.

revert()

void GUI_ShortcutPreferences::revert ( )

overridevirtual

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.

Implements Preferences::Base.

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

widget

should 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.