page-widget.h 3.33 KB
Newer Older
1 2 3 4 5 6
/* See LICENSE file for license and copyright information */

#ifndef PAGE_WIDGET_H
#define PAGE_WIDGET_H

#include <gtk/gtk.h>
7
#include "types.h"
8 9 10 11 12 13 14 15 16 17
#include "document.h"

/**
 * The page view widget. The widget handles all the rendering on its own. It
 * only has to be resized. The widget also manages and handles all the
 * rectangles for highlighting.
 *
 * Before the properties contain the correct values, 'draw-links' has to be set
 * to TRUE at least one time.
 * */
Sebastian Ramacher's avatar
Sebastian Ramacher committed
18 19
struct zathura_page_widget_s
{
20 21 22
  GtkDrawingArea parent;
};

Sebastian Ramacher's avatar
Sebastian Ramacher committed
23 24
struct zathura_page_widget_class_s
{
25 26 27
  GtkDrawingAreaClass parent_class;
};

Sebastian Ramacher's avatar
Sebastian Ramacher committed
28 29 30 31 32 33 34 35 36 37 38
#define ZATHURA_TYPE_PAGE (zathura_page_widget_get_type())
#define ZATHURA_PAGE(obj)                                                      \
  (G_TYPE_CHECK_INSTANCE_CAST((obj), ZATHURA_TYPE_PAGE, ZathuraPage))
#define ZATHURA_PAGE_CLASS(obj)                                                \
  (G_TYPE_CHECK_CLASS_CAST((obj), ZATHURA_TYPE_PAGE, ZathuraPageClass))
#define ZATHURA_IS_PAGE(obj)                                                   \
  (G_TYPE_CHECK_INSTANCE_TYPE((obj), ZATHURA_TYPE_PAGE))
#define ZATHURA_IS_PAGE_CLASS(obj)                                             \
  (G_TYPE_CHECK_CLASS_TYPE((obj), ZATHURA_TYPE_PAGE))
#define ZATHURA_PAGE_GET_CLASS(obj)                                            \
  (G_TYPE_INSTANCE_GET_CLASS((obj), ZATHURA_TYPE_PAGE, ZathuraPageClass))
39 40 41 42 43 44 45 46

/**
 * Returns the type of the page view widget.
 * @return the type
 */
GType zathura_page_widget_get_type(void);
/**
 * Create a page view widget.
47
 * @param zathura the zathura instance
48 49 50
 * @param page the page to be displayed
 * @return a page view widget
 */
51
GtkWidget* zathura_page_widget_new(zathura_t* zathura, zathura_page_t* page);
52 53 54 55 56
/**
 * Update the widget's surface. This should only be called from the render
 * thread.
 * @param widget the widget
 * @param surface the new surface
57
 * @param keep_thumbnail don't destroy when surface is NULL
58
 */
59
void zathura_page_widget_update_surface(ZathuraPage* widget, cairo_surface_t* surface, bool keep_thumbnail);
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
/**
 * Draw a rectangle to mark links or search results
 * @param widget the widget
 * @param rectangle the rectangle
 * @param linkid the link id if it's a link, -1 otherwise
 */
void zathura_page_widget_draw_rectangle(ZathuraPage* widget, zathura_rectangle_t* rectangle, int linkid);
/**
 * Clear all rectangles.
 * @param widget the widget
 */
void zathura_page_widget_clear_rectangles(ZathuraPage* widget);
/**
 * Returns the zathura link object at the given index
 *
 * @param widget the widget
 * @param index Index of the link
77
 * @return Link object or NULL if an error occurred
78 79
 */
zathura_link_t* zathura_page_widget_link_get(ZathuraPage* widget, unsigned int index);
80 81 82 83 84 85
/**
 * Update the last view time of the page.
 *
 * @param widget the widget
 */
void zathura_page_widget_update_view_time(ZathuraPage* widget);
86 87 88 89 90 91 92
/**
 * Check if we have a surface.
 *
 * @param widget the widget
 * @returns true if the widget has a surface, false otherwise
 */
bool zathura_page_widget_have_surface(ZathuraPage* widget);
93 94 95 96 97 98
/**
 * Abort outstanding render requests
 *
 * @param widget the widget
 */
void zathura_page_widget_abort_render_request(ZathuraPage* widget);
99 100 101 102 103 104 105
/**
 * Get underlying page
 *
 * @param widget the widget
 * @return underlying zathura_page_t instance
 */
zathura_page_t* zathura_page_widget_get_page(ZathuraPage* widget);
106

107
#endif