Qmmp
Public Slots | Signals | Public Member Functions | Static Public Member Functions | List of all members
QmmpUiSettings Class Reference

#include <qmmpuisettings.h>

Inherits QObject.

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) const
 

Public Member Functions

 QmmpUiSettings (QObject *parent=nullptr)
 
virtual ~QmmpUiSettings ()
 
bool convertUnderscore () const
 
bool convertTwenty () const
 
bool useMetaData () const
 
const QString groupFormat () 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 setUseMetaData (bool enabled)
 
bool resumeOnStartup () const
 
void setResumeOnStartup (bool enabled)
 
void setUseClipboard (bool enabled)
 
bool useClipboard () const
 
QStringList restrictFilters () const
 
void setRestrictFilters (const QString &filters)
 
QStringList excludeFilters () const
 
void setExcludeFilters (const QString &filters)
 
bool useDefaultPlayList () 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
 
bool readMetaDataForPlayLists () const
 
void setReadMetaDataForPlayLists (bool enabled)
 

Static Public Member Functions

static QmmpUiSettingsinstance ()
 

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
parentParent 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()

QString defaultPlayListName ( ) const

Returns default playlist name.

◆ excludeFilters()

QStringList excludeFilters ( ) const

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

◆ groupFormat()

const QString groupFormat ( ) const

Returns playlist group format.

◆ groupsChanged

void groupsChanged ( bool  state)
signal

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

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

◆ instance()

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

◆ noPlayListAdvanceChanged

void noPlayListAdvanceChanged ( bool  enabled)
signal

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

Parameters
enabledNew state of this option (true - no playlist advance, false - normal playlist behaviour)

◆ playListTransitionChanged

void playListTransitionChanged ( bool  enabled) const
signal

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

Parameters
enabledState 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
stateNew state of the "Repeat All" option (true - enabled, false disabled)

◆ repeatableTrackChanged

void repeatableTrackChanged ( bool  enabled)
signal

Tracks current track repeat state;

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

◆ restrictFilters()

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
enabledNew 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
enabledNew setting for this option (true to enable)

◆ setConvertTwenty()

void setConvertTwenty ( bool  enabled)

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

Parameters
enabledOption state (true - enabled, false - disabled)

◆ setConvertUnderscore()

void setConvertUnderscore ( bool  enabled)

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

Parameters
enabledOption state (true - enabled, false - disabled)

◆ setDefaultPlayList()

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

Sets default playlist options.

Parameters
nameDefault playlist name.
enabledDefault 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
filtersA set of filters separated by semicolon (Example: *.cue,*.ogg).

◆ setGroupFormat()

void setGroupFormat ( const QString &  groupFormat)

Sets group format.

Parameters
groupFormatgroup format.
See also
MetaDataFormatter

◆ setGroupsEnabled

void setGroupsEnabled ( bool  enabled)
slot

Enables or disables playlist groups

Parameters
enabledState of the groups (true - enabled, false - disabled)

◆ setNoPlayListAdvance

void setNoPlayListAdvance ( bool  enabled)
slot

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

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

◆ setPlayListTransitionEnabled

void setPlayListTransitionEnabled ( bool  enabled)
slot

Enables or disables transition between playlists

Parameters
enabledState of transition (true - enabled, false - disabled)

◆ setReadMetaDataForPlayLists()

void setReadMetaDataForPlayLists ( bool  enabled)

Enable/disable tag reading when loading a playlist.

Parameters
enabledNew setting for this option (true to enable)

◆ setRepeatableList

void setRepeatableList ( bool  r)
slot

Prepares all playlists for repeatable playing (loop mode).

Parameters
rState of the repeatable mode (true - enabled, false - disabled)

◆ setRepeatableTrack

void setRepeatableTrack ( bool  enabled)
slot

Toggles the current track repeat.

Parameters
enabledRepeate 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
enabledOption state (true - enabled, false - disabled)

◆ setShuffle

void setShuffle ( bool  s)
slot

Prepares all playlists for shuffle playing.

Parameters
sState of the shuffle mode (true - enabled, false - disabled)

◆ setUseClipboard()

void setUseClipboard ( bool  enabled)

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

Parameters
enabledOption state (true - enabled, false - disabled)

◆ setUseMetaData()

void setUseMetaData ( bool  enabled)

Sets metadata usage option state to enabled

Parameters
enabledOption state (true - enabled, false - disabled)

◆ shuffleChanged

void shuffleChanged ( bool  state)
signal

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

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

◆ 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: