Reference API

Class Hierarchy

File Hierarchy

Full API

Namespaces

• Namespace kiwix
  • Namespaces
  • Classes
  • Enums
  • Functions
  • Typedefs

• Namespace kiwix::i18n
  • Classes
  • Functions
  • Typedefs

• Namespace pugi

• Namespace std

• Namespace Xapian

• Namespace zim

Classes and Structs

• Struct DownloadedFile
  • Struct Documentation
    • kiwix::DownloadedFile
      • DownloadedFile()
      • success
      • path

• Struct IpAddress
  • Struct Documentation
    • kiwix::IpAddress
      • addr
      • addr6

• Struct Library::Entry
  • Nested Relationships
  • Inheritance Relationships
    • Base Type
  • Struct Documentation
    • kiwix::Library::Entry
      • lastUpdatedRevision

• Class AriaError
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • kiwix::AriaError
      • AriaError()

• Class Book
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • kiwix::Book
      • Illustrations
      • Book()
      • ~Book()
      • update()
      • update()
      • updateFromXml()
      • updateFromOpds()
      • getHumanReadableIdFromPath()
      • readOnly()
      • getId()
      • getPath()
      • isPathValid()
      • getTitle()
      • getDescription()
      • getLanguage()
      • getCommaSeparatedLanguages()
      • getLanguages()
      • getCreator()
      • getPublisher()
      • getDate()
      • getUrl()
      • getName()
      • getCategory()
      • getTags()
      • getTagStr()
      • getTagBool()
      • getFlavour()
      • getOrigId()
      • getArticleCount()
      • getMediaCount()
      • getSize()
      • getFavicon()
      • getFaviconUrl()
      • getFaviconMimeType()
      • getIllustrations()
      • getIllustration()
      • getDownloadId()
      • setReadOnly()
      • setId()
      • setPath()
      • setPathValid()
      • setTitle()
      • setDescription()
      • setLanguage()
      • setCreator()
      • setPublisher()
      • setDate()
      • setUrl()
      • setName()
      • setFlavour()
      • setTags()
      • setOrigId()
      • setArticleCount()
      • setMediaCount()
      • setSize()
      • setDownloadId()
      • m_id
      • m_downloadId
      • m_path
      • m_pathValid
      • m_title
      • m_description
      • m_category
      • m_language
      • m_creator
      • m_publisher
      • m_date
      • m_url
      • m_name
      • m_flavour
      • m_tags
      • m_origId
      • m_articleCount
      • m_mediaCount
      • m_readOnly
      • m_size
      • m_illustrations
      • missingDefaultIllustration
      • kiwix::Book::Illustration
        • getData()
        • width
        • height
        • mimeType
        • url

• Class Book::Illustration
  • Nested Relationships
  • Class Documentation
    • kiwix::Book::Illustration
      • getData()
      • width
      • height
      • mimeType
      • url

• Class Bookmark
  • Class Documentation
    • kiwix::Bookmark
      • Bookmark()
      • Bookmark()
      • ~Bookmark()
      • updateFromXml()
      • getBookId()
      • getBookTitle()
      • getBookName()
      • getBookFlavour()
      • getUrl()
      • getTitle()
      • getLanguage()
      • getDate()
      • setBookId()
      • setBookTitle()
      • setBookName()
      • setBookFlavour()
      • setUrl()
      • setTitle()
      • setLanguage()
      • setDate()
      • m_bookId
      • m_bookTitle
      • m_bookName
      • m_bookFlavour
      • m_url
      • m_title
      • m_language
      • m_date

• Template Class ConcurrentCache
  • Class Documentation
    • kiwix::ConcurrentCache

