Changeset View
Changeset View
Standalone View
Standalone View
src/acbf/AcbfBookinfo.h
Context not available. | |||||
47 | * | 47 | * | ||
---|---|---|---|---|---|
48 | * Annotations in particular are a stringlist of paragraphs. | 48 | * Annotations in particular are a stringlist of paragraphs. | ||
49 | * | 49 | * | ||
50 | * The library handles retrieving title, keywords and annotation when there is no | ||||
51 | * language defined as follows: It checks if there is an entry for "", if not, tries | ||||
52 | * the entry for the first language object, and if that doesn't work, returns the first | ||||
53 | * value it can find. | ||||
54 | * | ||||
50 | * ACBF's language support is further detailed in the Language object. | 55 | * ACBF's language support is further detailed in the Language object. | ||
51 | * | 56 | * | ||
52 | * ACBF can have multiple genres, but they are limited to a list of keys, given | 57 | * ACBF can have multiple genres, but they are limited to a list of keys, given | ||
Context not available. | |||||
124 | * @param middleName - the middle name(s) of the author as a string. | 129 | * @param middleName - the middle name(s) of the author as a string. | ||
125 | * @param lastName - the family name of the author. | 130 | * @param lastName - the family name of the author. | ||
126 | * @param nickName - the nickname of the author. | 131 | * @param nickName - the nickname of the author. | ||
127 | * @param homePage - a homepage url to associate with this author. | 132 | * @param homePages - a homepage url to associate with this author. | ||
128 | * @param email - an email adress to associate with this author. | 133 | * @param emails - an email adress to associate with this author. | ||
129 | */ | 134 | */ | ||
130 | Q_INVOKABLE void addAuthor(QString activity, QString language, QString firstName, QString middleName, QString lastName, QString nickName, QString homePage, QString email); | 135 | Q_INVOKABLE void addAuthor(QString activity, QString language, QString firstName, QString middleName, QString lastName, QString nickName, QStringList homePages, QStringList emails); | ||
131 | /** | 136 | /** | ||
132 | * \brief make changes to an author in the list. | 137 | * \brief make changes to an author in the list. | ||
133 | * @param index - The index of this author in the author list. | 138 | * @param index - The index of this author in the author list. | ||
Context not available. | |||||
138 | * @param middleName - the middle name(s) of the author as a string. | 143 | * @param middleName - the middle name(s) of the author as a string. | ||
139 | * @param lastName - the family name of the author. | 144 | * @param lastName - the family name of the author. | ||
140 | * @param nickName - the nickname of the author. | 145 | * @param nickName - the nickname of the author. | ||
141 | * @param homePage - a homepage url to associate with this author. | 146 | * @param homePages - a homepage url to associate with this author. | ||
142 | * @param email - an email adress to associate with this author. | 147 | * @param emails - an email adress to associate with this author. | ||
143 | */ | 148 | */ | ||
144 | Q_INVOKABLE void setAuthor(int index, QString activity, QString language, QString firstName, QString middleName, QString lastName, QString nickName, QString homePage, QString email); | 149 | Q_INVOKABLE void setAuthor(int index, QString activity, QString language, QString firstName, QString middleName, QString lastName, QString nickName, QStringList homePages, QStringList emails); | ||
145 | /** | 150 | /** | ||
146 | * \brief remove an author in the list. | 151 | * \brief remove an author in the list. | ||
147 | * @param index - the index of the author to remove. | 152 | * @param index - the index of the author to remove. | ||
Context not available. | |||||
183 | * @param title - the title as a QString | 188 | * @param title - the title as a QString | ||
184 | * @param language - the language code in language code, country | 189 | * @param language - the language code in language code, country | ||
185 | * code format joined by a dash (not an underscore). | 190 | * code format joined by a dash (not an underscore). | ||
186 | * TODO: title() defaults to English when no language is given, but setTitle() does not... | | |||
187 | */ | 191 | */ | ||
188 | Q_INVOKABLE void setTitle(QString title, QString language = ""); | 192 | Q_INVOKABLE void setTitle(QString title, QString language = ""); | ||
189 | 193 | | |||
Context not available. | |||||
279 | QStringList keywords(QString language = ""); | 283 | QStringList keywords(QString language = ""); | ||
280 | /** | 284 | /** | ||
281 | * \brief set the list of keywords for the given language. | 285 | * \brief set the list of keywords for the given language. | ||
282 | * @param annotation - A stringlist of keywords | 286 | * @param keywords - A stringlist of keywords | ||
283 | * @param language - The language for which to set the annotation in | 287 | * @param language - The language for which to set the annotation in | ||
284 | * language code, country code format joined by a dash (not an underscore). | 288 | * language code, country code format joined by a dash (not an underscore). | ||
285 | */ | 289 | */ | ||
Context not available. | |||||
291 | Page* coverpage(); | 295 | Page* coverpage(); | ||
292 | /** | 296 | /** | ||
293 | * \brief set a cover page. | 297 | * \brief set a cover page. | ||
294 | * @param newCover | 298 | * @param newCover A page object with the new cover. | ||
295 | */ | 299 | */ | ||
296 | void setCoverpage(Page* newCover); | 300 | void setCoverpage(Page* newCover); | ||
297 | 301 | | |||
Context not available. | |||||
363 | * contentrating system. | 367 | * contentrating system. | ||
364 | */ | 368 | */ | ||
365 | void removeContentRating(ContentRating* contentRating); | 369 | void removeContentRating(ContentRating* contentRating); | ||
370 | | ||||
371 | /** | ||||
372 | * @brief The reading direction for this comic for adjusting the layout. | ||||
373 | * An ACBF 1.2 feature. | ||||
374 | * @return QString with either ltr or rtl. | ||||
375 | */ | ||||
376 | QString readingDirection() const; | ||||
377 | | ||||
378 | /** | ||||
379 | * @brief set the Reading direction for this comic. This indicates | ||||
380 | * how the UI will lay out the buttons and controls. | ||||
381 | * An ACBF 1.2 feature. | ||||
382 | * @param readingDirection a QString with either "ltr" or "rtl". | ||||
383 | */ | ||||
384 | void setReadingDirection(const QString& readingDirection = "ltr"); | ||||
366 | private: | 385 | private: | ||
367 | class Private; | 386 | class Private; | ||
368 | std::unique_ptr<Private> d; | 387 | std::unique_ptr<Private> d; | ||
Context not available. |