MLBookProc 1.0
 
Loading...
Searching...
No Matches
BookMarks Class Reference

The BookMarks class. More...

#include <BookMarks.h>

Public Member Functions

 BookMarks (const std::shared_ptr< AuxFunc > &af)
 BookMarks constructor.
 
virtual ~BookMarks ()
 BookMarks destructor.
 
int createBookMark (const std::string &col_name, const BookBaseEntry &bbe)
 Creates bookmark.
 
std::vector< std::tuple< std::string, BookBaseEntry > > getBookMarks ()
 Returns bookmarks.
 
void removeBookMark (const std::string &col_name, const BookBaseEntry &bbe)
 Removes bookmark.
 

Detailed Description

The BookMarks class.

This class keeps and operates collection bookmarks. Path to bookmarks base is "~/.local/share/MyLibrary/BookMarks/bookmarks".

Constructor & Destructor Documentation

◆ BookMarks()

BookMarks::BookMarks ( const std::shared_ptr< AuxFunc > & af)

BookMarks constructor.

Parameters
afsmart pointer to AuxFunc object.

Member Function Documentation

◆ createBookMark()

int BookMarks::createBookMark ( const std::string & col_name,
const BookBaseEntry & bbe )

Creates bookmark.

If bookmark already exists, returns 0, in case of success returns 1, otherwise returns -1.

Parameters
col_namecollection name book came from.
bbeBookBaseEntry got from BaseKeeper::searchBook().
Returns
Error code.

◆ getBookMarks()

std::vector< std::tuple< std::string, BookBaseEntry > > BookMarks::getBookMarks ( )

Returns bookmarks.

Returns
Vector of bookmarks tuples. First element of tuple is collection name, book came from. Second element is book entry.

◆ removeBookMark()

void BookMarks::removeBookMark ( const std::string & col_name,
const BookBaseEntry & bbe )

Removes bookmark.

Parameters
col_namecollection name.
bbebook entry to be removed.