Evince View Library Reference Manual: ev-view

## ev-view ev-view |

## Synopsis

                        EvView;
                        EvViewClass;
    GtkWidget *         ev_view_new                         (void);
    void                ev_view_set_model                   (EvView *view,
                                                             EvDocumentModel *model);
    gboolean            ev_view_is_loading                  (EvView *view);
    void                ev_view_reload                      (EvView *view);
    void                ev_view_copy                        (EvView *view);
    void                ev_view_copy_link_address           (EvView *view,
                                                             EvLinkAction *action);
    void                ev_view_select_all                  (EvView *view);
    gboolean            ev_view_get_has_selection           (EvView *view);
    gboolean            ev_view_can_zoom_in                 (EvView *view);
    void                ev_view_zoom_in                     (EvView *view);
    gboolean            ev_view_can_zoom_out                (EvView *view);
    void                ev_view_zoom_out                    (EvView *view);
    void                ev_view_find_next                   (EvView *view);
    void                ev_view_find_previous               (EvView *view);
    void                ev_view_find_search_changed         (EvView *view);
    void                ev_view_find_set_highlight_search   (EvView *view,
                                                             gboolean value);
    void                ev_view_find_started                (EvView *view,
                                                             EvJobFind *job);
    void                ev_view_find_cancel                 (EvView *view);
    void                ev_view_find_set_result             (EvView *view,
                                                             gint page,
                                                             gint result);
    void                ev_view_highlight_forward_search    (EvView *view,
                                                             EvSourceLink *link);
    void                ev_view_hide_cursor                 (EvView *view);
    void                ev_view_show_cursor                 (EvView *view);
    void                ev_view_handle_link                 (EvView *view,
                                                             EvLink *link);
    gboolean            ev_view_next_page                   (EvView *view);
    gboolean            ev_view_previous_page               (EvView *view);
    void                ev_view_autoscroll_start            (EvView *view);
    void                ev_view_autoscroll_stop             (EvView *view);
    void                ev_view_begin_add_annotation        (EvView *view,
                                                             EvAnnotationType annot_type);
    void                ev_view_cancel_add_annotation       (EvView *view);
    void                ev_view_focus_annotation            (EvView *view,
                                                             EvMapping *annot_mapping);
    gboolean            ev_view_get_page_extents            (EvView *view,
                                                             gint page,
                                                             GdkRectangle *page_area,
                                                             GtkBorder *border);
    void                ev_view_set_page_cache_size         (EvView *view,
                                                             gsize cache_size);
    gboolean            ev_view_is_caret_navigation_enabled (EvView *view);
    void                ev_view_set_caret_cursor_position   (EvView *view,
                                                             guint page,
                                                             guint offset);
    void                ev_view_set_caret_navigation_enabled
                                                            (EvView *view,
                                                             gboolean enabled);
    gboolean            ev_view_supports_caret_navigation   (EvView *view);

    void                ev_view_set_loading                 (EvView *view,
                                                             gboolean loading);
    void                ev_view_find_changed                (EvView *view,
                                                             GList **results,
                                                             gint page);
    void                ev_view_scroll                      (EvView *view,
                                                             GtkScrollType scroll,
                                                             gboolean horizontal);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkWidget
                   +----GtkContainer
                         +----EvView

## Implemented Interfaces

EvView implements AtkImplementorIface, GtkBuildable and GtkScrollable.

## Properties

      "can-zoom-in"              gboolean              : Read
      "can-zoom-out"             gboolean              : Read
      "is-loading"               gboolean              : Read

## Signals

      "annot-added"                                    : Action
      "cursor-moved"                                   : Run Last
      "external-link"                                  : Action
      "handle-link"                                    : Action
      "layers-changed"                                 : Action
      "move-cursor"                                    : Action
      "popup"                                          : Action
      "scroll"                                         : Action
      "selection-changed"                              : Action
      "sync-source"                                    : Action

## Description

## Details

### EvView

    typedef struct _EvView EvView;

### EvViewClass

    typedef struct _EvViewClass EvViewClass;

### ev_view_new ()

    GtkWidget *         ev_view_new                         (void);

### ev_view_set_model ()

    void                ev_view_set_model                   (EvView *view,
                                                             EvDocumentModel *model);

### ev_view_is_loading ()

    gboolean            ev_view_is_loading                  (EvView *view);

Since 3.8

### ev_view_reload ()

    void                ev_view_reload                      (EvView *view);

### ev_view_copy ()

    void                ev_view_copy                        (EvView *view);

### ev_view_copy_link_address ()

    void                ev_view_copy_link_address           (EvView *view,
                                                             EvLinkAction *action);

### ev_view_select_all ()

    void                ev_view_select_all                  (EvView *view);

### ev_view_get_has_selection ()

    gboolean            ev_view_get_has_selection           (EvView *view);

### ev_view_can_zoom_in ()

    gboolean            ev_view_can_zoom_in                 (EvView *view);

### ev_view_zoom_in ()

    void                ev_view_zoom_in                     (EvView *view);

### ev_view_can_zoom_out ()

    gboolean            ev_view_can_zoom_out                (EvView *view);

### ev_view_zoom_out ()

    void                ev_view_zoom_out                    (EvView *view);

### ev_view_find_next ()

    void                ev_view_find_next                   (EvView *view);

### ev_view_find_previous ()

    void                ev_view_find_previous               (EvView *view);

### ev_view_find_search_changed ()

    void                ev_view_find_search_changed         (EvView *view);

### ev_view_find_set_highlight_search ()

    void                ev_view_find_set_highlight_search   (EvView *view,
                                                             gboolean value);

