File: GtkSourceLanguageManager.html

package info (click to toggle)
gtksourceview2 2.2.2-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 8,856 kB
  • ctags: 1,896
  • sloc: ansic: 18,630; sh: 9,199; xml: 4,509; python: 424; makefile: 272
file content (295 lines) | stat: -rw-r--r-- 15,954 bytes parent folder | download
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
293
294
295
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkSourceLanguageManager</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GtkSourceView 2 Reference Manual">
<link rel="up" href="rn01.html" title="API reference">
<link rel="prev" href="GtkSourceLanguage.html" title="GtkSourceLanguage">
<link rel="next" href="GtkSourcePrintCompositor.html" title="GtkSourcePrintCompositor">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="reference" href="rn01.html" title="API reference">
<link rel="reference" href="rn02.html" title="Syntax highlighting reference">
</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="2">
<tr valign="middle">
<td><a accesskey="p" href="GtkSourceLanguage.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="rn01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GtkSourceView 2 Reference Manual</th>
<td><a accesskey="n" href="GtkSourcePrintCompositor.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GtkSourceLanguageManager.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#GtkSourceLanguageManager.description" class="shortcut">Description</a>
                 | 
                <a href="#GtkSourceLanguageManager.object-hierarchy" class="shortcut">Object Hierarchy</a>
                 | 
                <a href="#GtkSourceLanguageManager.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" lang="en">
<a name="GtkSourceLanguageManager"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkSourceLanguageManager.top_of_page"></a>GtkSourceLanguageManager</span></h2>
<p>GtkSourceLanguageManager</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GtkSourceLanguageManager.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">

#include &lt;gtksourceview/gtksourcelanguagemanager.h&gt;

                    <a class="link" href="GtkSourceLanguageManager.html#GtkSourceLanguageManager-struct" title="GtkSourceLanguageManager">GtkSourceLanguageManager</a>;
<a class="link" href="GtkSourceLanguageManager.html" title="GtkSourceLanguageManager">GtkSourceLanguageManager</a>* <a class="link" href="GtkSourceLanguageManager.html#gtk-source-language-manager-new" title="gtk_source_language_manager_new ()">gtk_source_language_manager_new</a>
                                                        (void);
<a class="link" href="GtkSourceLanguageManager.html" title="GtkSourceLanguageManager">GtkSourceLanguageManager</a>* <a class="link" href="GtkSourceLanguageManager.html#gtk-source-language-manager-get-default" title="gtk_source_language_manager_get_default ()">gtk_source_language_manager_get_default</a>
                                                        (void);
void                <a class="link" href="GtkSourceLanguageManager.html#gtk-source-language-manager-set-search-path" title="gtk_source_language_manager_set_search_path ()">gtk_source_language_manager_set_search_path</a>
                                                        (<a class="link" href="GtkSourceLanguageManager.html" title="GtkSourceLanguageManager">GtkSourceLanguageManager</a> *lm,
                                                         gchar **dirs);
const gchar* const * <a class="link" href="GtkSourceLanguageManager.html#gtk-source-language-manager-get-search-path" title="gtk_source_language_manager_get_search_path ()">gtk_source_language_manager_get_search_path</a>
                                                        (<a class="link" href="GtkSourceLanguageManager.html" title="GtkSourceLanguageManager">GtkSourceLanguageManager</a> *lm);
const gchar* const * <a class="link" href="GtkSourceLanguageManager.html#gtk-source-language-manager-get-language-ids" title="gtk_source_language_manager_get_language_ids ()">gtk_source_language_manager_get_language_ids</a>
                                                        (<a class="link" href="GtkSourceLanguageManager.html" title="GtkSourceLanguageManager">GtkSourceLanguageManager</a> *lm);
<a class="link" href="GtkSourceLanguage.html" title="GtkSourceLanguage">GtkSourceLanguage</a>*  <a class="link" href="GtkSourceLanguageManager.html#gtk-source-language-manager-get-language" title="gtk_source_language_manager_get_language ()">gtk_source_language_manager_get_language</a>
                                                        (<a class="link" href="GtkSourceLanguageManager.html" title="GtkSourceLanguageManager">GtkSourceLanguageManager</a> *lm,
                                                         const gchar *id);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GtkSourceLanguageManager.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----GtkSourceLanguageManager
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GtkSourceLanguageManager.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="GtkSourceLanguageManager.html#GtkSourceLanguageManager--language-ids" title='The "language-ids" property'>language-ids</a>"             GStrv*                : Read
  "<a class="link" href="GtkSourceLanguageManager.html#GtkSourceLanguageManager--search-path" title='The "search-path" property'>search-path</a>"              GStrv*                : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GtkSourceLanguageManager.description"></a><h2>Description</h2>
<p>

</p>
</div>
<div class="refsect1" lang="en">
<a name="GtkSourceLanguageManager.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="GtkSourceLanguageManager-struct"></a><h3>GtkSourceLanguageManager</h3>
<pre class="programlisting">typedef struct _GtkSourceLanguageManager GtkSourceLanguageManager;</pre>
<p>
<span class="structname">GtkSourceLanguageManager</span> structure contains only
private members and should not be accessed directly.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-source-language-manager-new"></a><h3>gtk_source_language_manager_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkSourceLanguageManager.html" title="GtkSourceLanguageManager">GtkSourceLanguageManager</a>* gtk_source_language_manager_new
                                                        (void);</pre>
