mirror of
https://git.pwmt.org/pwmt/zathura.git
synced 2024-12-29 14:26:00 +01:00
241 lines
6.3 KiB
C
241 lines
6.3 KiB
C
/* See LICENSE file for license and copyright information */
|
|
|
|
#ifndef DOCUMENT_H
|
|
#define DOCUMENT_H
|
|
|
|
#include <cairo.h>
|
|
#include <gtk/gtk.h>
|
|
#include <stdbool.h>
|
|
#include <girara/types.h>
|
|
|
|
#include "zathura.h"
|
|
#include "types.h"
|
|
|
|
/**
|
|
* Meta data entries
|
|
*/
|
|
typedef enum zathura_document_meta_e
|
|
{
|
|
ZATHURA_DOCUMENT_TITLE, /**< Title of the document */
|
|
ZATHURA_DOCUMENT_AUTHOR, /**< Author of the document */
|
|
ZATHURA_DOCUMENT_SUBJECT, /**< Subject of the document */
|
|
ZATHURA_DOCUMENT_KEYWORDS, /**< Keywords of the document */
|
|
ZATHURA_DOCUMENT_CREATOR, /**< Creator of the document */
|
|
ZATHURA_DOCUMENT_PRODUCER, /**< Producer of the document */
|
|
ZATHURA_DOCUMENT_CREATION_DATE, /**< Creation data */
|
|
ZATHURA_DOCUMENT_MODIFICATION_DATE /**< Modification data */
|
|
} zathura_document_meta_t;
|
|
|
|
/**
|
|
* Open the document
|
|
*
|
|
* @param zathura Zathura object
|
|
* @param path Path to the document
|
|
* @param password Password of the document or NULL
|
|
* @return The document object
|
|
*/
|
|
zathura_document_t* zathura_document_open(zathura_t* zathura, const char* path,
|
|
const char* password);
|
|
|
|
/**
|
|
* Free the document
|
|
*
|
|
* @param document
|
|
* @return ZATHURA_ERROR_OK when no error occured, otherwise see
|
|
* zathura_error_t
|
|
*/
|
|
zathura_error_t zathura_document_free(zathura_document_t* document);
|
|
|
|
/**
|
|
* Returns the path of the document
|
|
*
|
|
* @param document The document
|
|
* @return The file path of the document
|
|
*/
|
|
const char* zathura_document_get_path(zathura_document_t* document);
|
|
|
|
/**
|
|
* Returns the password of the document
|
|
*
|
|
* @param document The document
|
|
* @return Returns the password of the document
|
|
*/
|
|
const char* zathura_document_get_password(zathura_document_t* document);
|
|
|
|
/**
|
|
* Returns the page at the given index
|
|
*
|
|
* @param document The document
|
|
* @param index The index of the page
|
|
* @return The page or NULL if an error occured
|
|
*/
|
|
zathura_page_t* zathura_document_get_page(zathura_document_t* document, unsigned int index);
|
|
|
|
/**
|
|
* Returns the number of pages
|
|
*
|
|
* @param document The document
|
|
* @return Number of pages
|
|
*/
|
|
unsigned int zathura_document_get_number_of_pages(zathura_document_t* document);
|
|
|
|
/**
|
|
* Sets the number of pages
|
|
*
|
|
* @param document The document
|
|
* @param number_of_pages Number of pages
|
|
*/
|
|
void zathura_document_set_number_of_pages(zathura_document_t* document, unsigned
|
|
int number_of_pages);
|
|
|
|
/**
|
|
* Returns the current page number
|
|
*
|
|
* @param document The document
|
|
* @return Current page
|
|
*/
|
|
unsigned int zathura_document_get_current_page_number(zathura_document_t* document);
|
|
|
|
/**
|
|
* Sets the number of pages
|
|
*
|
|
* @param document The document
|
|
* @param current_page The current page number
|
|
*/
|
|
void zathura_document_set_current_page_number(zathura_document_t* document, unsigned
|
|
int current_page);
|
|
|
|
/**
|
|
* Returns the current scale value of the document
|
|
*
|
|
* @param document The document
|
|
* @return The current scale value
|
|
*/
|
|
double zathura_document_get_scale(zathura_document_t* document);
|
|
|
|
/**
|
|
* Sets the new scale value of the document
|
|
*
|
|
* @param document The document
|
|
* @param scale The new scale value
|
|
*/
|
|
void zathura_document_set_scale(zathura_document_t* document, double scale);
|
|
|
|
/**
|
|
* Returns the rotation value of zathura (0..360)
|
|
*
|
|
* @param document The document
|
|
* @return The current rotation value
|
|
*/
|
|
unsigned int zathura_document_get_rotation(zathura_document_t* document);
|
|
|
|
/**
|
|
* Sets the new rotation value
|
|
*
|
|
* @param document The document
|
|
* @param rotation The new rotation value
|
|
*/
|
|
void zathura_document_set_rotation(zathura_document_t* document, unsigned int rotation);
|
|
|
|
/**
|
|
* Returns the adjust mode of the document
|
|
*
|
|
* @param document The document
|
|
* @return The adjust mode
|
|
*/
|
|
zathura_adjust_mode_t zathura_document_get_adjust_mode(zathura_document_t* document);
|
|
|
|
/**
|
|
* Sets the new adjust mode of the document
|
|
*
|
|
* @param document The document
|
|
* @param mode The new adjust mode
|
|
*/
|
|
void zathura_document_set_adjust_mode(zathura_document_t* document, zathura_adjust_mode_t mode);
|
|
|
|
/**
|
|
* Returns the page offset of the document
|
|
*
|
|
* @param document The document
|
|
* @return The page offset
|
|
*/
|
|
unsigned int zathura_document_get_page_offset(zathura_document_t* document);
|
|
|
|
/**
|
|
* Sets the new page offset of the document
|
|
*
|
|
* @param document The document
|
|
* @param page_offset The new page offset
|
|
*/
|
|
void zathura_document_set_page_offset(zathura_document_t* document, unsigned int page_offset);
|
|
|
|
/**
|
|
* Returns the private data of the document
|
|
*
|
|
* @param document The document
|
|
* @return The private data or NULL
|
|
*/
|
|
void* zathura_document_get_data(zathura_document_t* document);
|
|
|
|
/**
|
|
* Sets the private data of the document
|
|
*
|
|
* @param document The document
|
|
* @param data The new private data
|
|
*/
|
|
void zathura_document_set_data(zathura_document_t* document, void* data);
|
|
|
|
/**
|
|
* Save the document
|
|
*
|
|
* @param document The document object
|
|
* @param path Path for the saved file
|
|
* @return ZATHURA_ERROR_OK when no error occured, otherwise see
|
|
* zathura_error_t
|
|
*/
|
|
zathura_error_t zathura_document_save_as(zathura_document_t* document, const char* path);
|
|
|
|
/**
|
|
* Generate the document index
|
|
*
|
|
* @param document The document object
|
|
* @param error Set to an error value (see \ref zathura_error_t) if an
|
|
* error occured
|
|
* @return Generated index
|
|
*/
|
|
|
|
girara_tree_node_t* zathura_document_index_generate(zathura_document_t* document, zathura_error_t* error);
|
|
|
|
/**
|
|
* Get list of attachments
|
|
*
|
|
* @param document The document object
|
|
* @param error Set to an error value (see \ref zathura_error_t) if an
|
|
* error occured
|
|
* @return List of attachments
|
|
*/
|
|
girara_list_t* zathura_document_attachments_get(zathura_document_t* document, zathura_error_t* error);
|
|
|
|
/**
|
|
* Save document attachment
|
|
*
|
|
* @param document The document objects
|
|
* @param attachment name of the attachment
|
|
* @param file the target filename
|
|
* @return ZATHURA_ERROR_OK when no error occured, otherwise see
|
|
* zathura_error_t
|
|
*/
|
|
zathura_error_t zathura_document_attachment_save(zathura_document_t* document, const char* attachment, const char* file);
|
|
|
|
/**
|
|
* Returns a string of the requested information
|
|
*
|
|
* @param document The zathura document
|
|
* @param meta The information field
|
|
* @param error Set to an error value (see \ref zathura_error_t) if an
|
|
* error occured
|
|
* @return String or NULL if information could not be retreived
|
|
*/
|
|
char* zathura_document_meta_get(zathura_document_t* document, zathura_document_meta_t meta, zathura_error_t* error);
|
|
|
|
#endif // DOCUMENT_H
|