SettingsPrivate class contains all relevant pairs of (keys, values) used by Miam-Player. More...

#include <settingsprivate.h>

Inheritance diagram for SettingsPrivate:

Public Types
enum	DragDropAction { DD_OpenPopup = 0, DD_AddToLibrary = 1, DD_AddToPlaylist = 2 }

enum	FontFamily { FF_Playlist = 0, FF_Library = 1, FF_Menu = 2 }

enum	InsertPolicy { IP_Artists = 0, IP_Albums = 1, IP_ArtistsAlbums = 2, IP_Years = 3 }

enum	LibrarySearchMode { LSM_Filter = 0, LSM_HighlightOnly = 1 }

enum	PlaylistDefaultAction { PDA_AskUserForAction = 0, PDA_SaveOnClose = 1, PDA_DiscardOnClose = 2 }

Public Slots
void	addMusicLocations (const QList< QDir > &dirs)
	SLOTS. More...

void	setColorsAlternateBG (bool b)

void	setCopyTracksFromPlaylist (bool b)

void	setCustomColors (bool b)

void	setCustomTextColorOverride (bool b)

void	setDragDropAction (DragDropAction action)

void	setExtendedSearchVisible (bool b)

void	setFont (const FontFamily &fontFamily, const QFont &font)

void	setFontPointSize (const FontFamily &fontFamily, int i)

void	setIsLibraryFilteredByArticles (bool b)

void	setLastActivePlaylistGeometry (const QByteArray &)

void	setLibraryFilteredByArticles (const QStringList &tagList)

void	setMonitorFileSystem (bool b)

void	setPlaybackSeekTime (int t)
	PlayBack options. More...

void	setPlaybackCloseAction (PlaylistDefaultAction action)

void	setPlaybackKeepPlaylists (bool b)

void	setPlaybackRestorePlaylistsAtStartup (bool b)

void	setRemoteControlPort (uint port)

void	setReorderArtistsArticle (bool b)

void	setSearchAndExcludeLibrary (bool b)

void	setTabsOverlappingLength (int l)

void	setTabsRect (bool b)

void	setButtonThemeCustomized (bool b)

void	setVolumeBarHideAfter (int seconds)

Signals
void	customIconForMediaButtonChanged (const QString &button)

void	languageAboutToChange (const QString &newLanguage)

void	fontHasChanged (FontFamily, const QFont &font)

void	librarySearchModeHasChanged ()

void	monitorFileSystemChanged (bool)

void	musicLocationsHaveChanged (const QStringList &oldLocations, const QStringList &newLocations)

void	remoteControlChanged (bool enabled, uint port)

Public Member Functions
void	addPlugin (const PluginInfo &plugin)

void	disablePlugin (const QString &absFilePath)

bool	colorsAlternateBG () const

bool	copyTracksFromPlaylist () const

const QString	customIcon (const QString &buttonName) const

QPalette	customPalette () const

QString	defaultLocationFileExplorer () const

DragDropAction	dragDropAction () const

QFont	font (const FontFamily fontFamily)

int	fontSize (const FontFamily fontFamily)

bool	hasCustomIcon (const QString &buttonName) const

InsertPolicy	insertPolicy () const

bool	isCustomColors () const

bool	isCustomTextColorOverriden () const

bool	isExtendedSearchVisible () const

bool	isFileSystemMonitored () const

bool	isLibraryFilteredByArticles () const

bool	isPlaylistResizeColumns () const

bool	isRectTabs () const

bool	isRemoteControlEnabled () const

bool	isReorderArtistsArticle () const

bool	isButtonThemeCustomized () const

QString	language ()

QByteArray	lastActivePlaylistGeometry () const

QByteArray	lastActiveViewGeometry (const QString &menuAction) const

QList< uint >	lastPlaylistSession () const

QStringList	libraryFilteredByArticles () const

LibrarySearchMode	librarySearchMode () const

QStringList	musicLocations () const

int	tabsOverlappingLength () const

qint64	playbackSeekTime () const
	PlayBack options. More...

PlaylistDefaultAction	playbackDefaultActionForClose () const

bool	playbackKeepPlaylists () const

bool	playbackRestorePlaylistsAtStartup () const

QMap< QString, PluginInfo >	plugins () const

uint	remoteControlPort () const

void	setCustomColorRole (QPalette::ColorRole cr, const QColor &color)

void	setCustomIcon (const QString &buttonName, const QString &iconPath)

bool	setLanguage (const QString &lang)

void	setLastActiveViewGeometry (const QString &menuAction, const QByteArray &viewGeometry)

void	setLastPlaylistSession (const QList< uint > &ids)

void	setMusicLocations (const QStringList &locations)

void	setRemoteControlEnabled (bool b)

void	setShortcut (const QString &objectName, const QKeySequence &keySequence)

QKeySequence	shortcut (const QString &objectName) const

int	volumeBarHideAfter () const

void	setDefaultLocationFileExplorer (const QString &location)