• Class Download
  • Class Documentation
    • kiwix::Download
      • StatusResult
        • K_ACTIVE
        • K_WAITING
        • K_PAUSED
        • K_ERROR
        • K_COMPLETE
        • K_REMOVED
        • K_UNKNOWN
      • Download()
      • Download()
      • updateStatus()
      • pauseDownload()
      • resumeDownload()
      • cancelDownload()
      • getStatus()
      • getDid()
      • getFollowedBy()
      • getTotalLength()
      • getCompletedLength()
      • getDownloadSpeed()
      • getVerifiedLength()
      • getPath()
      • getUris()
      • mp_aria
      • m_status
      • m_did
      • m_followedBy
      • m_totalLength
      • m_completedLength
      • m_downloadSpeed
      • m_verifiedLength
      • m_uris
      • m_path

• Class Downloader
  • Class Documentation
    • kiwix::Downloader
      • Options
      • Downloader()
      • ~Downloader()
      • close()
      • startDownload()
      • getDownload()
      • getNbDownload()
      • getDownloadIds()

• Class Filter
  • Class Documentation
    • kiwix::Filter
      • Tags
      • Filter()
      • ~Filter()
      • local()
      • remote()
      • valid()
      • acceptTags()
      • rejectTags()
      • category()
      • lang()
      • publisher()
      • creator()
      • maxSize()
      • query()
      • name()
      • flavour()
      • clearLang()
      • clearCategory()
      • hasQuery()
      • getQuery()
      • queryIsPartial()
      • hasName()
      • getName()
      • hasCategory()
      • getCategory()
      • hasLang()
      • getLang()
      • hasPublisher()
      • getPublisher()
      • hasCreator()
      • getCreator()
      • hasFlavour()
      • getFlavour()
      • getAcceptTags()
      • getRejectTags()

• Class HumanReadableNameMapper
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • kiwix::HumanReadableNameMapper
      • HumanReadableNameMapper()
      • ~HumanReadableNameMapper()
      • getNameForId()
      • getIdForName()

• Class GetTranslatedString
  • Class Documentation
    • kiwix::i18n::GetTranslatedString
      • GetTranslatedString()
      • operator()()
      • operator()()

• Class IdNameMapper
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • kiwix::IdNameMapper
      • getNameForId()
      • getIdForName()

• Class KiwixServe
  • Class Documentation
    • kiwix::KiwixServe
      • KiwixServe()
      • ~KiwixServe()
      • run()
      • shutDown()
      • isRunning()
      • getPort()
      • setPort()

• Class Library
  • Nested Relationships
    • Nested Types
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • kiwix::Library
      • Revision
      • BookIdCollection
      • AttributeCounts
      • BookIdSet
      • ~Library()
      • Library()
      • Library()
      • operator=()
      • operator=()
      • addBook()
      • addOrUpdateBook()
      • addBookmark()
      • removeBookmark()
      • migrateBookmarks()
      • migrateBookmarks()
      • migrateBookmarks()
      • getBestTargetBookId()
      • getBestTargetBookId()
      • getBookById()
      • getBookByPath()
      • getBookByIdThreadSafe()
      • getArchiveById()
      • getSearcherById()
      • getSearcherByIds()
      • removeBookById()
      • writeToFile()
      • writeBookmarksToFile()
      • getBookCount()
      • getBooksLanguages()
      • getBooksLanguagesWithCounts()
      • getBooksCategories()
      • getBooksCreators()
      • getBooksPublishers()
      • getBookmarks()
      • getBooksIds()
      • filter()
      • sort()
      • getRevision()
      • removeBooksNotUpdatedSince()
      • create()

• Class LibraryManipulator
  • Class Documentation
    • kiwix::LibraryManipulator
      • LibraryManipulator()
      • ~LibraryManipulator()
      • getLibrary()
      • addBookToLibrary()
      • addBookmarkToLibrary()
      • removeBooksNotUpdatedSince()
      • bookWasAddedToLibrary()
      • bookmarkWasAddedToLibrary()
      • booksWereRemovedFromLibrary()

