← Back to branch summary

~ubuntu-branches/ubuntu/trusty/evince/trusty-updates

« back to all changes in this revision

Viewing changes to help/reference/libdocument/html/EvDocument.html

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2013-11-12 12:10:03 UTC
  • mfrom: (1.8.6)
  • Revision ID: package-import@ubuntu.com-20131112121003-cjura8gxxx9w2u7l
Tags: 3.10.2-0ubuntu1
* New upstream version
* debian/patches/git_give_focus_correctly.patch,
  debian/patches/git_correct_page_info.patch,
  debian/patches/git_djvu_segfault.patch:
  - dropped, those changes are in the new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
help/reference/libdocument/html/EvDocument.html
2
2
<html>
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>Evince Document Library Reference Manual: EvDocument</title>
 
5
<title>EvDocument</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="Evince Document Library Reference Manual">
8
8
<link rel="up" href="document-interfaces.html" title="Part I. Document Interfaces">
9
9
<link rel="prev" href="EvAsyncRenderer.html" title="EvAsyncRenderer">
10
10
<link rel="next" href="EvDocumentAnnotations.html" title="EvDocumentAnnotations">
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">
13
13
</head>
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">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="EvAsyncRenderer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="document-interfaces.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 Document Library Reference Manual</th>
 
21
<td><a accesskey="n" href="EvDocumentAnnotations.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#EvDocument.synopsis" class="shortcut">Top</a>
18
25
                   | 
19
26
                  <a href="#EvDocument.description" class="shortcut">Description</a>
20
27
                   | 
21
28
                  <a href="#EvDocument.object-hierarchy" class="shortcut">Object Hierarchy</a>
22
 
</td>
23
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
24
 
<td><a accesskey="u" href="document-interfaces.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
25
 
<td><a accesskey="p" href="EvAsyncRenderer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
26
 
<td><a accesskey="n" href="EvDocumentAnnotations.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
27
 
</tr></table>
 
29
</td></tr>
 
30
</table>
28
31
<div class="refentry">
29
32
<a name="EvDocument"></a><div class="titlepage"></div>
30
33
<div class="refnamediv"><table width="100%"><tr>
54
57
<span class="returnvalue">void</span>                <a class="link" href="EvDocument.html#ev-document-fc-mutex-lock" title="ev_document_fc_mutex_lock ()">ev_document_fc_mutex_lock</a>           (<em class="parameter"><code><span class="type">void</span></code></em>);
55
58
<span class="returnvalue">void</span>                <a class="link" href="EvDocument.html#ev-document-fc-mutex-unlock" title="ev_document_fc_mutex_unlock ()">ev_document_fc_mutex_unlock</a>         (<em class="parameter"><code><span class="type">void</span></code></em>);
56
59
<span class="returnvalue">gboolean</span>            <a class="link" href="EvDocument.html#ev-document-fc-mutex-trylock" title="ev_document_fc_mutex_trylock ()">ev_document_fc_mutex_trylock</a>        (<em class="parameter"><code><span class="type">void</span></code></em>);
57
 
<a class="link" href="EvDocumentInfo.html" title="ev-document-info"><span class="returnvalue">EvDocumentInfo</span></a> *    <a class="link" href="EvDocument.html#ev-document-get-info" title="ev_document_get_info ()">ev_document_get_info</a>                (<em class="parameter"><code><a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a> *document</code></em>);
 
60
<a class="link" href="EvDocumentInfo.html" title="EvDocumentInfo"><span class="returnvalue">EvDocumentInfo</span></a> *    <a class="link" href="EvDocument.html#ev-document-get-info" title="ev_document_get_info ()">ev_document_get_info</a>                (<em class="parameter"><code><a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a> *document</code></em>);
58
61
<span class="returnvalue">gboolean</span>            <a class="link" href="EvDocument.html#ev-document-get-backend-info" title="ev_document_get_backend_info ()">ev_document_get_backend_info</a>        (<em class="parameter"><code><a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a> *document</code></em>,
59
62
                                                         <em class="parameter"><code><a class="link" href="EvDocument.html#EvDocumentBackendInfo" title="struct EvDocumentBackendInfo"><span class="type">EvDocumentBackendInfo</span></a> *info</code></em>);
