Class for storing the Canorus settings. More...

#include <settings.h>

Inheritance diagram for CASettings:

Public Member Functions
	CASettings (QObject *parent=0)

	CASettings (const QString &fileName, QObject *parent=0)

void	initSettings ()

virtual	~CASettings ()

int	readSettings ()

void	writeSettings ()

bool	finaleLyricsBehaviour ()

void	setFinaleLyricsBehaviour (bool b)

bool	shadowNotesInOtherStaffs ()

void	setShadowNotesInOtherStaffs (bool b)

bool	playInsertedNotes ()

void	setPlayInsertedNotes (bool b)

bool	autoBar ()

void	setAutoBar (bool b)

bool	useNoteChecker ()

void	setUseNoteChecker (bool b)

QDir	documentsDirectory ()

void	setDocumentsDirectory (QDir d)

CAFileFormats::CAFileFormatType	defaultSaveFormat ()

void	setDefaultSaveFormat (CAFileFormats::CAFileFormatType t)

int	autoRecoveryInterval ()

void	setAutoRecoveryInterval (int interval)

int	maxRecentDocuments ()

void	setMaxRecentDocuments (int r)

bool	lockScrollPlayback ()

void	setLockScrollPlayback (bool l)

bool	animatedScroll ()

void	setAnimatedScroll (bool a)

bool	antiAliasing ()

void	setAntiAliasing (bool a)

bool	showRuler ()

void	setShowRuler (bool b)

QColor	backgroundColor ()

void	setBackgroundColor (QColor backgroundColor)

QColor	foregroundColor ()

void	setForegroundColor (QColor foregroundColor)

QColor	selectionColor ()

void	setSelectionColor (QColor selectionColor)

QColor	selectionAreaColor ()

void	setSelectionAreaColor (QColor selectionAreaColor)

QColor	selectedContextColor ()

void	setSelectedContextColor (QColor selectedContextColor)

QColor	hiddenElementsColor ()

void	setDisabledElementsColor (QColor disabledElementsColor)

QColor	disabledElementsColor ()

void	setHiddenElementsColor (QColor hiddenElementsColor)

int	midiInPort ()

void	setMidiInPort (int in)

int	midiInNumDevices ()

void	setMidiInNumDevices (int inNum)

int	midiOutPort ()

void	setMidiOutPort (int out)

int	midiOutNumDevices ()

void	setMidiOutNumDevices (int outNum)

CATypesetter::CATypesetterType	typesetter ()

void	setTypesetter (CATypesetter::CATypesetterType t)

QString	typesetterLocation ()

void	setTypesetterLocation (QString tl)

bool	useSystemDefaultTypesetter ()

void	setUseSystemDefaultTypesetter (bool s)

QString	pdfViewerLocation ()

void	setPdfViewerLocation (QString pl)

bool	useSystemDefaultPdfViewer ()

void	setUseSystemDefaultPdfViewer (bool s)

QDir	latestShortcutsDirectory ()

void	setLatestShortcutsDirectory (QDir d)

int	getSingleAction (const QString &oCommandName, QAction *&poResAction)

int	getSingleAction (const QString &oCommandName, CASingleAction *&poResAction)

CASingleAction &	getSingleAction (int iPos, QList< CASingleAction * > &oActionList)

bool	setSingleAction (QAction oSingleAction, int iPos)

const QList< CASingleAction * > &	getActionList ()

void	setActionList (QList< CASingleAction * > &oActionList)

void	addSingleAction (CASingleAction &oAction)

bool	deleteSingleAction (QString oCommandName, CASingleAction *&poResAction)

Static Public Member Functions
static const QString	defaultSettingsPath ()

Static Public Attributes
static const bool	DEFAULT_FINALE_LYRICS_BEHAVIOUR = false

static const bool	DEFAULT_SHADOW_NOTES_IN_OTHER_STAFFS = false

static const bool	DEFAULT_PLAY_INSERTED_NOTES = true

static const bool	DEFAULT_AUTO_BAR = true

static const bool	DEFAULT_USE_NOTE_CHECKER = true

static const QDir	DEFAULT_DOCUMENTS_DIRECTORY = QDir::home()

static const CAFileFormats::CAFileFormatType	DEFAULT_SAVE_FORMAT = CAFileFormats::Can

static const int	DEFAULT_AUTO_RECOVERY_INTERVAL = 1

static const int	DEFAULT_MAX_RECENT_DOCUMENTS = 15

static const bool	DEFAULT_LOCK_SCROLL_PLAYBACK = true

static const bool	DEFAULT_ANIMATED_SCROLL = true

static const bool	DEFAULT_ANTIALIASING = true

static const bool	DEFAULT_SHOW_RULER = true

static const QColor	DEFAULT_BACKGROUND_COLOR = QColor(255, 255, 240)

static const QColor	DEFAULT_FOREGROUND_COLOR = Qt::black

static const QColor	DEFAULT_SELECTION_COLOR = Qt::red

static const QColor	DEFAULT_SELECTION_AREA_COLOR = QColor( 255, 0, 80, 70 )

static const QColor	DEFAULT_SELECTED_CONTEXT_COLOR = Qt::blue

static const QColor	DEFAULT_HIDDEN_ELEMENTS_COLOR = Qt::green

static const QColor	DEFAULT_DISABLED_ELEMENTS_COLOR = Qt::gray

static const int	DEFAULT_MIDI_IN_PORT = -1