• Class Manager
  • Class Documentation
    • kiwix::Manager
      • Paths
      • Manager()
      • Manager()
      • readFile()
      • reload()
      • readXml()
      • readOpds()
      • readBookmarkFile()
      • addBookFromPathAndGetId()
      • addBookFromPath()
      • addBooksFromDirectory()
      • writableLibraryPath
      • m_hasSearchResult
      • m_totalBooks
      • m_startIndex
      • m_itemsPerPage
      • readBookFromPath()
      • parseXmlDom()
      • parseOpdsDom()
      • manipulator

• Template Class MultiKeyCache
  • Class Documentation
    • kiwix::MultiKeyCache

• Class NameMapper
  • Inheritance Relationships
    • Derived Types
  • Class Documentation
    • kiwix::NameMapper
      • ~NameMapper()
      • getNameForId()
      • getIdForName()

• Class ParameterizedMessage
  • Class Documentation
    • kiwix::ParameterizedMessage
      • Parameters
      • ParameterizedMessage()
      • getText()
      • getMsgId()
      • getParams()

• Class SearchRenderer
  • Class Documentation
    • kiwix::SearchRenderer
      • SearchRenderer()
      • ~SearchRenderer()
      • setSearchPattern()
      • setSearchBookQuery()
      • setProtocolPrefix()
      • setSearchProtocolPrefix()
      • setPageLength()
      • setUserLang()
      • getHtml()
      • getXml()
      • renderTemplate()
      • beautifyInteger()
      • m_srs
      • searchBookQuery
      • searchPattern
      • protocolPrefix
      • searchProtocolPrefix
      • pageLength
      • estimatedResultCount
      • resultStart
      • userlang

• Class Server
  • Class Documentation
    • kiwix::Server
      • Server()
      • ~Server()
      • start()
      • stop()
      • setRoot()
      • setAddress()
      • setPort()
      • setNbThreads()
      • setMultiZimSearchLimit()
      • setIpConnectionLimit()
      • setVerbose()
      • setIndexTemplateString()
      • setTaskbar()
      • setBlockExternalLinks()
      • setCatalogOnlyMode()
      • setContentServerUrl()
      • setIpMode()
      • getPort()
      • getAddress()
      • getIpMode()
      • getServerAccessUrls()
      • mp_library
      • mp_nameMapper
      • m_root
      • m_addr
      • m_indexTemplateString
      • m_port
      • m_nbThreads
      • m_multizimSearchLimit
      • m_verbose
      • m_withTaskbar
      • m_withLibraryButton
      • m_blockExternalLinks
      • m_ipMode
      • m_ipConnectionLimit
      • m_catalogOnlyMode
      • m_contentServerUrl
      • mp_server

• Class SpellingsDB
  • Class Documentation
    • kiwix::SpellingsDB
      • SpellingsDB()
      • ~SpellingsDB()
      • SpellingsDB()
      • operator=()
      • getSpellingCorrections()

• Class UpdatableNameMapper
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • kiwix::UpdatableNameMapper
      • UpdatableNameMapper()
      • getNameForId()
      • getIdForName()
      • update()

• Class ZimSearcher
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • kiwix::ZimSearcher
      • ZimSearcher()
      • getLock()
      • ~ZimSearcher()

Enums

• Enum IpMode
  • Enum Documentation
    • IpMode
      • IPV4
      • IPV6
      • ALL
      • AUTO

• Enum MigrationMode
  • Enum Documentation
    • MigrationMode
      • UPGRADE_ONLY
      • ALLOW_DOWNGRADE

• Enum supportedListMode
  • Enum Documentation
    • supportedListMode
      • ALL
      • LOCAL
      • REMOTE
      • NOLOCAL
      • NOREMOTE
      • VALID
      • NOVALID

• Enum supportedListSortBy
  • Enum Documentation
    • supportedListSortBy
      • UNSORTED
      • TITLE
      • SIZE
      • DATE
      • CREATOR
      • PUBLISHER

Functions

• Function kiwix::appendToDirectory
  • Function Documentation
    • appendToDirectory()

• Function kiwix::beautifyFileSize
  • Function Documentation
    • beautifyFileSize()