60
63
<span class="returnvalue">gboolean</span>            <a class="link" href="EvDocument.html#ev-document-load" title="ev_document_load ()">ev_document_load</a>                    (<em class="parameter"><code><a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a> *document</code></em>,
85
88
<span class="returnvalue">void</span>                <a class="link" href="EvDocument.html#ev-document-get-min-page-size" title="ev_document_get_min_page_size ()">ev_document_get_min_page_size</a>       (<em class="parameter"><code><a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a> *document</code></em>,
86
89
                                                         <em class="parameter"><code><span class="type">gdouble</span> *width</code></em>,
87
90
                                                         <em class="parameter"><code><span class="type">gdouble</span> *height</code></em>);
88
 
<a href="/home/carlos/gnome/share/gtk-doc/html/cairo/cairo-cairo-surface-t.html#cairo-surface-t"><span class="returnvalue">cairo_surface_t</span></a> *   <a class="link" href="EvDocument.html#ev-document-render" title="ev_document_render ()">ev_document_render</a>                  (<em class="parameter"><code><a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a> *document</code></em>,
 
91
<span class="returnvalue">cairo_surface_t</span> *   <a class="link" href="EvDocument.html#ev-document-render" title="ev_document_render ()">ev_document_render</a>                  (<em class="parameter"><code><a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a> *document</code></em>,
89
92
                                                         <em class="parameter"><code><a class="link" href="EvRenderContext.html" title="EvRenderContext"><span class="type">EvRenderContext</span></a> *rc</code></em>);
90
93
const <span class="returnvalue">gchar</span> *       <a class="link" href="EvDocument.html#ev-document-get-uri" title="ev_document_get_uri ()">ev_document_get_uri</a>                 (<em class="parameter"><code><a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a> *document</code></em>);
91
94
const <span class="returnvalue">gchar</span> *       <a class="link" href="EvDocument.html#ev-document-get-title" title="ev_document_get_title ()">ev_document_get_title</a>               (<em class="parameter"><code><a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a> *document</code></em>);
152
155
</div>
153
156
<div class="refsect1">
154
157
<a name="EvDocument.description"></a><h2>Description</h2>
155
 
<p>
156
 
</p>
157
158
</div>
158
159
<div class="refsect1">
159
160
<a name="EvDocument.details"></a><h2>Details</h2>
160
161
<div class="refsect2">
161
162
<a name="EvDocument-struct"></a><h3>struct EvDocument</h3>
162
163
<pre class="programlisting">struct EvDocument;</pre>
163
 
<p>
164
 
</p>
165
164
</div>
166
165
<hr>
167
166
<div class="refsect2">
213
212
<a name="EV-DOC-MUTEX-LOCK:CAPS"></a><h3>EV_DOC_MUTEX_LOCK</h3>
214
213
<pre class="programlisting">#define EV_DOC_MUTEX_LOCK (ev_document_doc_mutex_lock ())
215
214
</pre>
216
 
<p>
217
 
</p>
218
215
</div>
219
216
<hr>
220
217
<div class="refsect2">
221
218
<a name="EV-DOC-MUTEX-UNLOCK:CAPS"></a><h3>EV_DOC_MUTEX_UNLOCK</h3>
222
219
<pre class="programlisting">#define EV_DOC_MUTEX_UNLOCK (ev_document_doc_mutex_unlock ())
223
220
</pre>
224
 
<p>
225
 
</p>
226
221
</div>
227
222
<hr>
228
223
<div class="refsect2">
232
227
        EV_DOCUMENT_ERROR_ENCRYPTED
233
228
} EvDocumentError;
234
229
</pre>
235
 
<p>
236
 
</p>
237
230
<div class="variablelist"><table border="0" class="variablelist">
238
231
<colgroup>
239
232
<col align="left" valign="top">
242
235
<tbody>
243
236
<tr>
244
237
<td><p><a name="EV-DOCUMENT-ERROR-INVALID:CAPS"></a><span class="term"><code class="literal">EV_DOCUMENT_ERROR_INVALID</code></span></p></td>
245
 
<td>
246
 
</td>
 
238
<td></td>
247
239
</tr>
248
240
<tr>
249
241
<td><p><a name="EV-DOCUMENT-ERROR-ENCRYPTED:CAPS"></a><span class="term"><code class="literal">EV_DOCUMENT_ERROR_ENCRYPTED</code></span></p></td>
250
 
<td>
251
 
</td>
 
242
<td></td>
252
243
</tr>
253
244
</tbody>
254
245
</table></div>
261
252
        double y;
262
253
};
263
254
</pre>
264
 
<p>
265
 
</p>
266
255
</div>
267
256
<hr>
268
257
<div class="refsect2">
284
273
        gdouble y2;
285
274
};
286
275
</pre>
287
 
<p>
288
 
</p>
289
276
</div>
290
277
<hr>
291
278
<div class="refsect2">
318
305
<div class="refsect2">
319
306
<a name="ev-document-get-doc-mutex"></a><h3>ev_document_get_doc_mutex ()</h3>
320
307
<pre class="programlisting"><span class="returnvalue">GMutex</span> *            ev_document_get_doc_mutex           (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
321
 
<p>
322
 
</p>
323
308
</div>
324
309
<hr>
325
310
<div class="refsect2">
326
311
<a name="ev-document-doc-mutex-lock"></a><h3>ev_document_doc_mutex_lock ()</h3>
327
312
<pre class="programlisting"><span class="returnvalue">void</span>                ev_document_doc_mutex_lock          (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
328
 
<p>
329
 
</p>
330
313
</div>
331
314
<hr>
332
315
<div class="refsect2">
333
316
<a name="ev-document-doc-mutex-unlock"></a><h3>ev_document_doc_mutex_unlock ()</h3>
334
317
<pre class="programlisting"><span class="returnvalue">void</span>                ev_document_doc_mutex_unlock        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
335
 
<p>
336
 
</p>
337
318
</div>
338
319
<hr>
339
320
<div class="refsect2">
340
321
<a name="ev-document-doc-mutex-trylock"></a><h3>ev_document_doc_mutex_trylock ()</h3>
341
322
<pre class="programlisting"><span class="returnvalue">gboolean</span>            ev_document_doc_mutex_trylock       (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
342
 
<p>
343
 
</p>
344
323
</div>
345
324
<hr>
346
325
<div class="refsect2">
347
326
<a name="ev-document-get-fc-mutex"></a><h3>ev_document_get_fc_mutex ()</h3>
348
327
<pre class="programlisting"><span class="returnvalue">GMutex</span> *            ev_document_get_fc_mutex            (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
349
 
<p>
350
 
</p>
351
328
</div>
352
329
<hr>
353
330
<div class="refsect2">
354
331
<a name="ev-document-fc-mutex-lock"></a><h3>ev_document_fc_mutex_lock ()</h3>
355
332
<pre class="programlisting"><span class="returnvalue">void</span>                ev_document_fc_mutex_lock           (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
356
 
<p>
357
 
</p>
358
333
</div>
359
334
<hr>
360
335
<div class="refsect2">
361
336
<a name="ev-document-fc-mutex-unlock"></a><h3>ev_document_fc_mutex_unlock ()</h3>
362
337
<pre class="programlisting"><span class="returnvalue">void</span>                ev_document_fc_mutex_unlock         (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
363
 
<p>
364
 
</p>
365
338
</div>
366
339
<hr>
367
340
<div class="refsect2">
368
341
<a name="ev-document-fc-mutex-trylock"></a><h3>ev_document_fc_mutex_trylock ()</h3>
369
342
<pre class="programlisting"><span class="returnvalue">gboolean</span>            ev_document_fc_mutex_trylock        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
370
 
<p>
371
 
</p>
372
343
</div>
373
344
<hr>
374
345
<div class="refsect2">
375
346
<a name="ev-document-get-info"></a><h3>ev_document_get_info ()</h3>
376
 
<pre class="programlisting"><a class="link" href="EvDocumentInfo.html" title="ev-document-info"><span class="returnvalue">EvDocumentInfo</span></a> *    ev_document_get_info                (<em class="parameter"><code><a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a> *document</code></em>);</pre>
377
 
<p>
378
 
</p>
 
347
<pre class="programlisting"><a class="link" href="EvDocumentInfo.html" title="EvDocumentInfo"><span class="returnvalue">EvDocumentInfo</span></a> *    ev_document_get_info                (<em class="parameter"><code><a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a> *document</code></em>);</pre>
379
348
</div>
380
349
<hr>
381
350
<div class="refsect2">
436
405
                                                         <em class="parameter"><code><a class="link" href="EvDocument.html#EvDocumentLoadFlags"><span class="type">EvDocumentLoadFlags</span></a> flags</code></em>,
437
406
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
438
407
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
408
<p>
 
409
Synchronously loads the document from <em class="parameter"><code>stream</code></em>.
 
410
See <a class="link" href="EvDocument.html#ev-document-load" title="ev_document_load ()"><code class="function">ev_document_load()</code></a> for more information.
 
411
</p>
 
412
<div class="variablelist"><table border="0" class="variablelist">
 
413
<colgroup>
 
414
<col align="left" valign="top">
 
415
<col>
 
416
</colgroup>
 
417
<tbody>
 
418
<tr>
 
419
<td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
 
420
<td>a <a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a>
 
421
</td>
 
422
</tr>
 
423
<tr>
 
424
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
 
425
<td>a <span class="type">GInputStream</span>
 
426
</td>
 
427
</tr>
 
428
<tr>
 
429
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
 
430
<td>flags from <a class="link" href="EvDocument.html#EvDocumentLoadFlags"><span class="type">EvDocumentLoadFlags</span></a>
 
431
</td>
 
432
</tr>
 
433
<tr>
 
434
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
435
<td>a <span class="type">GCancellable</span>, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
436
</td>
 
437
</tr>
 
438
<tr>
 
439
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
440
<td>a <span class="type">GError</span> location to store an error, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
441
</td>
 
442
</tr>
 
443
<tr>
 
444
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
445
<td>
 
446
<code class="literal">TRUE</code> if loading succeeded, or <code class="literal">FALSE</code> on error with <em class="parameter"><code>error</code></em> filled in</td>
 
447
</tr>
 
448
</tbody>
 
449
</table></div>
439
450
<p class="since">Since 3.6</p>
440
451
</div>
441
452
<hr>
446
457
                                                         <em class="parameter"><code><a class="link" href="EvDocument.html#EvDocumentLoadFlags"><span class="type">EvDocumentLoadFlags</span></a> flags</code></em>,
447
458
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
448
459
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
460
<p>
 
461
Synchronously loads the document from <em class="parameter"><code>file</code></em>.
 
462
See <a class="link" href="EvDocument.html#ev-document-load" title="ev_document_load ()"><code class="function">ev_document_load()</code></a> for more information.
 
463
</p>
 
464
<div class="variablelist"><table border="0" class="variablelist">
 
465
<colgroup>
 
466
<col align="left" valign="top">
 
467
<col>
 
468
</colgroup>
 
469
<tbody>
 
470
<tr>
 
471
<td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
 
472
<td>a <a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a>
 
473
</td>
 
474
</tr>
 
475
<tr>
 
476
<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
 
477
<td>a <span class="type">GFile</span>
 
478
</td>
 
479
</tr>
 
480
<tr>
 
481
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
 
482
<td>flags from <a class="link" href="EvDocument.html#EvDocumentLoadFlags"><span class="type">EvDocumentLoadFlags</span></a>
 
483
</td>
 
484
</tr>
 
485
<tr>
 
486
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
487
<td>a <span class="type">GCancellable</span>, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
488
</td>
 
489
</tr>
 
490
<tr>
 
491
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
492
<td>a <span class="type">GError</span> location to store an error, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
493
</td>
 
494
</tr>
 
495
<tr>
 
496
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
497
<td>
 
498
<code class="literal">TRUE</code> if loading succeeded, or <code class="literal">FALSE</code> on error with <em class="parameter"><code>error</code></em> filled in</td>
 
499
</tr>
 
500
</tbody>
 
501
</table></div>
449
502
<p class="since">Since 3.6</p>
450
503
</div>
451
504
<hr>
489
542
<div class="refsect2">
490
543
<a name="ev-document-get-n-pages"></a><h3>ev_document_get_n_pages ()</h3>
491
544
<pre class="programlisting"><span class="returnvalue">gint</span>                ev_document_get_n_pages             (<em class="parameter"><code><a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a> *document</code></em>);</pre>
492
 
<p>
493
 
</p>
494
545
</div>
495
546
<hr>
496
547
<div class="refsect2">
560
611
<a name="ev-document-get-page-label"></a><h3>ev_document_get_page_label ()</h3>
561
612
<pre class="programlisting"><span class="returnvalue">gchar</span> *             ev_document_get_page_label          (<em class="parameter"><code><a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a> *document</code></em>,
562
613
                                                         <em class="parameter"><code><span class="type">gint</span> page_index</code></em>);</pre>
563
 
<p>
564
 
</p>
565
614
</div>
566
615
<hr>
567
616
<div class="refsect2">
573
622
<hr>
574
623
<div class="refsect2">
575
624
<a name="ev-document-render"></a><h3>ev_document_render ()</h3>
576
 
<pre class="programlisting"><a href="/home/carlos/gnome/share/gtk-doc/html/cairo/cairo-cairo-surface-t.html#cairo-surface-t"><span class="returnvalue">cairo_surface_t</span></a> *   ev_document_render                  (<em class="parameter"><code><a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a> *document</code></em>,
 
625
<pre class="programlisting"><span class="returnvalue">cairo_surface_t</span> *   ev_document_render                  (<em class="parameter"><code><a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a> *document</code></em>,
577
626
                                                         <em class="parameter"><code><a class="link" href="EvRenderContext.html" title="EvRenderContext"><span class="type">EvRenderContext</span></a> *rc</code></em>);</pre>
578
 
<p>
579
 
</p>
580
627
</div>
581
628
<hr>
582
629
<div class="refsect2">
627
674
<a name="ev-document-get-thumbnail"></a><h3>ev_document_get_thumbnail ()</h3>
628
675
<pre class="programlisting"><span class="returnvalue">GdkPixbuf</span> *         ev_document_get_thumbnail           (<em class="parameter"><code><a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a> *document</code></em>,
629
676
                                                         <em class="parameter"><code><a class="link" href="EvRenderContext.html" title="EvRenderContext"><span class="type">EvRenderContext</span></a> *rc</code></em>);</pre>
 
677
<div class="variablelist"><table border="0" class="variablelist">
 
678
<colgroup>
 
679
<col align="left" valign="top">
 
680
<col>
 
681
</colgroup>
 
682
<tbody>
 
683
<tr>
 
684
<td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
 
685
<td>an <a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a>
 
686
</td>
 
687
</tr>
 
688
<tr>
 
689
<td><p><span class="term"><em class="parameter"><code>rc</code></em> :</span></p></td>
 
690
<td>an <a class="link" href="EvRenderContext.html" title="EvRenderContext"><span class="type">EvRenderContext</span></a>
 
691
</td>
 
692
</tr>
 
693
<tr>
 
694
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
695
<td>a <span class="type">GdkPixbuf</span>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
696
</td>
 
697
</tr>
 
698
</tbody>
 
699
</table></div>
630
700
</div>
631
701
<hr>
632
702
<div class="refsect2">
640
710
                                                         <em class="parameter"><code><span class="type">gint</span> page_index</code></em>,
641
711
                                                         <em class="parameter"><code><span class="type">gfloat</span> x</code></em>,
642
712
                                                         <em class="parameter"><code><span class="type">gfloat</span> y</code></em>);</pre>
 
713
<p>
 
714
Peforms a Synctex backward search to obtain the TeX input file, line and
 
715
(possibly) column  corresponding to the  position (<em class="parameter"><code>x</code></em>,<em class="parameter"><code>y</code></em>) (in 72dpi
 
716
coordinates) in the  <em class="parameter"><code>page</code></em> of <em class="parameter"><code>document</code></em>.
 
717
</p>
 
718
<div class="variablelist"><table border="0" class="variablelist">
 
719
<colgroup>
 
720
<col align="left" valign="top">
 
721
<col>
 
722
</colgroup>
 
723
<tbody>
 
724
<tr>
 
725
<td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
 
726
<td>a <a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a>
 
727
</td>
 
728
</tr>
 
729
<tr>
 
730
<td><p><span class="term"><em class="parameter"><code>page_index</code></em> :</span></p></td>
 
731
<td>the target page</td>
 
732
</tr>
 
733
<tr>
 
734
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
 
735
<td>X coordinate</td>
 
736
</tr>
 
737
<tr>
 
738
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
 
739
<td>Y coordinate</td>
 
740
</tr>
 
741
<tr>
 
742
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
743
<td>A pointer to the EvSourceLink structure that holds the result. <em class="parameter"><code>NULL</code></em> if synctex
 
744
is not enabled for the document or no result is found.
 
745
The EvSourceLink pointer should be freed with g_free after it is used.</td>
 
746
</tr>
 
747
</tbody>
 
748
</table></div>
643
749
</div>
644
750
<hr>
645
751
<div class="refsect2">
646
752
<a name="ev-document-synctex-forward-search"></a><h3>ev_document_synctex_forward_search ()</h3>
647
753
<pre class="programlisting"><a class="link" href="libevdocument-ev-mapping.html#EvMapping" title="struct EvMapping"><span class="returnvalue">EvMapping</span></a> *         ev_document_synctex_forward_search  (<em class="parameter"><code><a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a> *document</code></em>,
648
754
                                                         <em class="parameter"><code><a class="link" href="EvDocument.html#EvSourceLink"><span class="type">EvSourceLink</span></a> *source_link</code></em>);</pre>
 
755
<p>
 
756
Peforms a Synctex forward search to obtain the area in the document
 
757
corresponding to the position <em class="parameter"><code>line</code></em> and <em class="parameter"><code>column</code></em> number in the source Tex file
 
758
</p>
 
759
<div class="variablelist"><table border="0" class="variablelist">
 
760
<colgroup>
 
761
<col align="left" valign="top">
 
762
<col>
 
763
</colgroup>
 
764
<tbody>
 
765
<tr>
 
766
<td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
 
767
<td>a <a class="link" href="EvDocument.html" title="EvDocument"><span class="type">EvDocument</span></a>
 
768
</td>
 
769
</tr>
 
770
<tr>
 
771
<td><p><span class="term"><em class="parameter"><code>source_link</code></em> :</span></p></td>
 
772
<td>a <a class="link" href="EvDocument.html#EvSourceLink"><span class="type">EvSourceLink</span></a>
 
773
</td>
 
774
</tr>
 
775
<tr>
 
776
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
777
<td>An EvMapping with the page number and area corresponfing to
 
778
the given line in the source file. It must be free with g_free when done</td>
 
779
</tr>
 
780
</tbody>
 
781
</table></div>
649
782
</div>
650
783
<hr>
651
784
<div class="refsect2">
669
802
<a name="ev-rect-cmp"></a><h3>ev_rect_cmp ()</h3>
670
803
<pre class="programlisting"><span class="returnvalue">gint</span>                ev_rect_cmp                         (<em class="parameter"><code><a class="link" href="EvDocument.html#EvRectangle"><span class="type">EvRectangle</span></a> *a</code></em>,
671
804
                                                         <em class="parameter"><code><a class="link" href="EvDocument.html#EvRectangle"><span class="type">EvRectangle</span></a> *b</code></em>);</pre>
672
 
<p>
673
 
</p>
674
805
</div>
675
806
<hr>
676
807
<div class="refsect2">
677
808
<a name="ev-rectangle-new"></a><h3>ev_rectangle_new ()</h3>
678
809
<pre class="programlisting"><a class="link" href="EvDocument.html#EvRectangle"><span class="returnvalue">EvRectangle</span></a> *       ev_rectangle_new                    (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
679
 
<p>
680
 
</p>
681
810
</div>
682
811
<hr>
683
812
<div class="refsect2">
684
813
<a name="ev-rectangle-copy"></a><h3>ev_rectangle_copy ()</h3>
685
814
<pre class="programlisting"><a class="link" href="EvDocument.html#EvRectangle"><span class="returnvalue">EvRectangle</span></a> *       ev_rectangle_copy                   (<em class="parameter"><code><a class="link" href="EvDocument.html#EvRectangle"><span class="type">EvRectangle</span></a> *ev_rect</code></em>);</pre>
686
 
<p>
687
 
</p>
688
815
</div>
689
816
<hr>
690
817
<div class="refsect2">
691
818
<a name="ev-rectangle-free"></a><h3>ev_rectangle_free ()</h3>
692
819
<pre class="programlisting"><span class="returnvalue">void</span>                ev_rectangle_free                   (<em class="parameter"><code><a class="link" href="EvDocument.html#EvRectangle"><span class="type">EvRectangle</span></a> *ev_rect</code></em>);</pre>
693
 
<p>
694
 
</p>
695
820
</div>
696
821
<hr>
697
822
<div class="refsect2">
698
823
<a name="EV-BACKEND-IMPLEMENT-INTERFACE:CAPS"></a><h3>EV_BACKEND_IMPLEMENT_INTERFACE()</h3>
699
824
<pre class="programlisting">#define             EV_BACKEND_IMPLEMENT_INTERFACE(TYPE_IFACE, iface_init)</pre>
700
 
<p>
701
 
</p>
702
825
</div>
703
826
<hr>
704
827
<div class="refsect2">
705
828
<a name="EV-BACKEND-REGISTER-WITH-CODE:CAPS"></a><h3>EV_BACKEND_REGISTER_WITH_CODE()</h3>
706
829
<pre class="programlisting">#define             EV_BACKEND_REGISTER_WITH_CODE(BackendName, backend_name, CODE)</pre>
707
 
<p>
708
 
</p>
709
830
</div>
710
831
<hr>
711
832
<div class="refsect2">
712
833
<a name="EV-BACKEND-REGISTER:CAPS"></a><h3>EV_BACKEND_REGISTER()</h3>
713
834
<pre class="programlisting">#define             EV_BACKEND_REGISTER(BackendName, backend_name)</pre>
714
 
<p>
715
 
</p>
716
835
</div>
717
836
</div>
718
837
</div>
719
838
<div class="footer">
720
839
<hr>
721
 
          Generated by GTK-Doc V1.19.1</div>
 
840
          Generated by GTK-Doc V1.19</div>
722
841
</body>
723
842
</html>
 
 
b'\\ No newline at end of file'