static const int	DEFAULT_MIDI_IN_NUM_DEVICES = 0

static const int	DEFAULT_MIDI_OUT_PORT = -1

static const int	DEFAULT_MIDI_OUT_NUM_DEVICES = 0

static const CATypesetter::CATypesetterType	DEFAULT_TYPESETTER = CATypesetter::LilyPond

static const QString	DEFAULT_TYPESETTER_LOCATION = "lilypond"

static const bool	DEFAULT_USE_SYSTEM_TYPESETTER = true

static const QString	DEFAULT_PDF_VIEWER_LOCATION = ""

static const bool	DEFAULT_USE_SYSTEM_PDF_VIEWER = true

static const QDir	DEFAULT_SHORTCUTS_DIRECTORY = QDir( QDir::homePath() + "/.config/Canorus" )

Private Member Functions
void	writeRecentDocuments ()

void	readRecentDocuments ()

Private Attributes
bool	_finaleLyricsBehaviour

bool	_shadowNotesInOtherStaffs

bool	_playInsertedNotes

bool	_autoBar

bool	_useNoteChecker

QDir	_documentsDirectory

CAFileFormats::CAFileFormatType	_defaultSaveFormat

int	_autoRecoveryInterval

int	_maxRecentDocuments

bool	_lockScrollPlayback

bool	_animatedScroll

bool	_antiAliasing

bool	_showRuler

QColor	_backgroundColor

QColor	_foregroundColor

QColor	_selectionColor

QColor	_selectionAreaColor

QColor	_selectedContextColor

QColor	_hiddenElementsColor

QColor	_disabledElementsColor

int	_midiOutPort

int	_midiInPort

int	_midiOutNumDevices

int	_midiInNumDevices

CATypesetter::CATypesetterType	_typesetter

QString	_typesetterLocation

bool	_useSystemDefaultTypesetter

QString	_pdfViewerLocation

bool	_useSystemDefaultPdfViewer

QDir	_latestShortcutsDirectory

QList< CASingleAction * >	_oActionList

CASingleAction *	_poEmptyEntry

Detailed Description

Class for storing the Canorus settings.

Licensed under the GNU GENERAL PUBLIC LICENSE. See COPYING for details.

This class is a model class used for reading and writing the settings in/out of the config file.

The default location of config files are usually $HOME$/.config/Canorus for POSIX systems and HOME%\Application data\Canorus on M$ systems. See

Constructor & Destructor Documentation

◆ CASettings() [1/2]

CASettings::CASettings ( QObject * parent = 0 )

Create a new settings instance using the default config file for a local user.

References initSettings().

Here is the call graph for this function:

◆ CASettings() [2/2]

CASettings::CASettings	(	const QString &	fileName,
		QObject *	parent = `0`
	)

Create a new settings instance using the config file fileName.

References initSettings().

Here is the call graph for this function:

◆ ~CASettings()

CASettings::~CASettings ( )

virtual

References _oActionList, _poEmptyEntry, and writeSettings().

Here is the call graph for this function:

Member Function Documentation

◆ addSingleAction()

void CASettings::addSingleAction ( CASingleAction & oSingleAction )

Adds a single action to the action list Warning: The action will be referenced!

References _oActionList, CASingleAction::getAction(), CASingleAction::getCommandName(), CASingleAction::getDescription(), CASingleAction::getMidiKeySequence(), CASingleAction::getShortCutAsString(), CASingleAction::newAction(), CASingleAction::setCommandName(), CASingleAction::setDescription(), CASingleAction::setMidiKeySequence(), and CASingleAction::setShortCutAsString().

Referenced by CAActionDelegate::addSingleAction(), and setActionList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ animatedScroll()

bool CASettings::animatedScroll ( )

inline

References _animatedScroll.

Referenced by CAMainWin::insertMusElementAt(), CAMainWin::on_uiZoomToSelection_triggered(), CAMainWin::onRepaintTimerTimeout(), CAMainWin::onTextEditKeyPressEvent(), CAMainWin::scoreViewKeyPress(), CAMainWin::scoreViewWheel(), and writeSettings().

Here is the caller graph for this function:

◆ antiAliasing()

bool CASettings::antiAliasing ( )

inline

References _antiAliasing.

Referenced by writeSettings().

Here is the caller graph for this function:

◆ autoBar()

bool CASettings::autoBar ( )

inline

References _autoBar.

Referenced by writeSettings().

Here is the caller graph for this function:

◆ autoRecoveryInterval()

int CASettings::autoRecoveryInterval ( )

inline

References _autoRecoveryInterval.

Referenced by writeSettings().

Here is the caller graph for this function:

◆ backgroundColor()

QColor CASettings::backgroundColor ( )

inline

References _backgroundColor.

Referenced by setBackgroundColor(), and writeSettings().

Here is the caller graph for this function:

◆ defaultSaveFormat()

CAFileFormats::CAFileFormatType CASettings::defaultSaveFormat ( )

inline

References _defaultSaveFormat.

Referenced by CASettingsDialog::setupPages(), and writeSettings().

Here is the caller graph for this function:

◆ defaultSettingsPath()

const QString CASettings::defaultSettingsPath ( )

static

Returns the default settings path. This function is static and is used when no config filename is specified or when a plugin wants a settings directory to store its own settings in.

Referenced by CAAutoRecovery::cleanupRecovery(), main(), CAAutoRecovery::openRecovery(), and CAAutoRecovery::saveRecovery().

Here is the caller graph for this function:

◆ deleteSingleAction()

bool CASettings::deleteSingleAction	(	QString	oCommand,
		CASingleAction *&	poResAction
	)

Removes a single action from the action list Return 'true' when succesfull Warning: The action itself is not deleted!

References _oActionList, and getSingleAction().

Referenced by CAActionDelegate::removeMainWinActions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ disabledElementsColor()

QColor CASettings::disabledElementsColor ( )

inline

References _disabledElementsColor.

Referenced by setDisabledElementsColor(), and writeSettings().

Here is the caller graph for this function:

◆ documentsDirectory()

QDir CASettings::documentsDirectory ( )

inline

References _documentsDirectory.

Referenced by writeSettings().

Here is the caller graph for this function:

◆ finaleLyricsBehaviour()

bool CASettings::finaleLyricsBehaviour ( )

inline

References _finaleLyricsBehaviour.

Referenced by CAMainWin::onTextEditKeyPressEvent(), and writeSettings().

Here is the caller graph for this function:

◆ foregroundColor()

QColor CASettings::foregroundColor ( )

inline

References _foregroundColor.

Referenced by setForegroundColor(), and writeSettings().

Here is the caller graph for this function:

◆ getActionList()

const QList< CASingleAction * > & CASettings::getActionList ( )

inline

References _oActionList.

Referenced by CASettingsDialog::buildActionsEditorPage(), and CAActionDelegate::removeMainWinActions().

Here is the caller graph for this function:

◆ getSingleAction() [1/3]

int CASettings::getSingleAction	(	const QString &	oCommandName,
		CASingleAction *&	poResAction
	)

References _oActionList, _poEmptyEntry, and CASingleAction::getCommandName().

Here is the call graph for this function:

◆ getSingleAction() [2/3]

int CASettings::getSingleAction	(	const QString &	oCommandName,
		QAction *&	poResAction
	)

Search one single action in the list of actions (-1: entry not found) Returns an empty action element when the command was not found

References _oActionList, _poEmptyEntry, CASingleAction::getAction(), and CASingleAction::getCommandName().

Referenced by deleteSingleAction(), setActionList(), and CAActionDelegate::updateMainWinActions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSingleAction() [3/3]

CASingleAction & CASettings::getSingleAction	(	int	iPos,
		QList< CASingleAction * > &	oActionList
	)

inline

Re one single action in the list of actions Does not check for the correct position in the list to be fast!

◆ hiddenElementsColor()

QColor CASettings::hiddenElementsColor ( )

inline

References _hiddenElementsColor.

Referenced by setHiddenElementsColor(), and writeSettings().

Here is the caller graph for this function:

◆ initSettings()

void CASettings::initSettings ( )

References _poEmptyEntry.

Referenced by CASettings().

Here is the caller graph for this function:

◆ latestShortcutsDirectory()

QDir CASettings::latestShortcutsDirectory ( )

inline

References _latestShortcutsDirectory.

Referenced by CAActionsEditor::CAActionsEditor().

Here is the caller graph for this function:

◆ lockScrollPlayback()

bool CASettings::lockScrollPlayback ( )

inline

References _lockScrollPlayback.

Referenced by CAMainWin::onRepaintTimerTimeout(), and writeSettings().

Here is the caller graph for this function:

◆ maxRecentDocuments()

int CASettings::maxRecentDocuments ( )

inline

References _maxRecentDocuments.

Referenced by writeSettings().

Here is the caller graph for this function:

◆ midiInNumDevices()

int CASettings::midiInNumDevices ( )

inline

References _midiInNumDevices.

Referenced by writeSettings().

Here is the caller graph for this function:

◆ midiInPort()

int CASettings::midiInPort ( )

inline

References _midiInPort.

Referenced by setMidiInPort(), and writeSettings().

Here is the caller graph for this function:

◆ midiOutNumDevices()

int CASettings::midiOutNumDevices ( )

inline

References _midiOutNumDevices.

Referenced by writeSettings().

Here is the caller graph for this function:

◆ midiOutPort()

int CASettings::midiOutPort ( )

inline

References _midiOutPort.

Referenced by writeSettings().

Here is the caller graph for this function:

◆ pdfViewerLocation()

QString CASettings::pdfViewerLocation ( )

inline

References _pdfViewerLocation.

Referenced by writeSettings().

Here is the caller graph for this function:

◆ playInsertedNotes()

bool CASettings::playInsertedNotes ( )

inline

References _playInsertedNotes.

Referenced by writeSettings().

Here is the caller graph for this function:

◆ readRecentDocuments()

void CASettings::readRecentDocuments ( )

private

References CACanorus::addRecentDocument().

Referenced by readSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readSettings()

int CASettings::readSettings ( )

Opens the settings stored in a config file and sets the local values. This function is usually called on application startup to read and validate various settings and show the settings window, if needed (eg. setup the MIDI devices the first time).

Returns: 0, if settings validated fine; -1 for playback settings errors.

