4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>Evince View Library Reference Manual: ev-view</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="Evince View Library Reference Manual">
8
8
<link rel="up" href="view-view.html" title="Part I. Evince View">
9
9
<link rel="prev" href="libevview-ev-annotation-window.html" title="ev-annotation-window">
10
10
<link rel="next" href="libevview-ev-page-cache.html" title="ev-page-cache">
11
<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
16
<td width="100%" align="left">
17
<a href="#" class="shortcut">Top</a>
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17
<td><a accesskey="p" href="libevview-ev-annotation-window.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="view-view.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
<th width="100%" align="center">Evince View Library Reference Manual</th>
21
<td><a accesskey="n" href="libevview-ev-page-cache.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#libevview-ev-view.synopsis" class="shortcut">Top</a>
19
26
<a href="#libevview-ev-view.description" class="shortcut">Description</a>
25
32
<a href="#libevview-ev-view.properties" class="shortcut">Properties</a>
27
34
<a href="#libevview-ev-view.signals" class="shortcut">Signals</a>
29
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
30
<td><a accesskey="u" href="view-view.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
31
<td><a accesskey="p" href="libevview-ev-annotation-window.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
32
<td><a accesskey="n" href="libevview-ev-page-cache.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
34
37
<div class="refentry">
35
38
<a name="libevview-ev-view"></a><div class="titlepage"></div>
36
39
<div class="refnamediv"><table width="100%"><tr>
151
154
<div class="refsect1">
152
155
<a name="libevview-ev-view.description"></a><h2>Description</h2>
156
157
<div class="refsect1">
157
158
<a name="libevview-ev-view.details"></a><h2>Details</h2>
158
159
<div class="refsect2">
159
160
<a name="EvView-struct"></a><h3>EvView</h3>
160
161
<pre class="programlisting">typedef struct _EvView EvView;</pre>
165
164
<div class="refsect2">
166
165
<a name="EvViewClass"></a><h3>EvViewClass</h3>
167
166
<pre class="programlisting">typedef struct _EvViewClass EvViewClass;</pre>
172
169
<div class="refsect2">
173
170
<a name="ev-view-new"></a><h3>ev_view_new ()</h3>
174
171
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * ev_view_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
179
174
<div class="refsect2">
185
180
<div class="refsect2">
186
181
<a name="ev-view-is-loading"></a><h3>ev_view_is_loading ()</h3>
187
182
<pre class="programlisting"><span class="returnvalue">gboolean</span> ev_view_is_loading (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>);</pre>
183
<div class="variablelist"><table border="0" class="variablelist">
185
<col align="left" valign="top">
189
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
191
<code class="literal">TRUE</code> iff the view is currently loading a document</td>
188
194
<p class="since">Since 3.8</p>
191
197
<div class="refsect2">
192
198
<a name="ev-view-reload"></a><h3>ev_view_reload ()</h3>
193
199
<pre class="programlisting"><span class="returnvalue">void</span> ev_view_reload (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>);</pre>
198
202
<div class="refsect2">
199
203
<a name="ev-view-copy"></a><h3>ev_view_copy ()</h3>
200
204
<pre class="programlisting"><span class="returnvalue">void</span> ev_view_copy (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>);</pre>
205
207
<div class="refsect2">
206
208
<a name="ev-view-copy-link-address"></a><h3>ev_view_copy_link_address ()</h3>
207
209
<pre class="programlisting"><span class="returnvalue">void</span> ev_view_copy_link_address (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>,
208
210
<em class="parameter"><code><a href="../libevdocument/libevdocument-ev-link-action.html#EvLinkAction"><span class="type">EvLinkAction</span></a> *action</code></em>);</pre>
213
213
<div class="refsect2">
214
214
<a name="ev-view-select-all"></a><h3>ev_view_select_all ()</h3>
215
215
<pre class="programlisting"><span class="returnvalue">void</span> ev_view_select_all (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>);</pre>
220
218
<div class="refsect2">
221
219
<a name="ev-view-get-has-selection"></a><h3>ev_view_get_has_selection ()</h3>
222
220
<pre class="programlisting"><span class="returnvalue">gboolean</span> ev_view_get_has_selection (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>);</pre>
227
223
<div class="refsect2">
228
224
<a name="ev-view-can-zoom-in"></a><h3>ev_view_can_zoom_in ()</h3>
229
225
<pre class="programlisting"><span class="returnvalue">gboolean</span> ev_view_can_zoom_in (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>);</pre>
234
228
<div class="refsect2">
235
229
<a name="ev-view-zoom-in"></a><h3>ev_view_zoom_in ()</h3>
236
230
<pre class="programlisting"><span class="returnvalue">void</span> ev_view_zoom_in (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>);</pre>
241
233
<div class="refsect2">
242
234
<a name="ev-view-can-zoom-out"></a><h3>ev_view_can_zoom_out ()</h3>
243
235
<pre class="programlisting"><span class="returnvalue">gboolean</span> ev_view_can_zoom_out (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>);</pre>
248
238
<div class="refsect2">
249
239
<a name="ev-view-zoom-out"></a><h3>ev_view_zoom_out ()</h3>
250
240
<pre class="programlisting"><span class="returnvalue">void</span> ev_view_zoom_out (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>);</pre>
255
243
<div class="refsect2">
256
244
<a name="ev-view-find-next"></a><h3>ev_view_find_next ()</h3>
257
245
<pre class="programlisting"><span class="returnvalue">void</span> ev_view_find_next (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>);</pre>
262
248
<div class="refsect2">
263
249
<a name="ev-view-find-previous"></a><h3>ev_view_find_previous ()</h3>
264
250
<pre class="programlisting"><span class="returnvalue">void</span> ev_view_find_previous (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>);</pre>
269
253
<div class="refsect2">
270
254
<a name="ev-view-find-search-changed"></a><h3>ev_view_find_search_changed ()</h3>
271
255
<pre class="programlisting"><span class="returnvalue">void</span> ev_view_find_search_changed (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>);</pre>
276
258
<div class="refsect2">
277
259
<a name="ev-view-find-set-highlight-search"></a><h3>ev_view_find_set_highlight_search ()</h3>
278
260
<pre class="programlisting"><span class="returnvalue">void</span> ev_view_find_set_highlight_search (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>,
279
261
<em class="parameter"><code><span class="type">gboolean</span> value</code></em>);</pre>
284
264
<div class="refsect2">
300
278
<pre class="programlisting"><span class="returnvalue">void</span> ev_view_find_set_result (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>,
301
279
<em class="parameter"><code><span class="type">gint</span> page</code></em>,
302
280
<em class="parameter"><code><span class="type">gint</span> result</code></em>);</pre>
284
<div class="variablelist"><table border="0" class="variablelist">
286
<col align="left" valign="top">
290
<td><p><span class="term"><em class="parameter"><code>view</code></em> :</span></p></td>
291
<td>a <a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a>
303
295
<p class="since">Since 3.10</p>
312
304
<div class="refsect2">
313
305
<a name="ev-view-hide-cursor"></a><h3>ev_view_hide_cursor ()</h3>
314
306
<pre class="programlisting"><span class="returnvalue">void</span> ev_view_hide_cursor (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>);</pre>
319
309
<div class="refsect2">
320
310
<a name="ev-view-show-cursor"></a><h3>ev_view_show_cursor ()</h3>
321
311
<pre class="programlisting"><span class="returnvalue">void</span> ev_view_show_cursor (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>);</pre>
326
314
<div class="refsect2">
327
315
<a name="ev-view-handle-link"></a><h3>ev_view_handle_link ()</h3>
328
316
<pre class="programlisting"><span class="returnvalue">void</span> ev_view_handle_link (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>,
329
317
<em class="parameter"><code><a href="../libevdocument/libevdocument-ev-link.html#EvLink"><span class="type">EvLink</span></a> *link</code></em>);</pre>
334
320
<div class="refsect2">
335
321
<a name="ev-view-next-page"></a><h3>ev_view_next_page ()</h3>
336
322
<pre class="programlisting"><span class="returnvalue">gboolean</span> ev_view_next_page (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>);</pre>
341
325
<div class="refsect2">
342
326
<a name="ev-view-previous-page"></a><h3>ev_view_previous_page ()</h3>
343
327
<pre class="programlisting"><span class="returnvalue">gboolean</span> ev_view_previous_page (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>);</pre>
348
330
<div class="refsect2">
349
331
<a name="ev-view-autoscroll-start"></a><h3>ev_view_autoscroll_start ()</h3>
350
332
<pre class="programlisting"><span class="returnvalue">void</span> ev_view_autoscroll_start (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>);</pre>
355
335
<div class="refsect2">
356
336
<a name="ev-view-autoscroll-stop"></a><h3>ev_view_autoscroll_stop ()</h3>
357
337
<pre class="programlisting"><span class="returnvalue">void</span> ev_view_autoscroll_stop (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>);</pre>
362
340
<div class="refsect2">
388
366
<a name="ev-view-set-page-cache-size"></a><h3>ev_view_set_page_cache_size ()</h3>
389
367
<pre class="programlisting"><span class="returnvalue">void</span> ev_view_set_page_cache_size (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>,
390
368
<em class="parameter"><code><span class="type">gsize</span> cache_size</code></em>);</pre>
370
Sets the maximum size in bytes that will be used to cache
371
rendered pages. Use 0 to disable caching rendered pages.
374
Note that this limit doesn't affect the current visible page range,
375
which will always be rendered. In order to limit the total memory used
376
you have to use <a class="link" href="libevview-ev-document-model.html#ev-document-model-set-max-scale" title="ev_document_model_set_max_scale ()"><code class="function">ev_document_model_set_max_scale()</code></a> too.
378
<div class="variablelist"><table border="0" class="variablelist">
380
<col align="left" valign="top">
385
<td><p><span class="term"><em class="parameter"><code>view</code></em> :</span></p></td>
387
<a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> instance</td>
390
<td><p><span class="term"><em class="parameter"><code>cache_size</code></em> :</span></p></td>
391
<td>size in bytes</td>
393
397
<div class="refsect2">
400
404
<pre class="programlisting"><span class="returnvalue">void</span> ev_view_set_caret_cursor_position (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>,
401
405
<em class="parameter"><code><span class="type">guint</span> page</code></em>,
402
406
<em class="parameter"><code><span class="type">guint</span> offset</code></em>);</pre>
407
<div class="variablelist"><table border="0" class="variablelist">
409
<col align="left" valign="top">
413
<td><p><span class="term"><em class="parameter"><code>view</code></em> :</span></p></td>
414
<td>a <a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a>
403
418
<p class="since">Since 3.10</p>
408
423
<pre class="programlisting"><span class="returnvalue">void</span> ev_view_set_caret_navigation_enabled
409
424
(<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>,
410
425
<em class="parameter"><code><span class="type">gboolean</span> enabled</code></em>);</pre>
427
Enables or disables caret navigation mode for the document.
429
<div class="variablelist"><table border="0" class="variablelist">
431
<col align="left" valign="top">
436
<td><p><span class="term"><em class="parameter"><code>view</code></em> :</span></p></td>
437
<td>a <a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a>
441
<td><p><span class="term"><em class="parameter"><code>enabled</code></em> :</span></p></td>
442
<td>whether to enable caret navigation mode</td>
411
446
<p class="since">Since 3.10</p>
414
449
<div class="refsect2">
415
450
<a name="ev-view-supports-caret-navigation"></a><h3>ev_view_supports_caret_navigation ()</h3>
416
451
<pre class="programlisting"><span class="returnvalue">gboolean</span> ev_view_supports_caret_navigation (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>);</pre>
452
<div class="variablelist"><table border="0" class="variablelist">
454
<col align="left" valign="top">
459
<td><p><span class="term"><em class="parameter"><code>view</code></em> :</span></p></td>
460
<td>a <a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a>
464
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
465
<td>whether the document supports caret navigation</td>
417
469
<p class="since">Since 3.10</p>
421
473
<a name="ev-view-set-loading"></a><h3>ev_view_set_loading ()</h3>
422
474
<pre class="programlisting"><span class="returnvalue">void</span> ev_view_set_loading (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>,
423
475
<em class="parameter"><code><span class="type">gboolean</span> loading</code></em>);</pre>
424
<div class="warning">
476
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
425
477
<h3 class="title">Warning</h3>
426
478
<p><code class="literal">ev_view_set_loading</code> is deprecated and should not be used in newly-written code. 3.8</p>
432
484
<pre class="programlisting"><span class="returnvalue">void</span> ev_view_find_changed (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>,
433
485
<em class="parameter"><code><span class="type">GList</span> **results</code></em>,
434
486
<em class="parameter"><code><span class="type">gint</span> page</code></em>);</pre>
435
<div class="warning">
487
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
436
488
<h3 class="title">Warning</h3>
437
489
<p><code class="literal">ev_view_find_changed</code> has been deprecated since version 3.6 and should not be used in newly-written code. Use <a class="link" href="libevview-ev-view.html#ev-view-find-started" title="ev_view_find_started ()"><code class="function">ev_view_find_started()</code></a> instead</p>
465
517
<pre class="programlisting"><span class="returnvalue">void</span> ev_view_scroll (<em class="parameter"><code><a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *view</code></em>,
466
518
<em class="parameter"><code><span class="type">GtkScrollType</span> scroll</code></em>,
467
519
<em class="parameter"><code><span class="type">gboolean</span> horizontal</code></em>);</pre>
468
<div class="warning">
520
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
469
521
<h3 class="title">Warning</h3>
470
522
<p><code class="literal">ev_view_scroll</code> is deprecated and should not be used in newly-written code. 3.10</p>
529
581
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *evview,
530
582
<span class="type">GObject</span> *arg1,
531
583
<span class="type">gpointer</span> user_data) : <code class="literal">Action</code></pre>
534
<div class="variablelist"><table border="0" class="variablelist">
536
<col align="left" valign="top">
541
<td><p><span class="term"><em class="parameter"><code>evview</code></em> :</span></p></td>
542
<td>the object which received the signal.</td>
545
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
546
<td>user data set when the signal handler was connected.</td>
552
586
<div class="refsect2">
554
588
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *evview,
555
589
<span class="type">GObject</span> *arg1,
556
590
<span class="type">gpointer</span> user_data) : <code class="literal">Action</code></pre>
559
<div class="variablelist"><table border="0" class="variablelist">
561
<col align="left" valign="top">
566
<td><p><span class="term"><em class="parameter"><code>evview</code></em> :</span></p></td>
567
<td>the object which received the signal.</td>
570
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
571
<td>user data set when the signal handler was connected.</td>
577
593
<div class="refsect2">
594
610
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *evview,
595
611
<span class="type">gpointer</span> arg1,
596
612
<span class="type">gpointer</span> user_data) : <code class="literal">Action</code></pre>
599
<div class="variablelist"><table border="0" class="variablelist">
601
<col align="left" valign="top">
606
<td><p><span class="term"><em class="parameter"><code>evview</code></em> :</span></p></td>
607
<td>the object which received the signal.</td>
610
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
611
<td>user data set when the signal handler was connected.</td>
617
615
<div class="refsect2">
626
624
<a name="EvView-selection-changed"></a><h3>The <code class="literal">"selection-changed"</code> signal</h3>
627
625
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="libevview-ev-view.html#EvView"><span class="type">EvView</span></a> *evview,
628
626
<span class="type">gpointer</span> user_data) : <code class="literal">Action</code></pre>
631
<div class="variablelist"><table border="0" class="variablelist">
633
<col align="left" valign="top">
638
<td><p><span class="term"><em class="parameter"><code>evview</code></em> :</span></p></td>
639
<td>the object which received the signal.</td>
642
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
643
<td>user data set when the signal handler was connected.</td>
649
629
<div class="refsect2">