MLBookProc 1.3
Loading...
Searching...
No Matches
BookInfo Class Reference

The BookInfo class. More...

#include <BookInfo.h>

Public Member Functions

 BookInfo (const std::shared_ptr< AuxFunc > &af)
 BookInfo constructor.
std::shared_ptr< BookInfoEntryget_book_info (const BookBaseEntry &bbe)
 Retruns information about book.
std::shared_ptr< BookInfoEntrygetBookInfo (const BookBaseEntry &bbe)
 Retruns information about book.
void set_dpi (const double &h_dpi, const double &v_dpi)
 Sets DPI.
void setDpi (const double &h_dpi, const double &v_dpi)
 Sets DPI.

Detailed Description

The BookInfo class.

This class contains methods to get extra information (like annotation, cover, source paper book info, etc) from books.

Constructor & Destructor Documentation

◆ BookInfo()

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

BookInfo constructor.

Parameters
afsmart pointer to AuxFunc object.

Member Function Documentation

◆ get_book_info()

std::shared_ptr< BookInfoEntry > BookInfo::get_book_info ( const BookBaseEntry & bbe)

Retruns information about book.

See also set_dpi().

Deprecated
This method is deprecated and will be removed infuture releases. Use getBookInfo() instead.
Parameters
bbesearch result, returned by BaseKeeper::searchBook() method.
Returns
Smart pointer to BookInfoEntry object containing various information about book.

◆ getBookInfo()

std::shared_ptr< BookInfoEntry > BookInfo::getBookInfo ( const BookBaseEntry & bbe)

Retruns information about book.

See also setDpi().

Parameters
bbesearch result, returned by BaseKeeper::searchBook() method.
Returns
Smart pointer to BookInfoEntry object containing various information about book.

◆ set_dpi()

void BookInfo::set_dpi ( const double & h_dpi,
const double & v_dpi )

Sets DPI.

This method should be called before get_book_info(). It sets DPI to display books cover correctly. Default values are 72.0 and 72.0. It is not compulsory to call this method, but it is highly recommended.

Parameters
h_dpihorizontal HREF="https://en.wikipedia.org/wiki/Dots_per_inch">DPI.
v_dpivertical HREF="https://en.wikipedia.org/wiki/Dots_per_inch">DPI.

◆ setDpi()

void BookInfo::setDpi ( const double & h_dpi,
const double & v_dpi )

Sets DPI.

This method should be called before getBookInfo(). It sets DPI to display books cover correctly. Default values are 72.0 and 72.0. It is not compulsory to call this method, but it is highly recommended.

Parameters
h_dpihorizontal HREF="https://en.wikipedia.org/wiki/Dots_per_inch">DPI.
v_dpivertical HREF="https://en.wikipedia.org/wiki/Dots_per_inch">DPI.