References DEFAULT_ANIMATED_SCROLL, DEFAULT_ANTIALIASING, DEFAULT_AUTO_BAR, DEFAULT_AUTO_RECOVERY_INTERVAL, DEFAULT_BACKGROUND_COLOR, DEFAULT_DISABLED_ELEMENTS_COLOR, DEFAULT_DOCUMENTS_DIRECTORY, DEFAULT_FINALE_LYRICS_BEHAVIOUR, DEFAULT_FOREGROUND_COLOR, DEFAULT_HIDDEN_ELEMENTS_COLOR, DEFAULT_LOCK_SCROLL_PLAYBACK, DEFAULT_MAX_RECENT_DOCUMENTS, DEFAULT_MIDI_IN_NUM_DEVICES, DEFAULT_MIDI_IN_PORT, DEFAULT_MIDI_OUT_NUM_DEVICES, DEFAULT_MIDI_OUT_PORT, DEFAULT_PDF_VIEWER_LOCATION, DEFAULT_PLAY_INSERTED_NOTES, DEFAULT_SAVE_FORMAT, DEFAULT_SELECTED_CONTEXT_COLOR, DEFAULT_SELECTION_AREA_COLOR, DEFAULT_SELECTION_COLOR, DEFAULT_SHADOW_NOTES_IN_OTHER_STAFFS, DEFAULT_SHORTCUTS_DIRECTORY, DEFAULT_SHOW_RULER, DEFAULT_TYPESETTER, DEFAULT_TYPESETTER_LOCATION, DEFAULT_USE_NOTE_CHECKER, DEFAULT_USE_SYSTEM_PDF_VIEWER, DEFAULT_USE_SYSTEM_TYPESETTER, CACanorus::midiDevice(), readRecentDocuments(), setAnimatedScroll(), setAntiAliasing(), setAutoBar(), setAutoRecoveryInterval(), setBackgroundColor(), setDefaultSaveFormat(), setDisabledElementsColor(), setDocumentsDirectory(), setFinaleLyricsBehaviour(), setForegroundColor(), setHiddenElementsColor(), setLatestShortcutsDirectory(), setLockScrollPlayback(), setMaxRecentDocuments(), setMidiInNumDevices(), setMidiInPort(), setMidiOutNumDevices(), setMidiOutPort(), setPdfViewerLocation(), setPlayInsertedNotes(), setSelectedContextColor(), setSelectionAreaColor(), setSelectionColor(), setShadowNotesInOtherStaffs(), setShowRuler(), setTypesetter(), setTypesetterLocation(), setUseNoteChecker(), setUseSystemDefaultPdfViewer(), and setUseSystemDefaultTypesetter().

Referenced by CACanorus::initSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ selectedContextColor()

QColor CASettings::selectedContextColor ( )

inline

References _selectedContextColor.

Referenced by setSelectedContextColor(), and writeSettings().

Here is the caller graph for this function:

◆ selectionAreaColor()

QColor CASettings::selectionAreaColor ( )

inline

References _selectionAreaColor.

Referenced by setSelectionAreaColor(), and writeSettings().

Here is the caller graph for this function:

◆ selectionColor()

QColor CASettings::selectionColor ( )

inline

References _selectionColor.

Referenced by setSelectionColor(), and writeSettings().

Here is the caller graph for this function:

◆ setActionList()

void CASettings::setActionList ( QList< CASingleAction * > & oActionList )

Takes a complete action list as it's own Manually: Removes all elements and copies every single in the own list Else: According to Qt doc "assigns the other list to this list" Warning: The actions themselves cannot be copied!

References _oActionList, addSingleAction(), and getSingleAction().

Here is the call graph for this function:

◆ setAnimatedScroll()

void CASettings::setAnimatedScroll ( bool a )

inline

References _animatedScroll.

Referenced by CASettingsDialog::applySettings(), and readSettings().

Here is the caller graph for this function:

◆ setAntiAliasing()

void CASettings::setAntiAliasing ( bool a )

inline

References _antiAliasing.

Referenced by CASettingsDialog::applySettings(), and readSettings().

Here is the caller graph for this function:

◆ setAutoBar()

void CASettings::setAutoBar ( bool b )

inline

References _autoBar.

Referenced by CASettingsDialog::applySettings(), and readSettings().

Here is the caller graph for this function:

◆ setAutoRecoveryInterval()

void CASettings::setAutoRecoveryInterval ( int interval )

inline

References _autoRecoveryInterval.

Referenced by CASettingsDialog::applySettings(), and readSettings().

Here is the caller graph for this function:

◆ setBackgroundColor()

void CASettings::setBackgroundColor ( QColor backgroundColor )

inline

References _backgroundColor, and backgroundColor().

Referenced by CASettingsDialog::applySettings(), and readSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDefaultSaveFormat()

void CASettings::setDefaultSaveFormat ( CAFileFormats::CAFileFormatType t )

inline

References _defaultSaveFormat.

Referenced by CASettingsDialog::applySettings(), and readSettings().

Here is the caller graph for this function:

◆ setDisabledElementsColor()

void CASettings::setDisabledElementsColor ( QColor disabledElementsColor )

inline

References _disabledElementsColor, and disabledElementsColor().

Referenced by CASettingsDialog::applySettings(), and readSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDocumentsDirectory()

void CASettings::setDocumentsDirectory ( QDir d )

inline

References _documentsDirectory.

Referenced by CASettingsDialog::applySettings(), and readSettings().

Here is the caller graph for this function:

◆ setFinaleLyricsBehaviour()

void CASettings::setFinaleLyricsBehaviour ( bool b )

inline

References _finaleLyricsBehaviour.

Referenced by CASettingsDialog::applySettings(), and readSettings().

Here is the caller graph for this function:

◆ setForegroundColor()

void CASettings::setForegroundColor ( QColor foregroundColor )

inline

References _foregroundColor, and foregroundColor().

