NotesKeeper(3)

Library Functions Manual

NotesKeeper(3)

NAME

NotesKeeper - The NotesKeeper class.

SYNOPSIS

#include <NotesKeeper.h>

Inherits UDBase.

Public Member Functions

NotesKeeper (const std::shared_ptr< MLBookProc > &mlbp)
NotesKeeper constructor. void loadNotesBase (const std::filesystem::path &base_path)
UDBase searchNotes (const UDBElement &book_search_result)
void addNote (const UDBElement &book_search_result, const std::string &note_txt)
void removeNote (const UDBElement &note)

Detailed Description

The NotesKeeper class.

This class keeps notes databse and provides methods to work with it.

Constructor & Destructor Documentation

NotesKeeper::NotesKeeper (const std::shared_ptr< MLBookProc > & mlbp)

NotesKeeper constructor.

Parameters

mlbp Smart pointer to MLBookProc object.

Member Function Documentation

void NotesKeeper::addNote (const UDBElement & book_search_result, const std::string & note_txt)

Creates or edits notes for given book. If note_text is empty, removes notes for given book.

Parameters

book_search_result BookID::BookSearchResult object.
note_txt Note text.

void NotesKeeper::loadNotesBase (const std::filesystem::path & base_path)

Loads notes database to memory.

Parameters

base_path Path to notes database file.

void NotesKeeper::removeNote (const UDBElement & note)

Removes note.

Parameters

note BaseID::BookNote object to be removed from database.

UDBase NotesKeeper::searchNotes (const UDBElement & book_search_result)

Search notes for given book.

Parameters

book_search_result BaseID::BookSearchResult object.

Returns

UDBase object containing BaseID::BookNote objects (if any).

Author

Generated automatically by Doxygen for MLBookProc from the source code.

Version 2.1

MLBookProc