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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
<!ENTITY tutorial SYSTEM "lang-tutorial.sgml">
<!ENTITY reference SYSTEM "lang-reference.sgml">
]>
<refentry id="GtkSourceLanguageManager">
<refmeta>
<refentrytitle role="top_of_page" id="GtkSourceLanguageManager.top_of_page">GtkSourceLanguageManager</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTKSOURCEVIEW-2.0 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkSourceLanguageManager</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="GtkSourceLanguageManager.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <gtksourceview/gtksourcelanguagemanager.h>
<link linkend="GtkSourceLanguageManager-struct">GtkSourceLanguageManager</link>;
<link linkend="GtkSourceLanguageManager">GtkSourceLanguageManager</link>* <link linkend="gtk-source-language-manager-new">gtk_source_language_manager_new</link>
(void);
<link linkend="GtkSourceLanguageManager">GtkSourceLanguageManager</link>* <link linkend="gtk-source-language-manager-get-default">gtk_source_language_manager_get_default</link>
(void);
<link linkend="void">void</link> <link linkend="gtk-source-language-manager-set-search-path">gtk_source_language_manager_set_search_path</link>
(<link linkend="GtkSourceLanguageManager">GtkSourceLanguageManager</link> *lm,
<link linkend="gchar">gchar</link> **dirs);
const <link linkend="gchar">gchar</link>* const * <link linkend="gtk-source-language-manager-get-search-path">gtk_source_language_manager_get_search_path</link>
(<link linkend="GtkSourceLanguageManager">GtkSourceLanguageManager</link> *lm);
const <link linkend="gchar">gchar</link>* const * <link linkend="gtk-source-language-manager-get-language-ids">gtk_source_language_manager_get_language_ids</link>
(<link linkend="GtkSourceLanguageManager">GtkSourceLanguageManager</link> *lm);
<link linkend="GtkSourceLanguage">GtkSourceLanguage</link>* <link linkend="gtk-source-language-manager-get-language">gtk_source_language_manager_get_language</link>
(<link linkend="GtkSourceLanguageManager">GtkSourceLanguageManager</link> *lm,
const <link linkend="gchar">gchar</link> *id);
</synopsis>
</refsynopsisdiv>
<refsect1 id="GtkSourceLanguageManager.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----GtkSourceLanguageManager
</synopsis>
</refsect1>
<refsect1 id="GtkSourceLanguageManager.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="GtkSourceLanguageManager--language-ids">language-ids</link>" <link linkend="GStrv">GStrv</link>* : Read
"<link linkend="GtkSourceLanguageManager--search-path">search-path</link>" <link linkend="GStrv">GStrv</link>* : Read / Write
</synopsis>
</refsect1>
<refsect1 id="GtkSourceLanguageManager.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="GtkSourceLanguageManager.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GtkSourceLanguageManager-struct" role="struct">
<title>GtkSourceLanguageManager</title>
<indexterm zone="GtkSourceLanguageManager-struct"><primary>GtkSourceLanguageManager</primary></indexterm><programlisting>typedef struct _GtkSourceLanguageManager GtkSourceLanguageManager;</programlisting>
<para>
<structname>GtkSourceLanguageManager</structname> structure contains only
private members and should not be accessed directly.
</para></refsect2>
<refsect2 id="gtk-source-language-manager-new" role="function">
<title>gtk_source_language_manager_new ()</title>
<indexterm zone="gtk-source-language-manager-new"><primary>gtk_source_language_manager_new</primary></indexterm><programlisting><link linkend="GtkSourceLanguageManager">GtkSourceLanguageManager</link>* gtk_source_language_manager_new
(void);</programlisting>
<para>
Creates a new language manager. If you do not need more than one language
manager or a private language manager instance then use
<link linkend="gtk-source-language-manager-get-default"><function>gtk_source_language_manager_get_default()</function></link> instead.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="GtkSourceLanguageManager"><type>GtkSourceLanguageManager</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-source-language-manager-get-default" role="function">
<title>gtk_source_language_manager_get_default ()</title>
<indexterm zone="gtk-source-language-manager-get-default"><primary>gtk_source_language_manager_get_default</primary></indexterm><programlisting><link linkend="GtkSourceLanguageManager">GtkSourceLanguageManager</link>* gtk_source_language_manager_get_default
(void);</programlisting>
<para>
Returns the default <link linkend="GtkSourceLanguageManager"><type>GtkSourceLanguageManager</type></link> instance.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="GtkSourceLanguageManager"><type>GtkSourceLanguageManager</type></link>. Return value is owned
by GtkSourceView library and must not be unref'ed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-source-language-manager-set-search-path" role="function">
<title>gtk_source_language_manager_set_search_path ()</title>
<indexterm zone="gtk-source-language-manager-set-search-path"><primary>gtk_source_language_manager_set_search_path</primary></indexterm><programlisting><link linkend="void">void</link> gtk_source_language_manager_set_search_path
(<link linkend="GtkSourceLanguageManager">GtkSourceLanguageManager</link> *lm,
<link linkend="gchar">gchar</link> **dirs);</programlisting>
<para>
Sets the list of directories where the <parameter>lm</parameter> looks for
language files.
If <parameter>dirs</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>, the search path is reset to default.
</para>
<para>
<note>
<para>
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 <link linkend="GtkSourceLanguageManager"><type>GtkSourceLanguageManager</type></link>,
you have to call this function right after creating it.
</para>
</note></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>lm</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourceLanguageManager"><type>GtkSourceLanguageManager</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dirs</parameter> :</term>
<listitem><simpara> a <link linkend="NULL:CAPS"><literal>NULL</literal></link>-terminated array of strings or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-source-language-manager-get-search-path" role="function">
<title>gtk_source_language_manager_get_search_path ()</title>
<indexterm zone="gtk-source-language-manager-get-search-path"><primary>gtk_source_language_manager_get_search_path</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* const * gtk_source_language_manager_get_search_path
(<link linkend="GtkSourceLanguageManager">GtkSourceLanguageManager</link> *lm);</programlisting>
<para>
Gets the list directories where <parameter>lm</parameter> looks for language files.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>lm</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourceLanguageManager"><type>GtkSourceLanguageManager</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="NULL:CAPS"><literal>NULL</literal></link>-terminated array containg a list of language files directories.
The array is owned by <parameter>lm</parameter> and must not be modified.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-source-language-manager-get-language-ids" role="function">
<title>gtk_source_language_manager_get_language_ids ()</title>
<indexterm zone="gtk-source-language-manager-get-language-ids"><primary>gtk_source_language_manager_get_language_ids</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* const * gtk_source_language_manager_get_language_ids
(<link linkend="GtkSourceLanguageManager">GtkSourceLanguageManager</link> *lm);</programlisting>
<para>
Returns the ids of the available languages.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>lm</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourceLanguageManager"><type>GtkSourceLanguageManager</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="NULL:CAPS"><literal>NULL</literal></link>-terminated array of string containing the ids of the
available languages or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if no language is available. The array
is owned by <parameter>lm</parameter> and must not be modified.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-source-language-manager-get-language" role="function">
<title>gtk_source_language_manager_get_language ()</title>
<indexterm zone="gtk-source-language-manager-get-language"><primary>gtk_source_language_manager_get_language</primary></indexterm><programlisting><link linkend="GtkSourceLanguage">GtkSourceLanguage</link>* gtk_source_language_manager_get_language
(<link linkend="GtkSourceLanguageManager">GtkSourceLanguageManager</link> *lm,
const <link linkend="gchar">gchar</link> *id);</programlisting>
<para>
Gets the <link linkend="GtkSourceLanguage"><type>GtkSourceLanguage</type></link> identified by the given <parameter>id</parameter> in the language
manager.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>lm</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourceLanguageManager"><type>GtkSourceLanguageManager</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter> :</term>
<listitem><simpara> a language id.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="GtkSourceLanguage"><type>GtkSourceLanguage</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if there is no language
identified by the given <parameter>id</parameter>. Return value is owned by <parameter>lm</parameter> and should not
be freed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="GtkSourceLanguageManager.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GtkSourceLanguageManager--language-ids"><title>The <literal>"language-ids"</literal> property</title>
<indexterm zone="GtkSourceLanguageManager--language-ids"><primary>GtkSourceLanguageManager:language-ids</primary></indexterm><programlisting> "language-ids" <link linkend="GStrv">GStrv</link>* : Read</programlisting>
<para>List of the ids of the available languages.</para></refsect2>
<refsect2 id="GtkSourceLanguageManager--search-path"><title>The <literal>"search-path"</literal> property</title>
<indexterm zone="GtkSourceLanguageManager--search-path"><primary>GtkSourceLanguageManager:search-path</primary></indexterm><programlisting> "search-path" <link linkend="GStrv">GStrv</link>* : Read / Write</programlisting>
<para>List of directories where the language specification files (.lang) are located.</para></refsect2>
</refsect1>
<refsect1 id="GtkSourceLanguageManager.see-also">
<title>See Also</title>
<para>
<link linkend="GtkSourceLanguage"><type>GtkSourceLanguage</type></link>
</para>
</refsect1>
</refentry>
|
