#include <qmmpui/qmmpuisettings.h>

Public Slots
void	setRepeatableList (bool r)
void	setShuffle (bool s)
void	setGroupsEnabled (bool enabled)
void	setRepeatableTrack (bool enabled)
void	setNoPlayListAdvance (bool enabled)
void	setPlayListTransitionEnabled (bool enabled)

Signals
void	repeatableListChanged (bool state)
void	shuffleChanged (bool state)
void	groupsChanged (bool state)
void	repeatableTrackChanged (bool enabled)
void	noPlayListAdvanceChanged (bool enabled)
void	playListTransitionChanged (bool enabled)

Public Member Functions
	QmmpUiSettings (QObject *parent=nullptr)
virtual	~QmmpUiSettings ()
bool	convertUnderscore () const
bool	convertTwenty () const
bool	useMetaData () const
QString	groupFormat () const
QString	groupExtraRowFormat () const
int	linesPerGroup () const
bool	groupExtraRowVisible () const
bool	groupCoverVisible () const
bool	groupDividingLineVisible () const
bool	isRepeatableList () const
bool	isShuffle () const
bool	isGroupsEnabled () const
bool	isRepeatableTrack () const
bool	isNoPlayListAdvance () const
bool	isPlayListTransitionEnabled () const
void	setConvertUnderscore (bool enabled)
void	setConvertTwenty (bool enabled)
void	setGroupFormat (const QString &groupFormat)
void	setGroupExtraRowFormat (const QString &extraRowFormat)
void	setLinesPerGroup (int lines)
void	setGroupExtraRowVisible (bool enabled)
void	setGroupCoverVisible (bool enabled)
void	setGroupDividingLineVisible (bool enabled)
void	setUseMetaData (bool enabled)
bool	resumeOnStartup () const
void	setResumeOnStartup (bool enabled)
void	setUseClipboard (bool enabled)
bool	useClipboard () const
const QStringList &	restrictFilters () const
void	setRestrictFilters (const QString &filters)
const QStringList &	excludeFilters () const
void	setExcludeFilters (const QString &filters)
bool	useDefaultPlayList () const
const QString &	defaultPlayListName () const
void	setDefaultPlayList (const QString &name, bool enabled=true)
void	setAutoSavePlayList (bool enabled)
bool	autoSavePlayList () const
void	setClearPreviousPlayList (bool enabled)
bool	clearPreviousPlayList () const
void	setSkipExistingTracks (bool enabled)
bool	skipExistingTracks () const
bool	stopAfterRemovingOfCurrentTrack () const
void	setStopAfterRemovingOfCurrentTrack (bool enabled)
bool	readMetaDataForPlayLists () const
void	setReadMetaDataForPlayLists (bool enabled)

Static Public Member Functions
static QmmpUiSettings *	instance ()

Detailed Description

The QmmpUiSettings class provides access to global libqmmpui library settings.

Author: Ilya Kotov forko.nosp@m.tov0.nosp@m.2@ya..nosp@m.ru

Constructor & Destructor Documentation

◆ QmmpUiSettings()

QmmpUiSettings ( QObject * parent = nullptr )

explicit

Constructor.

Parameters

parent Parent object. This functions is for internal usage only, use QmmpSettings::instance() instead.

◆ ~QmmpUiSettings()

virtual ~QmmpUiSettings ( )

virtual

Destructor.

Member Function Documentation

◆ autoSavePlayList()

bool autoSavePlayList ( ) const

Returns the current setting for the playlist auto-save option.

Returns: true if the playlist should be saved automatically, false otherwise.

◆ clearPreviousPlayList()

bool clearPreviousPlayList ( ) const

Returns the current setting for the option to clear playlist when opening new one.

Returns: true if the playlist should be saved automatically, false otherwise.

◆ convertTwenty()

bool convertTwenty ( ) const

Returns state of the "Convert %20 to blanks" option (true - enabled, false - disabled).

◆ convertUnderscore()