void	setInsertPolicy (InsertPolicy ip)

Static Public Member Functions
static SettingsPrivate *	instance ()

Public Attributes
QTranslator	playerTranslator

QTranslator	defaultQtTranslator

Detailed Description

SettingsPrivate class contains all relevant pairs of (keys, values) used by Miam-Player.

This class implements the Singleton pattern. Instead of using standard "this->value(QString)", lots of methods are built on-top of it. It keeps the code easy to read and some important enums are shared between plugins too.

Author: Matthieu Bachelier

Copyright: GNU General Public License v3

Member Enumeration Documentation

enum SettingsPrivate::DragDropAction

Enumerator
DD_OpenPopup
DD_AddToLibrary
DD_AddToPlaylist

enum SettingsPrivate::FontFamily

Enumerator
FF_Playlist
FF_Library
FF_Menu

enum SettingsPrivate::InsertPolicy

Enumerator
IP_Artists
IP_Albums
IP_ArtistsAlbums
IP_Years

enum SettingsPrivate::LibrarySearchMode

Enumerator
LSM_Filter
LSM_HighlightOnly

enum SettingsPrivate::PlaylistDefaultAction

Enumerator
PDA_AskUserForAction
PDA_SaveOnClose
PDA_DiscardOnClose

Member Function Documentation

void SettingsPrivate::addMusicLocations ( const QList< QDir > & dirs )

slot

SLOTS.

Add a list of folders to settings.

void SettingsPrivate::addPlugin ( const PluginInfo & plugin )

Add an activated plugin to the application.

bool SettingsPrivate::colorsAlternateBG ( ) const

Returns true if the background color in playlist is using alternatative colors.

bool SettingsPrivate::copyTracksFromPlaylist ( ) const

const QString SettingsPrivate::customIcon ( const QString & buttonName ) const

Custom icons in Customize(Theme)

void SettingsPrivate::customIconForMediaButtonChanged ( const QString & button )

signal

QPalette SettingsPrivate::customPalette ( ) const

QString SettingsPrivate::defaultLocationFileExplorer ( ) const

void SettingsPrivate::disablePlugin ( const QString & absFilePath )

Disable a previously registered plugin (so it still can be listed in options).

SettingsPrivate::DragDropAction SettingsPrivate::dragDropAction ( ) const

QFont SettingsPrivate::font ( const FontFamily fontFamily )

Returns the font of the application.

void SettingsPrivate::fontHasChanged	(	FontFamily	,
		const QFont &	font
	)

signal

int SettingsPrivate::fontSize ( const FontFamily fontFamily )

Sets the font of the application.

bool SettingsPrivate::hasCustomIcon ( const QString & buttonName ) const

Custom icons in CustomizeTheme

SettingsPrivate::InsertPolicy SettingsPrivate::insertPolicy ( ) const

SettingsPrivate * SettingsPrivate::instance ( )

static

Singleton Pattern to easily use Settings everywhere in the app.

Singleton pattern to be able to easily use SettingsPrivate everywhere in the app.

bool SettingsPrivate::isButtonThemeCustomized ( ) const

Returns true if a user has modified one of defaults theme.

bool SettingsPrivate::isCustomColors ( ) const

bool SettingsPrivate::isCustomTextColorOverriden ( ) const

bool SettingsPrivate::isExtendedSearchVisible ( ) const

bool SettingsPrivate::isFileSystemMonitored ( ) const

Returns true if background process is active to keep library up-to-date.

bool SettingsPrivate::isLibraryFilteredByArticles ( ) const

Returns the hierarchical order of the library tree view.

bool SettingsPrivate::isPlaylistResizeColumns ( ) const

bool SettingsPrivate::isRectTabs ( ) const

Returns true if tabs should be displayed like rectangles.

bool SettingsPrivate::isRemoteControlEnabled ( ) const

bool SettingsPrivate::isReorderArtistsArticle ( ) const

Returns true if the article should be displayed after artist's name.

QString SettingsPrivate::language ( )

Returns the language of the application.

void SettingsPrivate::languageAboutToChange ( const QString & newLanguage )

signal

QByteArray SettingsPrivate::lastActivePlaylistGeometry ( ) const

Returns the last active playlist header state.

QByteArray SettingsPrivate::lastActiveViewGeometry ( const QString & menuAction ) const

QList< uint > SettingsPrivate::lastPlaylistSession ( ) const

Returns the last playlists that were opened when player was closed.

QStringList SettingsPrivate::libraryFilteredByArticles ( ) const

SettingsPrivate::LibrarySearchMode SettingsPrivate::librarySearchMode ( ) const

void SettingsPrivate::librarySearchModeHasChanged ( )

signal

void SettingsPrivate::monitorFileSystemChanged ( bool )

signal

QStringList SettingsPrivate::musicLocations ( ) const

Returns all music locations.

void SettingsPrivate::musicLocationsHaveChanged	(	const QStringList &	oldLocations,
		const QStringList &	newLocations
	)

