src/gtk-tpdfv.h

   1 /*
   2  * tpdfview - src/gtk-tpdfv.h
   3  * Copyright (C) 2011 Sebastian 'tokkee' Harl <sh@tokkee.org>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  17  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  18  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
  19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /*
  29  * This module provides a Gtk widget to display PDF files.
  30  */
  31
  32 #ifndef GTK_TPDFV_H
  33 #define GTK_TPDFV_H 1
  34
  35 #include <gtk/gtk.h>
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 #define GTK_TYPE_TPDFV (gtk_tpdfv_get_type())
  42 #define GTK_TPDFV(obj) \
  43         (G_TYPE_CHECK_INSTANCE_CAST((obj), GTK_TYPE_TPDFV, GtkTPDFV))
  44 #define GTK_TPDFV_CLASS(obj) \
  45         (G_TYPE_CHECK_CLASS_CAST((obj), GTK_TYPE_TPDFV, GtkTPDFVClass))
  46 #define GTK_IS_TPDFV(obj) \
  47         (G_TYPE_CHECK_INSTANCE_TYPE((obj), GTK_TYPE_TPDFV))
  48 #define GTK_IS_TPDFV_CLASS(obj) \
  49         (G_TYPE_CHECK_CLASS_TYPE((obj), GTK_TYPE_TPDFV))
  50 #define GTK_TPDFV_GET_CLASS(obj) \
  51         (G_TYPE_INSTANCE_GET_CLASS((obj), GTK_TYPE_TPDFV, GtkTPDFVClass))
  52
  53 typedef struct {
  54         GtkDrawingArea graph;
  55 } GtkTPDFV;
  56
  57 typedef struct {
  58         GtkDrawingAreaClass parent_class;
  59 } GtkTPDFVClass;
  60
  61 /*
  62  * gtk_tpdfv_new:
  63  * Creates a new GtkTPDFV widget to display the specified PDF file.
  64  */
  65 GtkWidget *
  66 gtk_tpdfv_new(const char *filename);
  67
  68 /*
  69  * gtk_tpdfv_reload:
  70  * Reload the previously opened PDF file.
  71  */
  72 void
  73 gtk_tpdfv_reload(GtkWidget *widget);
  74
  75 /*
  76  * gtk_tpdfv_page_up, gtk_tpdfv_page_down,
  77  * gtk_tpdfv_first_page, gtk_tpdfv_last_page:
  78  * Navigation.
  79  */
  80 void
  81 gtk_tpdfv_page_up(GtkWidget *widget);
  82 void
  83 gtk_tpdfv_page_down(GtkWidget *widget);
  84 void
  85 gtk_tpdfv_first_page(GtkWidget *widget);
  86 void
  87 gtk_tpdfv_last_page(GtkWidget *widget);
  88
  89 /*
  90  * gtk_tpdfv_zoom_in, gtk_tpdfv_zoom_out,
  91  * gtk_tpdfv_zoom_1:
  92  * Zooming.
  93  */
  94 void
  95 gtk_tpdfv_zoom_in(GtkWidget *widget);
  96 void
  97 gtk_tpdfv_zoom_out(GtkWidget *widget);
  98 void
  99 gtk_tpdfv_zoom_1(GtkWidget *widget);
 100 void
 101 gtk_tpdfv_zoom_width(GtkWidget *widget);
 102 void
 103 gtk_tpdfv_zoom_height(GtkWidget *widget);
 104 void
 105 gtk_tpdfv_zoom_fit(GtkWidget *widget);
 106
 107 /*
 108  * gtk_tpdfv_scroll_up, gtk_tpdfv_scroll_down,
 109  * gtk_tpdfv_scroll_left, gtk_tpdfv_scroll_right:
 110  * Scrolling.
 111  */
 112 void
 113 gtk_tpdfv_scroll_up(GtkWidget *widget);
 114 void
 115 gtk_tpdfv_scroll_down(GtkWidget *widget);
 116 void
 117 gtk_tpdfv_scroll_left(GtkWidget *widget);
 118 void
 119 gtk_tpdfv_scroll_right(GtkWidget *widget);
 120
 121 /*
 122  * Screen handling.
 123  */
 124
 125 struct gtk_tpdfv_screens;
 126 typedef struct gtk_tpdfv_screens gtk_tpdfv_screens_t;
 127
 128 /*
 129  * gtk_tpdfv_get_screens:
 130  * Get a list of available screens.
 131  */
 132 gtk_tpdfv_screens_t *
 133 gtk_tpdfv_screens_init(const gchar *display_name);
 134 void
 135 gtk_tpdfv_screens_destroy(gtk_tpdfv_screens_t *screens);
 136
 137 /*
 138  * gtk_tpdfv_screens_number:
 139  * Get the number of screens.
 140  */
 141 gint
 142 gtk_tpdfv_screens_number(const gtk_tpdfv_screens_t *screens);
 143
 144 /*
 145  * gtk_tpdfv_screens_window_set, gtk_tpdfv_screens_window_get:
 146  * Set or get the screen of a window.
 147  */
 148 void
 149 gtk_tpdfv_screens_window_set(const gtk_tpdfv_screens_t *screens,
 150                 GtkWindow *window, gint screen);
 151 gint
 152 gtk_tpdfv_screens_window_get(const gtk_tpdfv_screens_t *screens,
 153                 GtkWindow *window);
 154
 155 #ifdef __cplusplus
 156 } /* extern "C" */
 157 #endif
 158
 159 #endif /* ! GTK_TPDFV_H */
 160
 161 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 162