Class Book

• Defined in File book.h

Nested Relationships

Nested Types

• Class Book::Illustration

Inheritance Relationships

Derived Type

• public kiwix::LibraryBase::Entry (Struct LibraryBase::Entry)

Class Documentation

class kiwix::Book

A class to store information about a book (a zim file)

Subclassed by kiwix::LibraryBase::Entry

Public Types

typedef std::vector<std::shared_ptr<const Illustration>> Illustrations

Public Functions

Book()

~Book()

bool update(const Book &other)

void update(const Reader &reader)

void update(const zim::Archive &archive)

void updateFromXml(const pugi::xml_node &node, const std::string &baseDir)

void updateFromOpds(const pugi::xml_node &node, const std::string &urlHost)

std::string getHumanReadableIdFromPath() const

inline bool readOnly() const

inline const std::string &getId() const

inline const std::string &getPath() const

inline bool isPathValid() const

inline const std::string &getTitle() const

inline const std::string &getDescription() const

inline const std::string &getLanguage() const

inline const std::string &getCreator() const

inline const std::string &getPublisher() const

inline const std::string &getDate() const

inline const std::string &getUrl() const

inline const std::string &getName() const

std::string getCategory() const

inline const std::string &getTags() const

std::string getTagStr(const std::string &tagName) const

bool getTagBool(const std::string &tagName) const

inline const std::string &getFlavour() const

inline const std::string &getOrigId() const

inline const uint64_t &getArticleCount() const

inline const uint64_t &getMediaCount() const

inline const uint64_t &getSize() const

const std::string &getFavicon() const

const std::string &getFaviconUrl() const

const std::string &getFaviconMimeType() const

Illustrations getIllustrations() const

inline const std::string &getDownloadId() const

inline void setReadOnly(bool readOnly)

inline void setId(const std::string &id)

void setPath(const std::string &path)

inline void setPathValid(bool valid)

inline void setTitle(const std::string &title)

inline void setDescription(const std::string &description)

inline void setLanguage(const std::string &language)

inline void setCreator(const std::string &creator)

inline void setPublisher(const std::string &publisher)

inline void setDate(const std::string &date)

inline void setUrl(const std::string &url)

inline void setName(const std::string &name)

inline void setFlavour(const std::string &flavour)

inline void setTags(const std::string &tags)

inline void setOrigId(const std::string &origId)

inline void setArticleCount(uint64_t articleCount)

inline void setMediaCount(uint64_t mediaCount)

inline void setSize(uint64_t size)

inline void setDownloadId(const std::string &downloadId)

Protected Attributes

std::string m_id

std::string m_downloadId

std::string m_path

bool m_pathValid = false

std::string m_title

std::string m_description

std::string m_category

std::string m_language

std::string m_creator

std::string m_publisher

std::string m_date

std::string m_url

std::string m_name

std::string m_flavour

std::string m_tags

std::string m_origId

uint64_t m_articleCount = 0

uint64_t m_mediaCount = 0

bool m_readOnly = false

uint64_t m_size = 0

Illustrations m_illustrations

Protected Static Attributes

static const Illustration missingDefaultIllustration

class Illustration

Public Functions

const std::string &getData() const

Public Members

uint16_t width = 48

uint16_t height = 48

std::string mimeType

std::string url