mirrors/zathura
1
0
Fork 0
mirror of https://git.pwmt.org/pwmt/zathura.git synced 2024-11-14 07:33:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

document bookmark functions

Browse Source
This commit is contained in:
Sebastian Ramacher 2011-09-02 12:04:05 +02:00
parent 30dd00937b
commit 0c48f8267e
1 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
bookmarks.h
View File

@ -14,16 +14,50 @@ struct zathura_bookmark_s
typedef struct zathura_bookmark_s zathura_bookmark_t; typedef struct zathura_bookmark_s zathura_bookmark_t;
/**
* Create a bookmark and add it to the list of bookmarks.
* @param zathura The zathura instance.
* @param id The bookmark's id.
* @param page The bookmark's page.
* @return the bookmark instance or NULL on failure.
*/
zathura_bookmark_t* zathura_bookmark_add(zathura_t* zathura, const gchar* id, unsigned int page); zathura_bookmark_t* zathura_bookmark_add(zathura_t* zathura, const gchar* id, unsigned int page);
/**
* Remove a bookmark from the list of bookmarks.
* @param zathura The zathura instance.
* @param id The bookmark's id.
*/
void zathura_bookmark_remove(zathura_t* zathura, const gchar* id); void zathura_bookmark_remove(zathura_t* zathura, const gchar* id);
/**
* Get bookmark from the list of bookmarks.
* @param zathura The zathura instance.
* @param id The bookmark's id.
* @return The bookmark instance if it exists or NULL otherwise.
*/
zathura_bookmark_t* zathura_bookmark_get(zathura_t* zathura, const gchar* id); zathura_bookmark_t* zathura_bookmark_get(zathura_t* zathura, const gchar* id);
/**
* Free a bookmark instance.
* @param bookmark The bookmark instance.
*/
void zathura_bookmark_free(zathura_bookmark_t* bookmark); void zathura_bookmark_free(zathura_bookmark_t* bookmark);
/**
* Load bookmarks for a specific file.
* @param zathura The zathura instance.
* @param file The file.
* @param true on success, false otherwise
*/
bool zathura_bookmarks_load(zathura_t* zathura, const gchar* file); bool zathura_bookmarks_load(zathura_t* zathura, const gchar* file);
/**
* Save bookmarks for a specific file.
* @param zathura The zathura instance.
* @param file The file.
* @param true on success, false otherwise
*/
bool zathura_bookmarks_save(zathura_t* zathura, const gchar* file); bool zathura_bookmarks_save(zathura_t* zathura, const gchar* file);
#endif // BOOKMARKS_H #endif // BOOKMARKS_H