Referenced by CASettingsDialog::applySettings(), and readSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHiddenElementsColor()

void CASettings::setHiddenElementsColor ( QColor hiddenElementsColor )

inline

References _hiddenElementsColor, and hiddenElementsColor().

Referenced by CASettingsDialog::applySettings(), and readSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setLatestShortcutsDirectory()

void CASettings::setLatestShortcutsDirectory ( QDir d )

inline

References _latestShortcutsDirectory.

Referenced by readSettings().

Here is the caller graph for this function:

◆ setLockScrollPlayback()

void CASettings::setLockScrollPlayback ( bool l )

inline

References _lockScrollPlayback.

Referenced by CAMainWin::on_uiLockScrollPlayback_toggled(), and readSettings().

Here is the caller graph for this function:

◆ setMaxRecentDocuments()

void CASettings::setMaxRecentDocuments ( int r )

inline

References _maxRecentDocuments.

Referenced by readSettings().

Here is the caller graph for this function:

◆ setMidiInNumDevices()

void CASettings::setMidiInNumDevices ( int inNum )

inline

References _midiInNumDevices.

Referenced by readSettings().

Here is the caller graph for this function:

◆ setMidiInPort()

void CASettings::setMidiInPort ( int in )

References _midiInPort, CAMidiDevice::closeInputPort(), CACanorus::midiDevice(), midiInPort(), and CAMidiDevice::openInputPort().

Referenced by CASettingsDialog::applySettings(), and readSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setMidiOutNumDevices()

void CASettings::setMidiOutNumDevices ( int outNum )

inline

References _midiOutNumDevices.

Referenced by readSettings().

Here is the caller graph for this function:

◆ setMidiOutPort()

void CASettings::setMidiOutPort ( int out )

inline

References _midiOutPort.

Referenced by CASettingsDialog::applySettings(), and readSettings().

Here is the caller graph for this function:

◆ setPdfViewerLocation()

void CASettings::setPdfViewerLocation ( QString pl )

inline

References _pdfViewerLocation.

Referenced by CASettingsDialog::applySettings(), and readSettings().

Here is the caller graph for this function:

◆ setPlayInsertedNotes()

void CASettings::setPlayInsertedNotes ( bool b )

inline

References _playInsertedNotes.

Referenced by CASettingsDialog::applySettings(), and readSettings().

Here is the caller graph for this function:

◆ setSelectedContextColor()

void CASettings::setSelectedContextColor ( QColor selectedContextColor )

inline

References _selectedContextColor, and selectedContextColor().

Referenced by CASettingsDialog::applySettings(), and readSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSelectionAreaColor()

void CASettings::setSelectionAreaColor ( QColor selectionAreaColor )

inline

References _selectionAreaColor, and selectionAreaColor().

Referenced by CASettingsDialog::applySettings(), and readSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSelectionColor()

void CASettings::setSelectionColor ( QColor selectionColor )

inline

References _selectionColor, and selectionColor().

Referenced by CASettingsDialog::applySettings(), and readSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setShadowNotesInOtherStaffs()

void CASettings::setShadowNotesInOtherStaffs ( bool b )

inline

References _shadowNotesInOtherStaffs.

Referenced by CASettingsDialog::applySettings(), and readSettings().

Here is the caller graph for this function:

◆ setShowRuler()

void CASettings::setShowRuler ( bool b )

inline

References _showRuler.

Referenced by CAMainWin::on_uiShowRuler_toggled(), and readSettings().

Here is the caller graph for this function:

◆ setSingleAction()

bool CASettings::setSingleAction	(	QAction	oSingleAction,
		int	iPos
	)

Updates an action in the action list Return 'true' if the update was successfull Warning: 1) The action will not be copied 2) Only shortcut and no midi information is updated 3) Description cannot be updated

References _oActionList.

◆ setTypesetter()

void CASettings::setTypesetter ( CATypesetter::CATypesetterType t )

inline

References _typesetter.

Referenced by CASettingsDialog::applySettings(), and readSettings().

Here is the caller graph for this function:

◆ setTypesetterLocation()

void CASettings::setTypesetterLocation ( QString tl )

inline

References _typesetterLocation.

Referenced by CASettingsDialog::applySettings(), and readSettings().

Here is the caller graph for this function:

◆ setUseNoteChecker()

void CASettings::setUseNoteChecker ( bool b )

inline

References _useNoteChecker.

Referenced by CASettingsDialog::applySettings(), and readSettings().

Here is the caller graph for this function:

◆ setUseSystemDefaultPdfViewer()

void CASettings::setUseSystemDefaultPdfViewer ( bool s )

inline

References _useSystemDefaultPdfViewer.

Referenced by CASettingsDialog::applySettings(), and readSettings().

Here is the caller graph for this function:

◆ setUseSystemDefaultTypesetter()

void CASettings::setUseSystemDefaultTypesetter ( bool s )

inline

References _useSystemDefaultTypesetter.

Referenced by CASettingsDialog::applySettings(), and readSettings().

Here is the caller graph for this function:

◆ shadowNotesInOtherStaffs()

bool CASettings::shadowNotesInOtherStaffs ( )

inline

References _shadowNotesInOtherStaffs.

Referenced by writeSettings().

Here is the caller graph for this function:

◆ showRuler()

bool CASettings::showRuler ( )

inline

References _showRuler.

Referenced by writeSettings().

Here is the caller graph for this function:

◆ typesetter()

