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
|
<?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="GtkSourceLanguage">
<refmeta>
<refentrytitle role="top_of_page" id="GtkSourceLanguage.top_of_page">GtkSourceLanguage</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTKSOURCEVIEW-2.0 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkSourceLanguage</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="GtkSourceLanguage.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <gtksourceview/gtksourcelanguage.h>
<link linkend="GtkSourceLanguage-struct">GtkSourceLanguage</link>;
const <link linkend="gchar">gchar</link>* <link linkend="gtk-source-language-get-id">gtk_source_language_get_id</link> (<link linkend="GtkSourceLanguage">GtkSourceLanguage</link> *language);
const <link linkend="gchar">gchar</link>* <link linkend="gtk-source-language-get-name">gtk_source_language_get_name</link> (<link linkend="GtkSourceLanguage">GtkSourceLanguage</link> *language);
const <link linkend="gchar">gchar</link>* <link linkend="gtk-source-language-get-section">gtk_source_language_get_section</link> (<link linkend="GtkSourceLanguage">GtkSourceLanguage</link> *language);
<link linkend="gboolean">gboolean</link> <link linkend="gtk-source-language-get-hidden">gtk_source_language_get_hidden</link> (<link linkend="GtkSourceLanguage">GtkSourceLanguage</link> *language);
const <link linkend="gchar">gchar</link>* <link linkend="gtk-source-language-get-metadata">gtk_source_language_get_metadata</link> (<link linkend="GtkSourceLanguage">GtkSourceLanguage</link> *language,
const <link linkend="gchar">gchar</link> *name);
<link linkend="gchar">gchar</link>** <link linkend="gtk-source-language-get-mime-types">gtk_source_language_get_mime_types</link> (<link linkend="GtkSourceLanguage">GtkSourceLanguage</link> *language);
<link linkend="gchar">gchar</link>** <link linkend="gtk-source-language-get-globs">gtk_source_language_get_globs</link> (<link linkend="GtkSourceLanguage">GtkSourceLanguage</link> *language);
const <link linkend="char">char</link>* <link linkend="gtk-source-language-get-style-name">gtk_source_language_get_style_name</link> (<link linkend="GtkSourceLanguage">GtkSourceLanguage</link> *language,
const <link linkend="char">char</link> *style_id);
<link linkend="gchar">gchar</link>** <link linkend="gtk-source-language-get-style-ids">gtk_source_language_get_style_ids</link> (<link linkend="GtkSourceLanguage">GtkSourceLanguage</link> *language);
</synopsis>
</refsynopsisdiv>
<refsect1 id="GtkSourceLanguage.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----GtkSourceLanguage
</synopsis>
</refsect1>
<refsect1 id="GtkSourceLanguage.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="GtkSourceLanguage--hidden">hidden</link>" <link linkend="gboolean">gboolean</link> : Read
"<link linkend="GtkSourceLanguage--id">id</link>" <link linkend="gchar">gchar</link>* : Read
"<link linkend="GtkSourceLanguage--name">name</link>" <link linkend="gchar">gchar</link>* : Read
"<link linkend="GtkSourceLanguage--section">section</link>" <link linkend="gchar">gchar</link>* : Read
</synopsis>
</refsect1>
<refsect1 id="GtkSourceLanguage.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="GtkSourceLanguage.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GtkSourceLanguage-struct" role="struct">
<title>GtkSourceLanguage</title>
<indexterm zone="GtkSourceLanguage-struct"><primary>GtkSourceLanguage</primary></indexterm><programlisting>typedef struct _GtkSourceLanguage GtkSourceLanguage;</programlisting>
<para>
<structname>GtkSourceLanguage</structname> structure contains only
private members and should not be accessed directly.
</para></refsect2>
<refsect2 id="gtk-source-language-get-id" role="function">
<title>gtk_source_language_get_id ()</title>
<indexterm zone="gtk-source-language-get-id"><primary>gtk_source_language_get_id</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gtk_source_language_get_id (<link linkend="GtkSourceLanguage">GtkSourceLanguage</link> *language);</programlisting>
<para>
Returns the ID of the language. The ID is not locale-dependent.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>language</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourceLanguage"><type>GtkSourceLanguage</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the ID of <parameter>language</parameter>.
The returned string is owned by <parameter>language</parameter> and should not be freed
or modified.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-source-language-get-name" role="function">
<title>gtk_source_language_get_name ()</title>
<indexterm zone="gtk-source-language-get-name"><primary>gtk_source_language_get_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gtk_source_language_get_name (<link linkend="GtkSourceLanguage">GtkSourceLanguage</link> *language);</programlisting>
<para>
Returns the localized name of the language.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>language</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourceLanguage"><type>GtkSourceLanguage</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the name of <parameter>language</parameter>.
The returned string is owned by <parameter>language</parameter> and should not be freed
or modified.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-source-language-get-section" role="function">
<title>gtk_source_language_get_section ()</title>
<indexterm zone="gtk-source-language-get-section"><primary>gtk_source_language_get_section</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gtk_source_language_get_section (<link linkend="GtkSourceLanguage">GtkSourceLanguage</link> *language);</programlisting>
<para>
Returns the localized section of the language.
Each language belong to a section (ex. HTML belogs to the
Markup section).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>language</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourceLanguage"><type>GtkSourceLanguage</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the section of <parameter>language</parameter>.
The returned string is owned by <parameter>language</parameter> and should not be freed
or modified.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-source-language-get-hidden" role="function">
<title>gtk_source_language_get_hidden ()</title>
<indexterm zone="gtk-source-language-get-hidden"><primary>gtk_source_language_get_hidden</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gtk_source_language_get_hidden (<link linkend="GtkSourceLanguage">GtkSourceLanguage</link> *language);</programlisting>
<para>
Returns whether the language should be hidden from the user.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>language</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourceLanguage"><type>GtkSourceLanguage</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the language should be hidden, FALSE otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-source-language-get-metadata" role="function">
<title>gtk_source_language_get_metadata ()</title>
<indexterm zone="gtk-source-language-get-metadata"><primary>gtk_source_language_get_metadata</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gtk_source_language_get_metadata (<link linkend="GtkSourceLanguage">GtkSourceLanguage</link> *language,
const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>language</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourceLanguage"><type>GtkSourceLanguage</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> metadata property name.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> value of property <parameter>name</parameter> stored in the metadata of <parameter>language</parameter>
or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if language doesn't contain that metadata property.
The returned string is owned by <parameter>language</parameter> and should not be freed
or modified.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-source-language-get-mime-types" role="function">
<title>gtk_source_language_get_mime_types ()</title>
<indexterm zone="gtk-source-language-get-mime-types"><primary>gtk_source_language_get_mime_types</primary></indexterm><programlisting><link linkend="gchar">gchar</link>** gtk_source_language_get_mime_types (<link linkend="GtkSourceLanguage">GtkSourceLanguage</link> *language);</programlisting>
<para>
Returns the mime types associated to this language. This is just
an utility wrapper around <link linkend="gtk-source-language-get-metadata"><function>gtk_source_language_get_metadata()</function></link> to
retrieve the "mimetypes" metadata property and split it into an
array.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>language</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourceLanguage"><type>GtkSourceLanguage</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a newly-allocated <link linkend="NULL:CAPS"><literal>NULL</literal></link> terminated array containing
the mime types or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if no mime types are found.
The returned array must be freed with <link linkend="g-strfreev"><function>g_strfreev()</function></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-source-language-get-globs" role="function">
<title>gtk_source_language_get_globs ()</title>
<indexterm zone="gtk-source-language-get-globs"><primary>gtk_source_language_get_globs</primary></indexterm><programlisting><link linkend="gchar">gchar</link>** gtk_source_language_get_globs (<link linkend="GtkSourceLanguage">GtkSourceLanguage</link> *language);</programlisting>
<para>
Returns the globs associated to this language. This is just
an utility wrapper around <link linkend="gtk-source-language-get-metadata"><function>gtk_source_language_get_metadata()</function></link> to
retrieve the "globs" metadata property and split it into an array.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>language</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourceLanguage"><type>GtkSourceLanguage</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a newly-allocated <link linkend="NULL:CAPS"><literal>NULL</literal></link> terminated array containing
the globs or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if no globs are found.
The returned array must be freed with <link linkend="g-strfreev"><function>g_strfreev()</function></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-source-language-get-style-name" role="function">
<title>gtk_source_language_get_style_name ()</title>
<indexterm zone="gtk-source-language-get-style-name"><primary>gtk_source_language_get_style_name</primary></indexterm><programlisting>const <link linkend="char">char</link>* gtk_source_language_get_style_name (<link linkend="GtkSourceLanguage">GtkSourceLanguage</link> *language,
const <link linkend="char">char</link> *style_id);</programlisting>
<para>
Returns the name of the style with ID <parameter>style_id</parameter> defined by this <parameter>language</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>language</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourceLanguage"><type>GtkSourceLanguage</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>style_id</parameter> :</term>
<listitem><simpara> a style ID
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the name of the style with ID <parameter>style_id</parameter> defined by this <parameter>language</parameter> or
<link linkend="NULL:CAPS"><literal>NULL</literal></link> if the style has no name or there is no style with ID <parameter>style_id</parameter> defined
by this <parameter>language</parameter>. The returned string is owned by the <parameter>language</parameter> and must
not be modified.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-source-language-get-style-ids" role="function">
<title>gtk_source_language_get_style_ids ()</title>
<indexterm zone="gtk-source-language-get-style-ids"><primary>gtk_source_language_get_style_ids</primary></indexterm><programlisting><link linkend="gchar">gchar</link>** gtk_source_language_get_style_ids (<link linkend="GtkSourceLanguage">GtkSourceLanguage</link> *language);</programlisting>
<para>
Returns the ids of the styles defined by this <parameter>language</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>language</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourceLanguage"><type>GtkSourceLanguage</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="NULL:CAPS"><literal>NULL</literal></link> terminated array containing
ids of the styles defined by this <parameter>language</parameter> or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if no style is
defined. The returned array must be freed with <link linkend="g-strfreev"><function>g_strfreev()</function></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="GtkSourceLanguage.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GtkSourceLanguage--hidden"><title>The <literal>"hidden"</literal> property</title>
<indexterm zone="GtkSourceLanguage--hidden"><primary>GtkSourceLanguage:hidden</primary></indexterm><programlisting> "hidden" <link linkend="gboolean">gboolean</link> : Read</programlisting>
<para>Whether the language should be hidden from the user.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2 id="GtkSourceLanguage--id"><title>The <literal>"id"</literal> property</title>
<indexterm zone="GtkSourceLanguage--id"><primary>GtkSourceLanguage:id</primary></indexterm><programlisting> "id" <link linkend="gchar">gchar</link>* : Read</programlisting>
<para>Language id.</para><para>Default value: NULL</para>
</refsect2>
<refsect2 id="GtkSourceLanguage--name"><title>The <literal>"name"</literal> property</title>
<indexterm zone="GtkSourceLanguage--name"><primary>GtkSourceLanguage:name</primary></indexterm><programlisting> "name" <link linkend="gchar">gchar</link>* : Read</programlisting>
<para>Language name.</para><para>Default value: NULL</para>
</refsect2>
<refsect2 id="GtkSourceLanguage--section"><title>The <literal>"section"</literal> property</title>
<indexterm zone="GtkSourceLanguage--section"><primary>GtkSourceLanguage:section</primary></indexterm><programlisting> "section" <link linkend="gchar">gchar</link>* : Read</programlisting>
<para>Language section.</para><para>Default value: NULL</para>
</refsect2>
</refsect1>
<refsect1 id="GtkSourceLanguage.see-also">
<title>See Also</title>
<para>
<link linkend="GtkSourceLanguageManager"><type>GtkSourceLanguageManager</type></link>
</para>
</refsect1>
</refentry>
|