<p>
Creates a new language manager. If you do not need more than one language
manager or a private language manager instance then use
<a class="link" href="GtkSourceLanguageManager.html#gtk-source-language-manager-get-default" title="gtk_source_language_manager_get_default ()"><code class="function">gtk_source_language_manager_get_default()</code></a> instead.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a class="link" href="GtkSourceLanguageManager.html" title="GtkSourceLanguageManager"><span class="type">GtkSourceLanguageManager</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-source-language-manager-get-default"></a><h3>gtk_source_language_manager_get_default ()</h3>
<pre class="programlisting"><a class="link" href="GtkSourceLanguageManager.html" title="GtkSourceLanguageManager">GtkSourceLanguageManager</a>* gtk_source_language_manager_get_default
                                                        (void);</pre>
<p>
Returns the default <a class="link" href="GtkSourceLanguageManager.html" title="GtkSourceLanguageManager"><span class="type">GtkSourceLanguageManager</span></a> instance.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a class="link" href="GtkSourceLanguageManager.html" title="GtkSourceLanguageManager"><span class="type">GtkSourceLanguageManager</span></a>. Return value is owned
by GtkSourceView library and must not be unref'ed.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-source-language-manager-set-search-path"></a><h3>gtk_source_language_manager_set_search_path ()</h3>
<pre class="programlisting">void                gtk_source_language_manager_set_search_path
                                                        (<a class="link" href="GtkSourceLanguageManager.html" title="GtkSourceLanguageManager">GtkSourceLanguageManager</a> *lm,
                                                         gchar **dirs);</pre>
<p>
Sets the list of directories where the <em class="parameter"><code>lm</code></em> looks for
language files.
If <em class="parameter"><code>dirs</code></em> is <code class="literal">NULL</code>, the search path is reset to default.
</p>
<p>
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
    At the moment this function can be called only before the
    language files are loaded for the first time. In practice
    to set a custom search path for a <a class="link" href="GtkSourceLanguageManager.html" title="GtkSourceLanguageManager"><span class="type">GtkSourceLanguageManager</span></a>,
    you have to call this function right after creating it.
  </p>
</div>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>lm</code></em> :</span></p></td>
<td> a <a class="link" href="GtkSourceLanguageManager.html" title="GtkSourceLanguageManager"><span class="type">GtkSourceLanguageManager</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dirs</code></em> :</span></p></td>
<td> a <code class="literal">NULL</code>-terminated array of strings or <code class="literal">NULL</code>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-source-language-manager-get-search-path"></a><h3>gtk_source_language_manager_get_search_path ()</h3>
<pre class="programlisting">const gchar* const * gtk_source_language_manager_get_search_path
                                                        (<a class="link" href="GtkSourceLanguageManager.html" title="GtkSourceLanguageManager">GtkSourceLanguageManager</a> *lm);</pre>
<p>
Gets the list directories where <em class="parameter"><code>lm</code></em> looks for language files.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>lm</code></em> :</span></p></td>
<td> a <a class="link" href="GtkSourceLanguageManager.html" title="GtkSourceLanguageManager"><span class="type">GtkSourceLanguageManager</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">NULL</code>-terminated array containg a list of language files directories.
The array is owned by <em class="parameter"><code>lm</code></em> and must not be modified.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-source-language-manager-get-language-ids"></a><h3>gtk_source_language_manager_get_language_ids ()</h3>
<pre class="programlisting">const gchar* const * gtk_source_language_manager_get_language_ids
                                                        (<a class="link" href="GtkSourceLanguageManager.html" title="GtkSourceLanguageManager">GtkSourceLanguageManager</a> *lm);</pre>
<p>
Returns the ids of the available languages.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>lm</code></em> :</span></p></td>
<td> a <a class="link" href="GtkSourceLanguageManager.html" title="GtkSourceLanguageManager"><span class="type">GtkSourceLanguageManager</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <code class="literal">NULL</code>-terminated array of string containing the ids of the
available languages or <code class="literal">NULL</code> if no language is available. The array
is owned by <em class="parameter"><code>lm</code></em> and must not be modified.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-source-language-manager-get-language"></a><h3>gtk_source_language_manager_get_language ()</h3>
<pre class="programlisting"><a class="link" href="GtkSourceLanguage.html" title="GtkSourceLanguage">GtkSourceLanguage</a>*  gtk_source_language_manager_get_language
                                                        (<a class="link" href="GtkSourceLanguageManager.html" title="GtkSourceLanguageManager">GtkSourceLanguageManager</a> *lm,
                                                         const gchar *id);</pre>
<p>
Gets the <a class="link" href="GtkSourceLanguage.html" title="GtkSourceLanguage"><span class="type">GtkSourceLanguage</span></a> identified by the given <em class="parameter"><code>id</code></em> in the language
manager.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>lm</code></em> :</span></p></td>
<td> a <a class="link" href="GtkSourceLanguageManager.html" title="GtkSourceLanguageManager"><span class="type">GtkSourceLanguageManager</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td> a language id.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a class="link" href="GtkSourceLanguage.html" title="GtkSourceLanguage"><span class="type">GtkSourceLanguage</span></a>, or <code class="literal">NULL</code> if there is no language
identified by the given <em class="parameter"><code>id</code></em>. Return value is owned by <em class="parameter"><code>lm</code></em> and should not
be freed.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="GtkSourceLanguageManager.property-details"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="GtkSourceLanguageManager--language-ids"></a><h3>The <code class="literal">"language-ids"</code> property</h3>
<pre class="programlisting">  "language-ids"             GStrv*                : Read</pre>
<p>List of the ids of the available languages.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GtkSourceLanguageManager--search-path"></a><h3>The <code class="literal">"search-path"</code> property</h3>
<pre class="programlisting">  "search-path"              GStrv*                : Read / Write</pre>
<p>List of directories where the language specification files (.lang) are located.</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="GtkSourceLanguageManager.see-also"></a><h2>See Also</h2>
<p>
<a class="link" href="GtkSourceLanguage.html" title="GtkSourceLanguage"><span class="type">GtkSourceLanguage</span></a>
</p>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>