CATypesetter::CATypesetterType CASettings::typesetter ( )

inline

References _typesetter.

Referenced by writeSettings().

Here is the caller graph for this function:

◆ typesetterLocation()

QString CASettings::typesetterLocation ( )

inline

References _typesetterLocation.

Referenced by writeSettings().

Here is the caller graph for this function:

◆ useNoteChecker()

bool CASettings::useNoteChecker ( )

inline

References _useNoteChecker.

Referenced by CAMainWin::on_uiTimeSigBeats_valueChanged(), and writeSettings().

Here is the caller graph for this function:

◆ useSystemDefaultPdfViewer()

bool CASettings::useSystemDefaultPdfViewer ( )

inline

References _useSystemDefaultPdfViewer.

Referenced by writeSettings().

Here is the caller graph for this function:

◆ useSystemDefaultTypesetter()

bool CASettings::useSystemDefaultTypesetter ( )

inline

References _useSystemDefaultTypesetter.

Referenced by writeSettings().

Here is the caller graph for this function:

◆ writeRecentDocuments()

void CASettings::writeRecentDocuments ( )

private

References CACanorus::recentDocumentList().

Referenced by writeSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeSettings()

void CASettings::writeSettings ( )

Writes the stored settings to a config file.

References animatedScroll(), antiAliasing(), autoBar(), autoRecoveryInterval(), backgroundColor(), defaultSaveFormat(), disabledElementsColor(), documentsDirectory(), finaleLyricsBehaviour(), foregroundColor(), hiddenElementsColor(), lockScrollPlayback(), maxRecentDocuments(), midiInNumDevices(), midiInPort(), midiOutNumDevices(), midiOutPort(), pdfViewerLocation(), playInsertedNotes(), selectedContextColor(), selectionAreaColor(), selectionColor(), shadowNotesInOtherStaffs(), showRuler(), typesetter(), typesetterLocation(), useNoteChecker(), useSystemDefaultPdfViewer(), useSystemDefaultTypesetter(), and writeRecentDocuments().

Referenced by CASettingsDialog::applySettings(), CACanorus::insertRecentDocument(), CAMainWin::on_uiShowRuler_toggled(), and ~CASettings().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ _animatedScroll

bool CASettings::_animatedScroll

private

Referenced by animatedScroll(), and setAnimatedScroll().

◆ _antiAliasing

bool CASettings::_antiAliasing

private

Referenced by antiAliasing(), and setAntiAliasing().

◆ _autoBar

bool CASettings::_autoBar

private

Referenced by autoBar(), and setAutoBar().

◆ _autoRecoveryInterval

int CASettings::_autoRecoveryInterval

private

Referenced by autoRecoveryInterval(), and setAutoRecoveryInterval().

◆ _backgroundColor

QColor CASettings::_backgroundColor

private

Referenced by backgroundColor(), and setBackgroundColor().

◆ _defaultSaveFormat

CAFileFormats::CAFileFormatType CASettings::_defaultSaveFormat

private

Referenced by defaultSaveFormat(), and setDefaultSaveFormat().

◆ _disabledElementsColor

QColor CASettings::_disabledElementsColor

private

Referenced by disabledElementsColor(), and setDisabledElementsColor().

◆ _documentsDirectory

QDir CASettings::_documentsDirectory

private

Referenced by documentsDirectory(), and setDocumentsDirectory().

◆ _finaleLyricsBehaviour

bool CASettings::_finaleLyricsBehaviour

private

Referenced by finaleLyricsBehaviour(), and setFinaleLyricsBehaviour().

◆ _foregroundColor

QColor CASettings::_foregroundColor

private

Referenced by foregroundColor(), and setForegroundColor().

◆ _hiddenElementsColor

QColor CASettings::_hiddenElementsColor

private

Referenced by hiddenElementsColor(), and setHiddenElementsColor().

◆ _latestShortcutsDirectory

QDir CASettings::_latestShortcutsDirectory

private

Referenced by latestShortcutsDirectory(), and setLatestShortcutsDirectory().

◆ _lockScrollPlayback

bool CASettings::_lockScrollPlayback

private

Referenced by lockScrollPlayback(), and setLockScrollPlayback().

◆ _maxRecentDocuments

int CASettings::_maxRecentDocuments

private

Referenced by maxRecentDocuments(), and setMaxRecentDocuments().

◆ _midiInNumDevices

int CASettings::_midiInNumDevices

private

Referenced by midiInNumDevices(), and setMidiInNumDevices().

◆ _midiInPort

int CASettings::_midiInPort

private

Referenced by midiInPort(), and setMidiInPort().

◆ _midiOutNumDevices

int CASettings::_midiOutNumDevices

private

Referenced by midiOutNumDevices(), and setMidiOutNumDevices().

◆ _midiOutPort

int CASettings::_midiOutPort

private

Referenced by midiOutPort(), and setMidiOutPort().

◆ _oActionList

QList<CASingleAction *> CASettings::_oActionList

private

Referenced by addSingleAction(), deleteSingleAction(), getActionList(), getSingleAction(), setActionList(), setSingleAction(), and ~CASettings().

◆ _pdfViewerLocation

QString CASettings::_pdfViewerLocation

private

Referenced by pdfViewerLocation(), and setPdfViewerLocation().

◆ _playInsertedNotes

bool CASettings::_playInsertedNotes

private

Referenced by playInsertedNotes(), and setPlayInsertedNotes().