bool convertUnderscore ( ) const

Returns state of the "Convert underscores to blanks" option (true - enabled, false - disabled).

◆ defaultPlayListName()

const QString & defaultPlayListName ( ) const

Returns default playlist name.

◆ excludeFilters()

const QStringList & excludeFilters ( ) const

Returns a list of filters which should be excluded from incoming files while directory scanning.

◆ groupCoverVisible()

bool groupCoverVisible ( ) const

Returns true if group cover is visible. Otherwise returns false.

◆ groupDividingLineVisible()

bool groupDividingLineVisible ( ) const

Returns true if group dividing line is visible. Otherwise returns false.

◆ groupExtraRowFormat()

QString groupExtraRowFormat ( ) const

Returns playlist group extra row format.

◆ groupExtraRowVisible()

bool groupExtraRowVisible ( ) const

Returns true if extra group row is visible. Otherwise returns false.

◆ groupFormat()

QString groupFormat ( ) const

Returns playlist group format.

◆ groupsChanged

void groupsChanged ( bool state )

signal

Emitted when state of the "Group tracks" option has changed.

Parameters

state New state of the "Group tracks" option (true - enabled, false - disabled

◆ instance()

QmmpUiSettings * instance ( )

static

Returns a pointer to the QmmpUiSettings instance.

◆ isGroupsEnabled()

bool isGroupsEnabled ( ) const

Returns true if the playlist groups are enabled. Otherwise returns false.

◆ isNoPlayListAdvance()

bool isNoPlayListAdvance ( ) const

Returns true if "No playlist advance" option is enabled, otherwise returns false

◆ isPlayListTransitionEnabled()

bool isPlayListTransitionEnabled ( ) const

Returns true if transition between playlists is enabled, otherwise returns false

◆ isRepeatableList()

bool isRepeatableList ( ) const

Returns state of "Repeat All" option.

◆ isRepeatableTrack()

bool isRepeatableTrack ( ) const

Returns true if "Repeate Track" option is enabled, otherwise returns false

◆ isShuffle()

bool isShuffle ( ) const

Returns state of "Shuffle" option.

◆ linesPerGroup()

int linesPerGroup ( ) const

Returns the number of lines needed to draw the group.

◆ noPlayListAdvanceChanged

void noPlayListAdvanceChanged ( bool enabled )

signal

Emitted when state of the "No playlist advance" option changes.

Parameters

enabled New state of this option (true - no playlist advance, false - normal playlist behaviour)

◆ playListTransitionChanged

void playListTransitionChanged ( bool enabled )

signal

Emitted when state of the "transition between playlists" option changes

Parameters

enabled State of transition (true - enabled, false - disabled)

◆ readMetaDataForPlayLists()

bool readMetaDataForPlayLists ( ) const

Returns the current setting for the option to read tags when loading a playlist.

Returns: true if tag reading is enabled, false otherwise.

◆ repeatableListChanged

void repeatableListChanged ( bool state )

signal

Emitted when state of the "Repeat All" option has changed.

Parameters

state New state of the "Repeat All" option (true - enabled, false - disabled)

◆ repeatableTrackChanged

void repeatableTrackChanged ( bool enabled )

signal

Tracks current track repeat state;

Parameters

enabled New repeate state of the current track (true - enabled, false - disabled)

◆ restrictFilters()

const QStringList & restrictFilters ( ) const

Returns a list of filters which should be used for directory scanning.

◆ resumeOnStartup()

bool resumeOnStartup ( ) const

Returns true if option "Resume On Startup" is enabled, otherwise returns false

◆ setAutoSavePlayList()

void setAutoSavePlayList ( bool enabled )

Enable/disable playlist auto-saving.

Parameters

enabled New setting for the auto-save option (true to enable)

◆ setClearPreviousPlayList()

void setClearPreviousPlayList ( bool enabled )

Enable/disable feature to clear previous playlist when opening new one.

Parameters

enabled New setting for this option (true to enable)

◆ setConvertTwenty()

void setConvertTwenty ( bool enabled )

Sets the "Convert %20 to blanks" option state to enabled

Parameters

enabled Option state (true - enabled, false - disabled)

◆ setConvertUnderscore()

void setConvertUnderscore ( bool enabled )

Sets the "Convert underscores to blanks" option state to enabled

Parameters

enabled Option state (true - enabled, false - disabled)

◆ setDefaultPlayList()

void setDefaultPlayList	(	const QString &	name,
		bool	enabled = true )

Sets default playlist options.

Parameters

name	Default playlist name.
enabled	Default playlist state (true - enabled, false - disabled).

◆ setExcludeFilters()

void setExcludeFilters ( const QString & filters )

Sets a list of filters which should be excluded from incoming files while directory scanning.

Parameters

filters A set of filters separated by semicolon (Example: .cue,.ogg).

◆ setGroupCoverVisible()

void setGroupCoverVisible ( bool enabled )

Sets group cover visibility to enabled

Parameters

enabled Cover visibility ((true - visible, false - hidden))

◆ setGroupDividingLineVisible()

void setGroupDividingLineVisible ( bool enabled )

Sets group dividing line visibility to enabled

Parameters

enabled Dividing line visibility ((true - visible, false - hidden))

◆ setGroupExtraRowFormat()

void setGroupExtraRowFormat ( const QString & extraRowFormat )

Sets group extra row format.

Parameters

extraRowFormat Extra row format.

See also: MetaDataFormatter

◆ setGroupExtraRowVisible()

void setGroupExtraRowVisible ( bool enabled )

Sets group extra row visibility to enabled

Parameters

enabled Extra row visibility ((true - visible, false - hidden))

◆ setGroupFormat()

void setGroupFormat ( const QString & groupFormat )

Sets group format.

Parameters

groupFormat group format.

See also: MetaDataFormatter

◆ setGroupsEnabled

void setGroupsEnabled ( bool enabled )

slot

Enables or disables playlist groups

Parameters

enabled State of the groups (true - enabled, false - disabled)

◆ setLinesPerGroup()

void setLinesPerGroup ( int lines )

Sets group height in lines.

Parameters

lines Number of lines.

◆ setNoPlayListAdvance

void setNoPlayListAdvance ( bool enabled )

slot

When finished playing a song, don't automatically advance to the next

Parameters

enabled State of the 'No playlist advance' option (true - enabled, false - normal playback)

◆ setPlayListTransitionEnabled

void setPlayListTransitionEnabled ( bool enabled )

slot

Enables or disables transition between playlists

Parameters

enabled State of transition (true - enabled, false - disabled)

◆ setReadMetaDataForPlayLists()

void setReadMetaDataForPlayLists ( bool enabled )

Enable/disable tag reading when loading a playlist.

Parameters

enabled New setting for this option (true to enable).

◆ setRepeatableList

void setRepeatableList ( bool r )

slot

Prepares all playlists for repeatable playing (loop mode).

Parameters

r	State of the repeatable mode (true - enabled, false - disabled)

◆ setRepeatableTrack

void setRepeatableTrack ( bool enabled )

slot

Toggles the current track repeat.

Parameters

enabled Repeate state of the current track (true - to repeat, false - to stop repeating)

◆ setRestrictFilters()

void setRestrictFilters ( const QString & filters )

Disables all builtin directory scanning filters and sets them to filters (Example: .mp3,.ogg).

◆ setResumeOnStartup()

void setResumeOnStartup ( bool enabled )

Sets the "Resume on startup" option state to enabled

Parameters

enabled Option state (true - enabled, false - disabled)

◆ setShuffle

void setShuffle ( bool s )

slot

Prepares all playlists for shuffle playing.

Parameters

s	State of the shuffle mode (true - enabled, false - disabled)

◆ setSkipExistingTracks()

void setSkipExistingTracks ( bool enabled )

Enable/disable feature to skip already existing track when adding to the playlist.

Parameters

enabled New setting for this option (true to enable)

◆ setStopAfterRemovingOfCurrentTrack()

void setStopAfterRemovingOfCurrentTrack ( bool enabled )

Sets playback behavior after removal of current track.

Parameters

enabled New setting for this option (true - playback will be stopped after current track removal, false - playback will be continued after current track removal).

◆ setUseClipboard()

void setUseClipboard ( bool enabled )

Sets the "Use clipboard in the URL dialog" option state to enabled

Parameters

enabled Option state (true - enabled, false - disabled)

◆ setUseMetaData()

void setUseMetaData ( bool enabled )

Sets metadata usage option state to enabled

Parameters

enabled Option state (true - enabled, false - disabled)

◆ shuffleChanged

void shuffleChanged ( bool state )

signal

Emitted when state of the "Shuffle" option has changed.

Parameters

state New state of the "Shuffle" option (true - enabled, false - disabled)

◆ skipExistingTracks()

bool skipExistingTracks ( ) const

Returns the current setting for the option to skip already existing tracks when adding to the playlist.

Returns: true if the already existing tracks should be skipped, false otherwise.

◆ stopAfterRemovingOfCurrentTrack()

bool stopAfterRemovingOfCurrentTrack ( ) const

Returns true if playback will be stopped after current track removal. Otherwise returns false.

◆ useClipboard()

bool useClipboard ( ) const

Returns true if option "Use clipboard in the URL dialog" is enabled, otherwise returns false

◆ useDefaultPlayList()

bool useDefaultPlayList ( ) const

Returns true if defaut playlist is enabled, othewise returns false. Default playlist receives files from command line.

◆ useMetaData()

bool useMetaData ( ) const

Returns the state of metadata usage (true - use, false - not use).

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

/usr/src/RPM/BUILD/qmmp-2.3.1/src/qmmpui/qmmpuisettings.h

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QmmpUiSettings()

◆ ~QmmpUiSettings()

Member Function Documentation

◆ autoSavePlayList()

◆ clearPreviousPlayList()

◆ convertTwenty()

◆ convertUnderscore()

◆ defaultPlayListName()

◆ excludeFilters()

◆ groupCoverVisible()

◆ groupDividingLineVisible()

◆ groupExtraRowFormat()

◆ groupExtraRowVisible()

◆ groupFormat()

◆ groupsChanged

◆ instance()

◆ isGroupsEnabled()

◆ isNoPlayListAdvance()

◆ isPlayListTransitionEnabled()

◆ isRepeatableList()

◆ isRepeatableTrack()

◆ isShuffle()

◆ linesPerGroup()

◆ noPlayListAdvanceChanged

◆ playListTransitionChanged

◆ readMetaDataForPlayLists()

◆ repeatableListChanged

◆ repeatableTrackChanged

◆ restrictFilters()

◆ resumeOnStartup()

◆ setAutoSavePlayList()

◆ setClearPreviousPlayList()

◆ setConvertTwenty()

◆ setConvertUnderscore()

◆ setDefaultPlayList()

◆ setExcludeFilters()

◆ setGroupCoverVisible()

◆ setGroupDividingLineVisible()

◆ setGroupExtraRowFormat()

◆ setGroupExtraRowVisible()

◆ setGroupFormat()

◆ setGroupsEnabled

◆ setLinesPerGroup()

◆ setNoPlayListAdvance

◆ setPlayListTransitionEnabled

◆ setReadMetaDataForPlayLists()

◆ setRepeatableList

◆ setRepeatableTrack

◆ setRestrictFilters()

◆ setResumeOnStartup()

◆ setShuffle

◆ setSkipExistingTracks()

◆ setStopAfterRemovingOfCurrentTrack()

◆ setUseClipboard()

◆ setUseMetaData()

◆ shuffleChanged

◆ skipExistingTracks()

◆ stopAfterRemovingOfCurrentTrack()

◆ useClipboard()

◆ useDefaultPlayList()

◆ useMetaData()