smallsolar/libkiwix
1
0
Fork 0
mirror of https://github.com/kiwix/libkiwix.git synced 2025-06-26 10:11:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Library::BookIdCollection typedef

Browse Source
This commit is contained in:
Veloman Yunkan
2021-03-06 20:13:43 +04:00
committed by Matthieu Gautier
parent a20f9e2ce1
commit db06b2c7ca
2 changed files with 16 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
include/library.h
View File

@ -122,6 +122,9 @@ class Library
std::map<std::string, std::shared_ptr<Reader>> m_readers;
std::vector<kiwix::Bookmark> m_bookmarks;
public:
typedef std::vector<std::string> BookIdCollection;
public:
Library();
~Library();
@ -224,7 +227,7 @@ class Library
*
* @return A list of book ids.
*/
std::vector<std::string> getBooksIds();
BookIdCollection getBooksIds();
/**
* Filter the library and generate a new one with the keep elements.
@ -234,7 +237,7 @@ class Library
* @param search List only books with search in the title or description.
* @return The list of bookIds corresponding to the query.
*/
DEPRECATED std::vector<std::string> filter(const std::string& search);
DEPRECATED BookIdCollection filter(const std::string& search);
/**
@ -243,7 +246,7 @@ class Library
* @param filter The filter to use.
* @return The list of bookIds corresponding to the filter.
*/
std::vector<std::string> filter(const Filter& filter);
BookIdCollection filter(const Filter& filter);
/**
@ -253,7 +256,7 @@ class Library
* @param comparator how to sort the books
* @return The sorted list of books
*/
void sort(std::vector<std::string>& bookIds, supportedListSortBy sortBy, bool ascending);
void sort(BookIdCollection& bookIds, supportedListSortBy sortBy, bool ascending);
/**
* List books in the library.
@ -277,7 +280,7 @@ class Library
* Set to 0 to cancel this filter.
* @return The list of bookIds corresponding to the query.
*/
DEPRECATED std::vector<std::string> listBooksIds(
DEPRECATED BookIdCollection listBooksIds(
int supportedListMode = ALL,
supportedListSortBy sortBy = UNSORTED,
const std::string& search = "",