• Function kiwix::computeAbsolutePath
  • Function Documentation
    • computeAbsolutePath()

• Function kiwix::computeRelativePath
  • Function Documentation
    • computeRelativePath()

• Function kiwix::converta2toa3
  • Function Documentation
    • converta2toa3()

• Function kiwix::fileExists
  • Function Documentation
    • fileExists()

• Function kiwix::fileReadable
  • Function Documentation
    • fileReadable()

• Function kiwix::getBestPublicIp
  • Function Documentation
    • getBestPublicIp()

• Function kiwix::getBestPublicIps
  • Function Documentation
    • getBestPublicIps()

• Function kiwix::getCurrentDirectory
  • Function Documentation
    • getCurrentDirectory()

• Function kiwix::getExecutablePath
  • Function Documentation
    • getExecutablePath()

• Function kiwix::getFileContent
  • Function Documentation
    • getFileContent()

• Function kiwix::getLanguageSelfName
  • Function Documentation
    • getLanguageSelfName()

• Function kiwix::getLastPathElement
  • Function Documentation
    • getLastPathElement()

• Function kiwix::getMimeTypeForFile
  • Function Documentation
    • getMimeTypeForFile()

• Function kiwix::getNetworkInterfaces
  • Function Documentation
    • getNetworkInterfaces()

• Function kiwix::getNetworkInterfacesIPv4Or6
  • Function Documentation
    • getNetworkInterfacesIPv4Or6()

• Function kiwix::getSearchUrl
  • Function Documentation
    • getSearchUrl()

• Function kiwix::getSlugifiedFileName
  • Function Documentation
    • getSlugifiedFileName()

• Function kiwix::getTranslatedString
  • Function Documentation
    • getTranslatedString()

• Function kiwix::getVersions
  • Function Documentation
    • getVersions()

• Function kiwix::i18n::expandParameterizedString
  • Function Documentation
    • expandParameterizedString()

• Function kiwix::isRelativePath
  • Function Documentation
    • isRelativePath()

• Function kiwix::nonParameterizedMessage
  • Function Documentation
    • nonParameterizedMessage()

• Function kiwix::printVersions
  • Function Documentation
    • printVersions()

• Function kiwix::readCategoriesFromFeed
  • Function Documentation
    • readCategoriesFromFeed()

• Function kiwix::readLanguagesFromFeed
  • Function Documentation
    • readLanguagesFromFeed()

• Function kiwix::removeLastPathElement
  • Function Documentation
    • removeLastPathElement()

• Function kiwix::sleep
  • Function Documentation
    • sleep()

• Function kiwix::split
  • Function Documentation
    • split()

• Function kiwix::translateBookCategory
  • Function Documentation
    • translateBookCategory()

Defines

• Define DEPRECATED
  • Define Documentation
    • DEPRECATED

• Define KIWIX_LIBRARY_VERSION
  • Define Documentation
    • KIWIX_LIBRARY_VERSION

• Define LIBKIWIX_NODISCARD
  • Define Documentation
    • LIBKIWIX_NODISCARD

Typedefs

• Typedef kiwix::ConstLibraryPtr
  • Typedef Documentation
    • ConstLibraryPtr

• Typedef kiwix::FeedCategories
  • Typedef Documentation
    • FeedCategories

• Typedef kiwix::FeedLanguages
  • Typedef Documentation
    • FeedLanguages

• Typedef kiwix::i18n::Parameters
  • Typedef Documentation
    • Parameters

• Typedef kiwix::LangNameCodePair
  • Typedef Documentation
    • LangNameCodePair

• Typedef kiwix::LibraryPtr
  • Typedef Documentation
    • LibraryPtr

• Typedef kiwix::LibVersions
  • Typedef Documentation
    • LibVersions

• Typedef kiwix::offset_type
  • Typedef Documentation
    • offset_type

• Typedef kiwix::size_type
  • Typedef Documentation
    • size_type