zathura/zathura.h
Sebastian Ramacher 8b701f609c Finish renaming
Signed-off-by: Sebastian Ramacher <sebastian+dev@ramacher.at>
2014-01-12 22:23:29 +01:00

444 lines
9.9 KiB
C

/* See LICENSE file for license and copyright information */
#ifndef ZATHURA_H
#define ZATHURA_H
#include <stdbool.h>
#include <girara/types.h>
#include <gtk/gtk.h>
#include <gtk/gtkx.h>
#include "macros.h"
#include "types.h"
enum {
NEXT,
PREVIOUS,
LEFT,
RIGHT,
UP,
DOWN,
BOTTOM,
TOP,
HIDE,
HIGHLIGHT,
DELETE_LAST_WORD,
DELETE_LAST_CHAR,
DEFAULT,
ERROR,
WARNING,
NEXT_GROUP,
PREVIOUS_GROUP,
ZOOM_IN,
ZOOM_OUT,
ZOOM_ORIGINAL,
ZOOM_SPECIFIC,
FORWARD,
BACKWARD,
CONTINUOUS,
DELETE_LAST,
EXPAND,
EXPAND_ALL,
COLLAPSE_ALL,
COLLAPSE,
TOGGLE,
SELECT,
GOTO_DEFAULT,
GOTO_LABELS,
GOTO_OFFSET,
HALF_UP,
HALF_DOWN,
FULL_UP,
FULL_DOWN,
HALF_LEFT,
HALF_RIGHT,
FULL_LEFT,
FULL_RIGHT,
NEXT_CHAR,
PREVIOUS_CHAR,
DELETE_TO_LINE_START,
APPEND_FILEPATH,
ROTATE_CW,
ROTATE_CCW,
PAGE_BOTTOM,
PAGE_TOP
};
/* unspecified page number */
enum {
ZATHURA_PAGE_NUMBER_UNSPECIFIED = INT_MIN
};
/* cache constants */
enum {
ZATHURA_PAGE_CACHE_DEFAULT_SIZE = 15,
ZATHURA_PAGE_CACHE_MAX_SIZE = 1024
};
/* forward declaration for types from database.h */
typedef struct _ZathuraDatabase zathura_database_t;
/**
* Jump
*/
typedef struct zathura_jump_s
{
unsigned int page;
double x;
double y;
} zathura_jump_t;
struct zathura_s
{
struct
{
girara_session_t* session; /**< girara interface session */
struct
{
girara_statusbar_item_t* buffer; /**< buffer statusbar entry */
girara_statusbar_item_t* file; /**< file statusbar entry */
girara_statusbar_item_t* page_number; /**< page number statusbar entry */
} statusbar;
struct
{
GdkRGBA highlight_color; /**< Color for highlighting */
GdkRGBA highlight_color_active; /** Color for highlighting */
GdkRGBA render_loading_bg; /**< Background color for render "Loading..." */
GdkRGBA render_loading_fg; /**< Foreground color for render "Loading..." */
} colors;
GtkWidget *page_widget_alignment;
GtkWidget *page_widget; /**< Widget that contains all rendered pages */
GtkWidget *index; /**< Widget to show the index of the document */
} ui;
struct
{
ZathuraRenderer* render_thread; /**< The thread responsible for rendering the pages */
} sync;
struct
{
void* manager; /**< Plugin manager */
} plugins;
struct
{
gchar* config_dir; /**< Path to the configuration directory */
gchar* data_dir; /**< Path to the data directory */
} config;
struct
{
bool enabled;
gchar* editor;
} synctex;
struct
{
GtkPrintSettings* settings; /**< Print settings */
GtkPageSetup* page_setup; /**< Saved page setup */
} print;
struct
{
int search_direction; /**< Current search direction (FORWARD or BACKWARD) */
girara_list_t* marks; /**< Marker */
char** arguments; /**> Arguments that were passed at startup */
} global;
struct
{
girara_mode_t normal; /**< Normal mode */
girara_mode_t fullscreen; /**< Fullscreen mode */
girara_mode_t index; /**< Index mode */
girara_mode_t insert; /**< Insert mode */
girara_mode_t presentation; /**< Presentation mode */
} modes;
struct
{
gchar* file; /**< bookmarks file */
girara_list_t* bookmarks; /**< bookmarks */
} bookmarks;
struct
{
girara_list_t* list;
girara_list_iterator_t *cur;
unsigned int size;
unsigned int max_size;
} jumplist;
struct
{
guint refresh_view;
} signals;
struct
{
gchar* file;
} stdin_support;
zathura_document_t* document; /**< The current document */
GtkWidget** pages; /**< The page widgets */
zathura_database_t* database; /**< The database */
ZathuraDbus* dbus; /**< D-Bus service */
/**
* File monitor
*/
struct {
GFileMonitor* monitor; /**< File monitor */
GFile* file; /**< File for file monitor */
gchar* file_path; /**< Save file path */
gchar* password; /**< Save password */
} file_monitor;
/**
* Bisect stage
*/
struct {
unsigned int last_jump; /**< Page jumped to by bisect */
unsigned int start; /**< Bisection range - start */
unsigned int end; /**< Bisection range - end */
} bisect;
};
/**
* Creates a zathura session
*
* @return zathura session object or NULL if zathura could not be creeated
*/
zathura_t* zathura_create(void);
/**
* Initializes zathura
*
* @param zathura The zathura session
* @return true if initialization has been successful
*/
bool zathura_init(zathura_t* zathura);
/**
* Free zathura session
*
* @param zathura The zathura session
*/
void zathura_free(zathura_t* zathura);
/**
* Set parent window id
*
* @param zathura The zathura session
* @param xid The window id
*/
void zathura_set_xid(zathura_t* zathura, Window xid);
/**
* Set the path to the configuration directory
*
* @param zathura The zathura session
* @param dir Directory path
*/
void zathura_set_config_dir(zathura_t* zathura, const char* dir);
/**
* Set the path to the data directory
*
* @param zathura The zathura session
* @param dir Directory path
*/
void zathura_set_data_dir(zathura_t* zathura, const char* dir);
/**
* Set the path to the plugin directory
*
* @param zathura The zathura session
* @param dir Directory path
*/
void zathura_set_plugin_dir(zathura_t* zathura, const char* dir);
/**
* Enables synctex support and sets the synctex editor command
*
* @param zathura The zathura session
* @param command Synctex editor command
*/
void zathura_set_synctex_editor_command(zathura_t* zathura, const char* command);
/**
* En/Disable zathuras synctex support
*
* @param zathura The zathura session
* @param value The value
*/
void zathura_set_synctex(zathura_t* zathura, bool value);
/**
* Sets the program parameters
*
* @param zathura The zathura session
* @param argv List of arguments
*/
void zathura_set_argv(zathura_t* zathura, char** argv);
/**
* Opens a file
*
* @param zathura The zathura session
* @param path The path to the file
* @param password The password of the file
*
* @return If no error occured true, otherwise false, is returned.
*/
bool document_open(zathura_t* zathura, const char* path, const char* password,
int page_number);
/**
* Opens a file (idle)
*
* @param zathura The zathura session
* @param path The path to the file
* @param password The password of the file
*/
void document_open_idle(zathura_t* zathura, const char* path,
const char* password, int page_number);
/**
* Save a open file
*
* @param zathura The zathura session
* @param path The path
* @param overwrite Overwrite existing file
*
* @return If no error occured true, otherwise false, is returned.
*/
bool document_save(zathura_t* zathura, const char* path, bool overwrite);
/**
* Closes the current opened document
*
* @param zathura The zathura session
* @param keep_monitor Set to true if monitor should be kept (sc_reload)
* @return If no error occured true, otherwise false, is returned.
*/
bool document_close(zathura_t* zathura, bool keep_monitor);
/**
* Opens the page with the given number
*
* @param zathura The zathura session
* @param page_id The id of the page that should be set
* @return If no error occured true, otherwise false, is returned.
*/
bool page_set(zathura_t* zathura, unsigned int page_id);
/**
* Moves to the given position
*
* @param zathura Zathura session
* @param position_x X coordinate
* @param position_y Y coordinate
* @return If no error occured true, otherwise false, is returned.
*/
bool position_set(zathura_t* zathura, double position_x, double position_y);
/**
* Refresh the page view
*
* @param zathura Zathura session
*/
void refresh_view(zathura_t* zathura);
/**
* Recompute the scale according to settings
*
* @param zathura Zathura session
*/
bool adjust_view(zathura_t* zathura);
/**
* Builds the box structure to show the rendered pages
*
* @param zathura The zathura session
* @param page_padding padding in pixels between pages
* @param pages_per_row Number of shown pages per row
* @param first_page_column Column on which first page start
*/
void page_widget_set_mode(zathura_t* zathura, unsigned int page_padding,
unsigned int pages_per_row, unsigned int first_page_column);
/**
* Updates the page number in the statusbar. Note that 1 will be added to the
* displayed number
*
* @param zathura The zathura session
*/
void statusbar_page_number_update(zathura_t* zathura);
/**
* Checks whether current jump has a previous jump
*
* @param zathura The zathura session
* @return true if current jump has a previous jump
*/
bool zathura_jumplist_has_previous(zathura_t* zathura);
/**
* Checks whether current jump has a next jump
*
* @param zathura The zathura session
* @return true if current jump has a next jump
*/
bool zathura_jumplist_has_next(zathura_t* zathura);
/**
* Return current jump in the jumplist
*
* @param zathura The zathura session
* @return current jump
*/
zathura_jump_t* zathura_jumplist_current(zathura_t* zathura);
/**
* Move forward in the jumplist
*
* @param zathura The zathura session
*/
void zathura_jumplist_forward(zathura_t* zathura);
/**
* Move backward in the jumplist
*
* @param zathura The zathura session
*/
void zathura_jumplist_backward(zathura_t* zathura);
/**
* Add current page as a new item to the jumplist after current position
*
* @param zathura The zathura session
*/
void zathura_jumplist_add(zathura_t* zathura);
/**
* Trim entries from the beginning of the jumplist to maintain it's maximum size constraint.
*
* @param zathura The zathura session
*/
void zathura_jumplist_trim(zathura_t* zathura);
/**
* Load the jumplist of the specified file
*
* @param zathura The zathura session
* @param file The file whose jumplist is to be loaded
*
* return A linked list of zathura_jump_t structures constituting the jumplist of the specified file, or NULL.
*/
bool zathura_jumplist_load(zathura_t* zathura, const char* file);
#endif // ZATHURA_H