### ev_view_find_started ()

    void                ev_view_find_started                (EvView *view,
                                                             EvJobFind *job);

Since 3.6

### ev_view_find_cancel ()

    void                ev_view_find_cancel                 (EvView *view);

### ev_view_find_set_result ()

    void                ev_view_find_set_result             (EvView *view,
                                                             gint page,
                                                             gint result);

Since 3.10

### ev_view_highlight_forward_search ()

    void                ev_view_highlight_forward_search    (EvView *view,
                                                             EvSourceLink *link);

### ev_view_hide_cursor ()

    void                ev_view_hide_cursor                 (EvView *view);

### ev_view_show_cursor ()

    void                ev_view_show_cursor                 (EvView *view);

### ev_view_handle_link ()

    void                ev_view_handle_link                 (EvView *view,
                                                             EvLink *link);

### ev_view_next_page ()

    gboolean            ev_view_next_page                   (EvView *view);

### ev_view_previous_page ()

    gboolean            ev_view_previous_page               (EvView *view);

### ev_view_autoscroll_start ()

    void                ev_view_autoscroll_start            (EvView *view);

### ev_view_autoscroll_stop ()

    void                ev_view_autoscroll_stop             (EvView *view);

### ev_view_begin_add_annotation ()

    void                ev_view_begin_add_annotation        (EvView *view,
                                                             EvAnnotationType annot_type);

### ev_view_cancel_add_annotation ()

    void                ev_view_cancel_add_annotation       (EvView *view);

### ev_view_focus_annotation ()

    void                ev_view_focus_annotation            (EvView *view,
                                                             EvMapping *annot_mapping);

### ev_view_get_page_extents ()

    gboolean            ev_view_get_page_extents            (EvView *view,
                                                             gint page,
                                                             GdkRectangle *page_area,
                                                             GtkBorder *border);

### ev_view_set_page_cache_size ()

    void                ev_view_set_page_cache_size         (EvView *view,
                                                             gsize cache_size);

### ev_view_is_caret_navigation_enabled ()

    gboolean            ev_view_is_caret_navigation_enabled (EvView *view);

### ev_view_set_caret_cursor_position ()

    void                ev_view_set_caret_cursor_position   (EvView *view,
                                                             guint page,
                                                             guint offset);

Since 3.10

### ev_view_set_caret_navigation_enabled ()

    void                ev_view_set_caret_navigation_enabled
                                                            (EvView *view,
                                                             gboolean enabled);

Since 3.10

### ev_view_supports_caret_navigation ()

    gboolean            ev_view_supports_caret_navigation   (EvView *view);

Since 3.10

### ev_view_set_loading ()

    void                ev_view_set_loading                 (EvView *view,
                                                             gboolean loading);

### Warning

`ev_view_set_loading` is deprecated and should not be used in newly-written code. 3.8

### ev_view_find_changed ()

    void                ev_view_find_changed                (EvView *view,
                                                             GList **results,
                                                             gint page);

### Warning

`ev_view_find_changed` has been deprecated since version 3.6 and should not be used in newly-written code. Use `ev_view_find_started()` instead

`view` : | an EvView
`results` : | the results as returned by `ev_job_find_get_results()`
`page` : | page index

### ev_view_scroll ()

    void                ev_view_scroll                      (EvView *view,
                                                             GtkScrollType scroll,
                                                             gboolean horizontal);

### Warning

`ev_view_scroll` is deprecated and should not be used in newly-written code. 3.10

`view` : | a EvView

## Property Details

### The `"can-zoom-in"` property

      "can-zoom-in"              gboolean              : Read

Whether the view can be zoomed in further.

Default value: TRUE

Since 3.8

### The `"can-zoom-out"` property

      "can-zoom-out"             gboolean              : Read

Whether the view can be zoomed out further.

Default value: TRUE

Since 3.8

### The `"is-loading"` property

      "is-loading"               gboolean              : Read

Whether the view is loading.

Default value: FALSE

## Signal Details

### The `"annot-added"` signal

    void                user_function                      (EvView       *evview,
                                                            EvAnnotation *arg1,
                                                            gpointer      user_data)      : Action

### The `"cursor-moved"` signal

    void                user_function                      (EvView  *evview,
                                                            gint     arg1,
                                                            gint     arg2,
                                                            gpointer user_data)      : Run Last

### The `"external-link"` signal

    void                user_function                      (EvView  *evview,
                                                            GObject *arg1,
                                                            gpointer user_data)      : Action

`evview` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.

### The `"handle-link"` signal

    void                user_function                      (EvView  *evview,
                                                            GObject *arg1,
                                                            gpointer user_data)      : Action

`evview` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.

### The `"layers-changed"` signal

    void                user_function                      (EvView  *evview,
                                                            gpointer user_data)      : Action

### The `"move-cursor"` signal

    gboolean            user_function                      (EvView         *evview,
                                                            GtkMovementStep arg1,
                                                            gint            arg2,
                                                            gboolean        arg3,
                                                            gpointer        user_data)      : Action

### The `"popup"` signal

    void                user_function                      (EvView  *evview,
                                                            gpointer arg1,
                                                            gpointer user_data)      : Action

`evview` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.

### The `"scroll"` signal

    void                user_function                      (EvView        *evview,
                                                            GtkScrollType  arg1,
                                                            GtkOrientation arg2,
                                                            gpointer       user_data)      : Action

### The `"selection-changed"` signal

    void                user_function                      (EvView  *evview,
                                                            gpointer user_data)      : Action

`evview` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.

### The `"sync-source"` signal

    void                user_function                      (EvView  *evview,
                                                            gpointer arg1,
                                                            gpointer user_data)      : Action