signal

Signal sent whether the music locations have changed or not.

SettingsPrivate::PlaylistDefaultAction SettingsPrivate::playbackDefaultActionForClose ( ) const

Default action to execute when one is closing a playlist.

bool SettingsPrivate::playbackKeepPlaylists ( ) const

Automatically save all playlists before exit.

bool SettingsPrivate::playbackRestorePlaylistsAtStartup ( ) const

Automatically restore all saved playlists at startup.

qint64 SettingsPrivate::playbackSeekTime ( ) const

PlayBack options.

QMap< QString, PluginInfo > SettingsPrivate::plugins ( ) const

void SettingsPrivate::remoteControlChanged	(	bool	enabled,
		uint	port
	)

signal

uint SettingsPrivate::remoteControlPort ( ) const

void SettingsPrivate::setButtonThemeCustomized ( bool b )

slot

void SettingsPrivate::setColorsAlternateBG ( bool b )

slot

Sets an alternate background color for playlists.

void SettingsPrivate::setCopyTracksFromPlaylist ( bool b )

slot

Copy or move tracks from one playlist to another.

void SettingsPrivate::setCustomColorRole	(	QPalette::ColorRole	cr,
		const QColor &	color
	)

XXX

void SettingsPrivate::setCustomColors ( bool b )

slot

Sets custom colors for the whole application.

void SettingsPrivate::setCustomIcon	(	const QString &	buttonName,
		const QString &	iconPath
	)

Custom icons in CustomizeTheme

void SettingsPrivate::setCustomTextColorOverride ( bool b )

slot

Sets custom text color instead of classic black or white.

void SettingsPrivate::setDefaultLocationFileExplorer ( const QString & location )

void SettingsPrivate::setDragDropAction ( DragDropAction action )

slot

Sets the default action when one is dropping tracks or folders.

void SettingsPrivate::setExtendedSearchVisible ( bool b )

slot

Sets a popup when one is searching text in Library (Playlist mode only).

void SettingsPrivate::setFont	(	const FontFamily &	fontFamily,
		const QFont &	font
	)

slot

Sets the font of a part of the application.

void SettingsPrivate::setFontPointSize	(	const FontFamily &	fontFamily,
		int	i
	)

slot

Sets the font size of a part of the application.

void SettingsPrivate::setInsertPolicy ( SettingsPrivate::InsertPolicy ip )

Define the hierarchical order of the library tree view.

void SettingsPrivate::setIsLibraryFilteredByArticles ( bool b )

slot

Sets user defined articles (like 'The', 'Le') to sort the Library.

bool SettingsPrivate::setLanguage ( const QString & lang )

Sets the language of the application.

void SettingsPrivate::setLastActivePlaylistGeometry ( const QByteArray & ba )

slot

Save the last active playlist header state.

void SettingsPrivate::setLastActiveViewGeometry	(	const QString &	menuAction,
		const QByteArray &	viewGeometry
	)

void SettingsPrivate::setLastPlaylistSession ( const QList< uint > & ids )

Sets the last playlists that were opened when player is about to close.

void SettingsPrivate::setLibraryFilteredByArticles ( const QStringList & tagList )

slot

Sets user defined list of articles to sort the Library.

void SettingsPrivate::setMonitorFileSystem ( bool b )

slot

Sets if MiamPlayer should launch background process to keep library up-to-date.

void SettingsPrivate::setMusicLocations ( const QStringList & locations )

void SettingsPrivate::setPlaybackCloseAction ( PlaylistDefaultAction action )

slot

void SettingsPrivate::setPlaybackKeepPlaylists ( bool b )

slot

void SettingsPrivate::setPlaybackRestorePlaylistsAtStartup ( bool b )

slot

void SettingsPrivate::setPlaybackSeekTime ( int t )

slot

PlayBack options.

void SettingsPrivate::setRemoteControlEnabled ( bool b )

void SettingsPrivate::setRemoteControlPort ( uint port )

slot

void SettingsPrivate::setReorderArtistsArticle ( bool b )

slot

void SettingsPrivate::setSearchAndExcludeLibrary ( bool b )

slot

void SettingsPrivate::setShortcut	(	const QString &	objectName,
		const QKeySequence &	keySequence
	)

void SettingsPrivate::setTabsOverlappingLength ( int l )

slot

void SettingsPrivate::setTabsRect ( bool b )

slot

void SettingsPrivate::setVolumeBarHideAfter ( int seconds )

slot

QKeySequence SettingsPrivate::shortcut ( const QString & objectName ) const

int SettingsPrivate::tabsOverlappingLength ( ) const

int SettingsPrivate::volumeBarHideAfter ( ) const

Member Data Documentation

QTranslator SettingsPrivate::defaultQtTranslator

QTranslator SettingsPrivate::playerTranslator

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

src/Core/settingsprivate.h
src/Core/settingsprivate.cpp

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation