latexila-data 3.16.1-1 / usr / share / gtk-doc / html / latexila / LatexilaSynctex.html

This file is indexed.

/usr/share/gtk-doc/html/latexila/LatexilaSynctex.html is in latexila-data 3.16.1-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>LatexilaSynctex: LaTeXila Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="LaTeXila Reference Manual">
<link rel="up" href="ch01.html" title="API reference">
<link rel="prev" href="LatexilaPostProcessorLatexmk.html" title="LatexilaPostProcessorLatexmk">
<link rel="next" href="latexila-LatexilaUtils.html" title="LatexilaUtils">
<meta name="generator" content="GTK-Doc V1.21.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#LatexilaSynctex.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#LatexilaSynctex.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#LatexilaSynctex.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="LatexilaPostProcessorLatexmk.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="latexila-LatexilaUtils.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="LatexilaSynctex"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="LatexilaSynctex.top_of_page"></a>LatexilaSynctex</span></h2>
<p>LatexilaSynctex — SyncTeX support between LaTeXila and Evince</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="LatexilaSynctex.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="LatexilaSynctex.html" title="LatexilaSynctex"><span class="returnvalue">LatexilaSynctex</span></a> *
</td>
<td class="function_name">
<a class="link" href="LatexilaSynctex.html#latexila-synctex-get-instance" title="latexila_synctex_get_instance ()">latexila_synctex_get_instance</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="LatexilaSynctex.html#latexila-synctex-connect-evince-window" title="latexila_synctex_connect_evince_window ()">latexila_synctex_connect_evince_window</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="LatexilaSynctex.html#latexila-synctex-forward-search" title="latexila_synctex_forward_search ()">latexila_synctex_forward_search</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="LatexilaSynctex.signals"></a><h2>Signals</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="LatexilaSynctex.html#LatexilaSynctex-backward-search" title="The “backward-search” signal">backward-search</a></td>
<td class="signal_flags"><a href="https://developer.gnome.org/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="LatexilaSynctex.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="LatexilaSynctex.html#LatexilaSynctex-struct" title="LatexilaSynctex">LatexilaSynctex</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="LatexilaSynctex.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
    <span class="lineart">╰──</span> LatexilaSynctex
</pre>
</div>
<div class="refsect1">
<a name="LatexilaSynctex.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;latexila.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="LatexilaSynctex.description"></a><h2>Description</h2>
<p>The <a class="link" href="LatexilaSynctex.html" title="LatexilaSynctex"><span class="type">LatexilaSynctex</span></a> class (a singleton) implements the support of SyncTeX
between LaTeXila and the Evince PDF viewer. It is used to switch between the
source file(s) and the PDF, at the same position in the document. It is called
the forward search: source file -&gt; PDF. And backward search: PDF -&gt; source
file.</p>
<p>D-Bus is used to communicate between LaTeXila and Evince. The implementation
uses the asynchronous gdbus generated functions.</p>
<p>For the position, only the line is used, not the column. The column is a bit
buggy.</p>
</div>
<div class="refsect1">
<a name="LatexilaSynctex.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="latexila-synctex-get-instance"></a><h3>latexila_synctex_get_instance ()</h3>
<pre class="programlisting"><a class="link" href="LatexilaSynctex.html" title="LatexilaSynctex"><span class="returnvalue">LatexilaSynctex</span></a> *
latexila_synctex_get_instance (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="refsect3">
<a name="id-1.2.12.9.2.4"></a><h4>Returns</h4>
<p> the <a class="link" href="LatexilaSynctex.html" title="LatexilaSynctex"><span class="type">LatexilaSynctex</span></a> singleton instance. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="latexila-synctex-connect-evince-window"></a><h3>latexila_synctex_connect_evince_window ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
latexila_synctex_connect_evince_window
                               (<em class="parameter"><code><a class="link" href="LatexilaSynctex.html" title="LatexilaSynctex"><span class="type">LatexilaSynctex</span></a> *synctex</code></em>,
                                <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pdf_uri</code></em>);</pre>
<p>Connects asynchronously the evince window for <em class="parameter"><code>pdf_uri</code></em>
. LaTeXila will then
listen the signals emitted by the evince window when the user wants to switch
from the PDF to the corresponding *.tex file.</p>
<div class="refsect3">
<a name="id-1.2.12.9.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>synctex</p></td>
<td class="parameter_description"><p>the <a class="link" href="LatexilaSynctex.html" title="LatexilaSynctex"><span class="type">LatexilaSynctex</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pdf_uri</p></td>
<td class="parameter_description"><p>the PDF URI.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="latexila-synctex-forward-search"></a><h3>latexila_synctex_forward_search ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
latexila_synctex_forward_search (<em class="parameter"><code><a class="link" href="LatexilaSynctex.html" title="LatexilaSynctex"><span class="type">LatexilaSynctex</span></a> *synctex</code></em>,
                                 <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkTextBuffer.html"><span class="type">GtkTextBuffer</span></a> *buffer</code></em>,
                                 <em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GFile.html"><span class="type">GFile</span></a> *buffer_location</code></em>,
                                 <em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GFile.html"><span class="type">GFile</span></a> *main_tex_file</code></em>,
                                 <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> timestamp</code></em>);</pre>
<p>Does a forward search, i.e. switch from the *.tex file to the PDF file at the
same position as the cursor position in <em class="parameter"><code>buffer</code></em>
.</p>
<p>A correct <em class="parameter"><code>timestamp</code></em>
 of the event is important. If <a href="http://developer.gnome.org/gdk2/gdk3-Events.html#GDK-CURRENT-TIME:CAPS"><code class="literal">GDK_CURRENT_TIME</code></a> is used
instead, Evince is sometimes not shown directly, a notification appears
instead saying that the "Document Viewer [...] is ready". It's more
convenient if the Evince window is presented directly, which should work if
the correct <em class="parameter"><code>timestamp</code></em>
 is provided.</p>
<div class="refsect3">
<a name="id-1.2.12.9.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>synctex</p></td>
<td class="parameter_description"><p>the <a class="link" href="LatexilaSynctex.html" title="LatexilaSynctex"><span class="type">LatexilaSynctex</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buffer</p></td>
<td class="parameter_description"><p>a <a href="http://developer.gnome.org/gtk2/GtkTextBuffer.html"><span class="type">GtkTextBuffer</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buffer_location</p></td>
<td class="parameter_description"><p>the *.tex file of <em class="parameter"><code>buffer</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>main_tex_file</p></td>
<td class="parameter_description"><p>the main *.tex file of <em class="parameter"><code>buffer</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>timestamp</p></td>
<td class="parameter_description"><p>the timestamp of the event.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="LatexilaSynctex.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="LatexilaSynctex-struct"></a><h3>LatexilaSynctex</h3>
<pre class="programlisting">typedef struct _LatexilaSynctex LatexilaSynctex;</pre>
</div>
</div>
<div class="refsect1">
<a name="LatexilaSynctex.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="LatexilaSynctex-backward-search"></a><h3>The <code class="literal">“backward-search”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="LatexilaSynctex.html" title="LatexilaSynctex"><span class="type">LatexilaSynctex</span></a> *synctex,
               <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>           *tex_uri,
               <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>             line,
               <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>            timestamp,
               <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>         user_data)</pre>
<p>The ::backward-search signal is emitted to perform a backward search, i.e.
switching from the PDF to the source *.tex file.</p>
<div class="refsect3">
<a name="id-1.2.12.11.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>synctex</p></td>
<td class="parameter_description"><p>the <a class="link" href="LatexilaSynctex.html" title="LatexilaSynctex"><span class="type">LatexilaSynctex</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tex_uri</p></td>
<td class="parameter_description"><p>the *.tex file URI.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>line</p></td>
<td class="parameter_description"><p>the line to jump to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>timestamp</p></td>
<td class="parameter_description"><p>timestamp of the event.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="https://developer.gnome.org/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.21.1</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.