◆ _poEmptyEntry

CASingleAction* CASettings::_poEmptyEntry

private

Referenced by getSingleAction(), initSettings(), and ~CASettings().

◆ _selectedContextColor

QColor CASettings::_selectedContextColor

private

Referenced by selectedContextColor(), and setSelectedContextColor().

◆ _selectionAreaColor

QColor CASettings::_selectionAreaColor

private

Referenced by selectionAreaColor(), and setSelectionAreaColor().

◆ _selectionColor

QColor CASettings::_selectionColor

private

Referenced by selectionColor(), and setSelectionColor().

◆ _shadowNotesInOtherStaffs

bool CASettings::_shadowNotesInOtherStaffs

private

Referenced by setShadowNotesInOtherStaffs(), and shadowNotesInOtherStaffs().

◆ _showRuler

bool CASettings::_showRuler

private

Referenced by setShowRuler(), and showRuler().

◆ _typesetter

CATypesetter::CATypesetterType CASettings::_typesetter

private

Referenced by setTypesetter(), and typesetter().

◆ _typesetterLocation

QString CASettings::_typesetterLocation

private

Referenced by setTypesetterLocation(), and typesetterLocation().

◆ _useNoteChecker

bool CASettings::_useNoteChecker

private

Referenced by setUseNoteChecker(), and useNoteChecker().

◆ _useSystemDefaultPdfViewer

bool CASettings::_useSystemDefaultPdfViewer

private

Referenced by setUseSystemDefaultPdfViewer(), and useSystemDefaultPdfViewer().

◆ _useSystemDefaultTypesetter

bool CASettings::_useSystemDefaultTypesetter

private

Referenced by setUseSystemDefaultTypesetter(), and useSystemDefaultTypesetter().

◆ DEFAULT_ANIMATED_SCROLL

const bool CASettings::DEFAULT_ANIMATED_SCROLL = true

static

Referenced by readSettings().

◆ DEFAULT_ANTIALIASING

const bool CASettings::DEFAULT_ANTIALIASING = true

static

Referenced by readSettings().

◆ DEFAULT_AUTO_BAR

const bool CASettings::DEFAULT_AUTO_BAR = true

static

Referenced by readSettings().

◆ DEFAULT_AUTO_RECOVERY_INTERVAL

const int CASettings::DEFAULT_AUTO_RECOVERY_INTERVAL = 1

static

Referenced by readSettings().

◆ DEFAULT_BACKGROUND_COLOR

const QColor CASettings::DEFAULT_BACKGROUND_COLOR = QColor(255, 255, 240)

static

Referenced by CASettingsDialog::on_uiBackgroundRevert_clicked(), and readSettings().

◆ DEFAULT_DISABLED_ELEMENTS_COLOR

const QColor CASettings::DEFAULT_DISABLED_ELEMENTS_COLOR = Qt::gray

static

Referenced by CASettingsDialog::on_uiDisabledElementsRevert_clicked(), and readSettings().

◆ DEFAULT_DOCUMENTS_DIRECTORY

const QDir CASettings::DEFAULT_DOCUMENTS_DIRECTORY = QDir::home()

static

Referenced by CASettingsDialog::on_uiDocumentsDirectoryRevert_clicked(), and readSettings().

◆ DEFAULT_FINALE_LYRICS_BEHAVIOUR

const bool CASettings::DEFAULT_FINALE_LYRICS_BEHAVIOUR = false

static

Licensed under the GNU GENERAL PUBLIC LICENSE. See COPYING for details.

Referenced by readSettings().

◆ DEFAULT_FOREGROUND_COLOR

const QColor CASettings::DEFAULT_FOREGROUND_COLOR = Qt::black

static

Referenced by CASettingsDialog::on_uiForegroundRevert_clicked(), and readSettings().

◆ DEFAULT_HIDDEN_ELEMENTS_COLOR

const QColor CASettings::DEFAULT_HIDDEN_ELEMENTS_COLOR = Qt::green

static

Referenced by CASettingsDialog::on_uiHiddenElementsRevert_clicked(), and readSettings().

◆ DEFAULT_LOCK_SCROLL_PLAYBACK

const bool CASettings::DEFAULT_LOCK_SCROLL_PLAYBACK = true

static

Referenced by readSettings().

◆ DEFAULT_MAX_RECENT_DOCUMENTS

const int CASettings::DEFAULT_MAX_RECENT_DOCUMENTS = 15

static

Referenced by readSettings().

◆ DEFAULT_MIDI_IN_NUM_DEVICES

const int CASettings::DEFAULT_MIDI_IN_NUM_DEVICES = 0

static

Referenced by readSettings().

◆ DEFAULT_MIDI_IN_PORT

const int CASettings::DEFAULT_MIDI_IN_PORT = -1

static

Referenced by readSettings().

◆ DEFAULT_MIDI_OUT_NUM_DEVICES

const int CASettings::DEFAULT_MIDI_OUT_NUM_DEVICES = 0

static

Referenced by readSettings().

◆ DEFAULT_MIDI_OUT_PORT

const int CASettings::DEFAULT_MIDI_OUT_PORT = -1

static

Referenced by readSettings().

◆ DEFAULT_PDF_VIEWER_LOCATION

const QString CASettings::DEFAULT_PDF_VIEWER_LOCATION = ""

static

Referenced by readSettings().

◆ DEFAULT_PLAY_INSERTED_NOTES

const bool CASettings::DEFAULT_PLAY_INSERTED_NOTES = true

static

Referenced by readSettings().

◆ DEFAULT_SAVE_FORMAT

const CAFileFormats::CAFileFormatType CASettings::DEFAULT_SAVE_FORMAT = CAFileFormats::Can

static

Referenced by readSettings().

◆ DEFAULT_SELECTED_CONTEXT_COLOR

const QColor CASettings::DEFAULT_SELECTED_CONTEXT_COLOR = Qt::blue

static

Referenced by CASettingsDialog::on_uiSelectedContextRevert_clicked(), and readSettings().

◆ DEFAULT_SELECTION_AREA_COLOR

const QColor CASettings::DEFAULT_SELECTION_AREA_COLOR = QColor( 255, 0, 80, 70 )

static

Referenced by CASettingsDialog::on_uiSelectionAreaRevert_clicked(), and readSettings().

◆ DEFAULT_SELECTION_COLOR

const QColor CASettings::DEFAULT_SELECTION_COLOR = Qt::red

static

Referenced by CASettingsDialog::on_uiSelectionRevert_clicked(), and readSettings().

◆ DEFAULT_SHADOW_NOTES_IN_OTHER_STAFFS

const bool CASettings::DEFAULT_SHADOW_NOTES_IN_OTHER_STAFFS = false

static

Referenced by readSettings().

◆ DEFAULT_SHORTCUTS_DIRECTORY

const QDir CASettings::DEFAULT_SHORTCUTS_DIRECTORY = QDir( QDir::homePath() + "/.config/Canorus" )

static

Referenced by readSettings().

◆ DEFAULT_SHOW_RULER

const bool CASettings::DEFAULT_SHOW_RULER = true

static

Referenced by readSettings().

◆ DEFAULT_TYPESETTER

const CATypesetter::CATypesetterType CASettings::DEFAULT_TYPESETTER = CATypesetter::LilyPond

static

Referenced by readSettings().

◆ DEFAULT_TYPESETTER_LOCATION

const QString CASettings::DEFAULT_TYPESETTER_LOCATION = "lilypond"

static

Referenced by readSettings(), CAPDFExport::startExport(), and CASVGExport::startExport().

◆ DEFAULT_USE_NOTE_CHECKER

const bool CASettings::DEFAULT_USE_NOTE_CHECKER = true

static

Referenced by readSettings().

◆ DEFAULT_USE_SYSTEM_PDF_VIEWER

const bool CASettings::DEFAULT_USE_SYSTEM_PDF_VIEWER = true

static

Referenced by readSettings().

◆ DEFAULT_USE_SYSTEM_TYPESETTER

const bool CASettings::DEFAULT_USE_SYSTEM_TYPESETTER = true

static

Referenced by readSettings().

The documentation for this class was generated from the following files:

/home/iurt/rpmbuild/BUILD/canorus-0.7.3svn20190422/src/core/settings.h
/home/iurt/rpmbuild/BUILD/canorus-0.7.3svn20190422/src/core/settings.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CASettings() [1/2]

◆ CASettings() [2/2]

◆ ~CASettings()

Member Function Documentation

◆ addSingleAction()

◆ animatedScroll()

◆ antiAliasing()

◆ autoBar()

◆ autoRecoveryInterval()

◆ backgroundColor()

◆ defaultSaveFormat()

◆ defaultSettingsPath()

◆ deleteSingleAction()

◆ disabledElementsColor()

◆ documentsDirectory()

◆ finaleLyricsBehaviour()

◆ foregroundColor()

◆ getActionList()

◆ getSingleAction() [1/3]

◆ getSingleAction() [2/3]

◆ getSingleAction() [3/3]

◆ hiddenElementsColor()

◆ initSettings()

◆ latestShortcutsDirectory()

◆ lockScrollPlayback()

◆ maxRecentDocuments()

◆ midiInNumDevices()

◆ midiInPort()

◆ midiOutNumDevices()

◆ midiOutPort()

◆ pdfViewerLocation()

◆ playInsertedNotes()

◆ readRecentDocuments()

◆ readSettings()

◆ selectedContextColor()

◆ selectionAreaColor()

◆ selectionColor()

◆ setActionList()

◆ setAnimatedScroll()

◆ setAntiAliasing()

◆ setAutoBar()

◆ setAutoRecoveryInterval()

◆ setBackgroundColor()

◆ setDefaultSaveFormat()

◆ setDisabledElementsColor()

◆ setDocumentsDirectory()

◆ setFinaleLyricsBehaviour()

◆ setForegroundColor()

◆ setHiddenElementsColor()

◆ setLatestShortcutsDirectory()

◆ setLockScrollPlayback()

◆ setMaxRecentDocuments()

◆ setMidiInNumDevices()

◆ setMidiInPort()

◆ setMidiOutNumDevices()

◆ setMidiOutPort()

◆ setPdfViewerLocation()

◆ setPlayInsertedNotes()

◆ setSelectedContextColor()

◆ setSelectionAreaColor()

◆ setSelectionColor()

◆ setShadowNotesInOtherStaffs()

◆ setShowRuler()

◆ setSingleAction()

◆ setTypesetter()

◆ setTypesetterLocation()

◆ setUseNoteChecker()

◆ setUseSystemDefaultPdfViewer()

◆ setUseSystemDefaultTypesetter()

◆ shadowNotesInOtherStaffs()

◆ showRuler()

◆ typesetter()

◆ typesetterLocation()