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

#include <Bookmarks.h>

Detailed Description

The Bookmarks logic class.

Public Types

enum  CreationStatus : quint8 {
  Success,
  AlreadyThere,
  NoDBTrack,
  DBError,
  OtherError
}
 

Signals

void sig_bookmarks_changed ()
 emitted when bookmarks have changed More...
 
void sig_prev_changed (const Bookmark &bm)
 previous bookmark has changed More...
 
void sig_next_changed (const Bookmark &bm)
 next bookmark has changed More...
 

Public Member Functions

 Bookmarks (QObject *parent=nullptr)
 
QList< Bookmarkget_all_bookmarks () const
 fetch all bookmarks for current track More...
 
Bookmarks::CreationStatus create ()
 create a new bookmark for current track and current position More...
 
bool jump_to (int idx)
 Jump to specific bookmark. More...
 
bool jump_next ()
 Jump to next bookmark. More...
 
bool jump_prev ()
 Jump to previous bookmark. More...
 
bool remove (int idx)
 remove single bookmark from database for current track More...
 
bool set_loop (bool b)
 tries to set the loop between the current two indices More...
 
MetaData get_cur_track () const
 get the current played track More...
 
int get_size () const
 

Member Function Documentation

Bookmarks::CreationStatus Bookmarks::create ( )

create a new bookmark for current track and current position

Returns
true if successful, else false
QList<Bookmark> Bookmarks::get_all_bookmarks ( ) const

fetch all bookmarks for current track

Returns
all bookmarks for current track
MetaData Bookmarks::get_cur_track ( ) const

get the current played track

Returns
return current played track
bool Bookmarks::jump_next ( )

Jump to next bookmark.

Returns
true if successful, false else
bool Bookmarks::jump_prev ( )

Jump to previous bookmark.

Returns
true if successful, false else
bool Bookmarks::jump_to ( int  idx)

Jump to specific bookmark.

Parameters
idxbookmark index
Returns
true if index was valid
bool Bookmarks::remove ( int  idx)

remove single bookmark from database for current track

Parameters
idxindex
Returns
bool Bookmarks::set_loop ( 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
void Bookmarks::sig_bookmarks_changed ( )
signal

emitted when bookmarks have changed

Parameters
bookmarksnew bookmarks
void Bookmarks::sig_next_changed ( const Bookmark bm)
signal

next bookmark has changed

Parameters
bmnew bookmark. Check for Bookmark::is_valid()
void Bookmarks::sig_prev_changed ( const Bookmark bm)
signal

previous bookmark has changed

Parameters
bmnew bookmark. Check for Bookmark::is_valid()
Inheritance diagram for Bookmarks: