Sayonara Player
Public Types | Signals | Public Member Functions | List of all members
Bookmarks Class Reference

The Bookmarks logic class. More...

#include <Bookmarks.h>

Inheritance diagram for Bookmarks:
BookmarksBase

Public Types

enum  CreationStatus : unsigned char {
  Success,
  AlreadyThere,
  NoDBTrack,
  DBError,
  OtherError
}
 

Signals

void sigBookmarksChanged ()
 emitted when bookmarks have changed More...
 
void sigPreviousChanged (const Bookmark &bm)
 previous bookmark has changed More...
 
void sigNextChanged (const Bookmark &bm)
 next bookmark has changed More...
 

Public Member Functions

 Bookmarks (QObject *parent)
 
bool jumpTo (int idx)
 Jump to specific bookmark. More...
 
bool jumpNext ()
 Jump to next bookmark. More...
 
bool jumpPrevious ()
 Jump to previous bookmark. More...
 
bool setLoop (bool b)
 tries to set the loop between the current two indices More...
 
BookmarksBase::CreationStatus create ()
 
bool remove (int idx) override
 remove single bookmark from database for current track More...
 
virtual CreationStatus create (Seconds timestamp)
 create a new bookmark for current track and current position More...
 
MetaData metadata () const
 get the current track More...
 
void setMetadata (const MetaData &md)
 
const QList< Bookmarkbookmarks () const
 
void setBookmarks (const QList< Bookmark > bookmarks)
 
int count ()
 
void add (const Bookmark &bookmark)
 
void clear ()
 
const Bookmarkbookmark (int idx) const
 
Bookmarkbookmark (int idx)
 
void sort ()
 

Detailed Description

The Bookmarks logic class.

Member Function Documentation

◆ create()

virtual CreationStatus BookmarksBase::create ( Seconds  timestamp)
virtualinherited

create a new bookmark for current track and current position

Returns
true if successful, else false

◆ jumpNext()

bool Bookmarks::jumpNext ( )

Jump to next bookmark.

Returns
true if successful, false else

◆ jumpPrevious()

bool Bookmarks::jumpPrevious ( )

Jump to previous bookmark.

Returns
true if successful, false else

◆ jumpTo()

bool Bookmarks::jumpTo ( int  idx)

Jump to specific bookmark.

Parameters
idxbookmark index
Returns
true if index was valid

◆ metadata()

MetaData BookmarksBase::metadata ( ) const
inherited

get the current track

Returns

◆ remove()

bool Bookmarks::remove ( int  idx)
overridevirtual

remove single bookmark from database for current track

Parameters
idxindex
Returns

Reimplemented from BookmarksBase.

◆ setLoop()

bool Bookmarks::setLoop ( bool  b)

tries to set the loop between the current two indices

Parameters
bswitch loop on or off
Returns
false if the two current indices are invalid or if b == false. True else

◆ sigBookmarksChanged

void Bookmarks::sigBookmarksChanged ( )
signal

emitted when bookmarks have changed

Parameters
bookmarksnew bookmarks

◆ sigNextChanged

void Bookmarks::sigNextChanged ( const Bookmark bm)
signal

next bookmark has changed

Parameters
bmnew bookmark. Check for Bookmark::is_valid()

◆ sigPreviousChanged

void Bookmarks::sigPreviousChanged ( const Bookmark bm)
signal

previous bookmark has changed

Parameters
bmnew bookmark. Check for Bookmark::is_valid()