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
|
<?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="GtkSourceStyleSchemeManager">
<refmeta>
<refentrytitle role="top_of_page" id="GtkSourceStyleSchemeManager.top_of_page">GtkSourceStyleSchemeManager</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTKSOURCEVIEW-2.0 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkSourceStyleSchemeManager</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="GtkSourceStyleSchemeManager.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <gtksourceview/gtksourcestyleschememanager.h>
<link linkend="GtkSourceStyleSchemeManager-struct">GtkSourceStyleSchemeManager</link>;
<link linkend="GtkSourceStyleSchemeManager">GtkSourceStyleSchemeManager</link>* <link linkend="gtk-source-style-scheme-manager-new">gtk_source_style_scheme_manager_new</link>
(void);
<link linkend="GtkSourceStyleSchemeManager">GtkSourceStyleSchemeManager</link>* <link linkend="gtk-source-style-scheme-manager-get-default">gtk_source_style_scheme_manager_get_default</link>
(void);
<link linkend="void">void</link> <link linkend="gtk-source-style-scheme-manager-set-search-path">gtk_source_style_scheme_manager_set_search_path</link>
(<link linkend="GtkSourceStyleSchemeManager">GtkSourceStyleSchemeManager</link> *manager,
<link linkend="gchar">gchar</link> **path);
<link linkend="void">void</link> <link linkend="gtk-source-style-scheme-manager-append-search-path">gtk_source_style_scheme_manager_append_search_path</link>
(<link linkend="GtkSourceStyleSchemeManager">GtkSourceStyleSchemeManager</link> *manager,
const <link linkend="gchar">gchar</link> *path);
<link linkend="void">void</link> <link linkend="gtk-source-style-scheme-manager-prepend-search-path">gtk_source_style_scheme_manager_prepend_search_path</link>
(<link linkend="GtkSourceStyleSchemeManager">GtkSourceStyleSchemeManager</link> *manager,
const <link linkend="gchar">gchar</link> *path);
const <link linkend="gchar">gchar</link>* const * <link linkend="gtk-source-style-scheme-manager-get-search-path">gtk_source_style_scheme_manager_get_search_path</link>
(<link linkend="GtkSourceStyleSchemeManager">GtkSourceStyleSchemeManager</link> *manager);
const <link linkend="gchar">gchar</link>* const * <link linkend="gtk-source-style-scheme-manager-get-scheme-ids">gtk_source_style_scheme_manager_get_scheme_ids</link>
(<link linkend="GtkSourceStyleSchemeManager">GtkSourceStyleSchemeManager</link> *manager);
<link linkend="GtkSourceStyleScheme">GtkSourceStyleScheme</link>* <link linkend="gtk-source-style-scheme-manager-get-scheme">gtk_source_style_scheme_manager_get_scheme</link>
(<link linkend="GtkSourceStyleSchemeManager">GtkSourceStyleSchemeManager</link> *manager,
const <link linkend="gchar">gchar</link> *scheme_id);
<link linkend="void">void</link> <link linkend="gtk-source-style-scheme-manager-force-rescan">gtk_source_style_scheme_manager_force_rescan</link>
(<link linkend="GtkSourceStyleSchemeManager">GtkSourceStyleSchemeManager</link> *manager);
</synopsis>
</refsynopsisdiv>
<refsect1 id="GtkSourceStyleSchemeManager.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----GtkSourceStyleSchemeManager
</synopsis>
</refsect1>
<refsect1 id="GtkSourceStyleSchemeManager.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="GtkSourceStyleSchemeManager--scheme-ids">scheme-ids</link>" <link linkend="GStrv">GStrv</link>* : Read
"<link linkend="GtkSourceStyleSchemeManager--search-path">search-path</link>" <link linkend="GStrv">GStrv</link>* : Read / Write
</synopsis>
</refsect1>
<refsect1 id="GtkSourceStyleSchemeManager.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="GtkSourceStyleSchemeManager.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GtkSourceStyleSchemeManager-struct" role="struct">
<title>GtkSourceStyleSchemeManager</title>
<indexterm zone="GtkSourceStyleSchemeManager-struct"><primary>GtkSourceStyleSchemeManager</primary></indexterm><programlisting>typedef struct _GtkSourceStyleSchemeManager GtkSourceStyleSchemeManager;</programlisting>
<para>
</para></refsect2>
<refsect2 id="gtk-source-style-scheme-manager-new" role="function">
<title>gtk_source_style_scheme_manager_new ()</title>
<indexterm zone="gtk-source-style-scheme-manager-new"><primary>gtk_source_style_scheme_manager_new</primary></indexterm><programlisting><link linkend="GtkSourceStyleSchemeManager">GtkSourceStyleSchemeManager</link>* gtk_source_style_scheme_manager_new
(void);</programlisting>
<para>
Creates a new style manager. If you do not need more than one style
manager then use <link linkend="gtk-source-style-scheme-manager-get-default"><function>gtk_source_style_scheme_manager_get_default()</function></link> instead.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="GtkSourceStyleSchemeManager"><type>GtkSourceStyleSchemeManager</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-source-style-scheme-manager-get-default" role="function">
<title>gtk_source_style_scheme_manager_get_default ()</title>
<indexterm zone="gtk-source-style-scheme-manager-get-default"><primary>gtk_source_style_scheme_manager_get_default</primary></indexterm><programlisting><link linkend="GtkSourceStyleSchemeManager">GtkSourceStyleSchemeManager</link>* gtk_source_style_scheme_manager_get_default
(void);</programlisting>
<para>
Returns the default <link linkend="GtkSourceStyleSchemeManager"><type>GtkSourceStyleSchemeManager</type></link> instance.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="GtkSourceStyleSchemeManager"><type>GtkSourceStyleSchemeManager</type></link>. Return value is owned
by GtkSourceView library and must not be unref'ed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-source-style-scheme-manager-set-search-path" role="function">
<title>gtk_source_style_scheme_manager_set_search_path ()</title>
<indexterm zone="gtk-source-style-scheme-manager-set-search-path"><primary>gtk_source_style_scheme_manager_set_search_path</primary></indexterm><programlisting><link linkend="void">void</link> gtk_source_style_scheme_manager_set_search_path
(<link linkend="GtkSourceStyleSchemeManager">GtkSourceStyleSchemeManager</link> *manager,
<link linkend="gchar">gchar</link> **path);</programlisting>
<para>
Sets the list of directories where the <parameter>manager</parameter> looks for
style scheme files.
If <parameter>dirs</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>, the search path is reset to default.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>manager</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourceStyleSchemeManager"><type>GtkSourceStyleSchemeManager</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>path</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-style-scheme-manager-append-search-path" role="function">
<title>gtk_source_style_scheme_manager_append_search_path ()</title>
<indexterm zone="gtk-source-style-scheme-manager-append-search-path"><primary>gtk_source_style_scheme_manager_append_search_path</primary></indexterm><programlisting><link linkend="void">void</link> gtk_source_style_scheme_manager_append_search_path
(<link linkend="GtkSourceStyleSchemeManager">GtkSourceStyleSchemeManager</link> *manager,
const <link linkend="gchar">gchar</link> *path);</programlisting>
<para>
Appends <parameter>path</parameter> to the list of directories where the <parameter>manager</parameter> looks for
style scheme files.
See <link linkend="gtk-source-style-scheme-manager-set-search-path"><function>gtk_source_style_scheme_manager_set_search_path()</function></link> for details.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>manager</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourceStyleSchemeManager"><type>GtkSourceStyleSchemeManager</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>path</parameter> :</term>
<listitem><simpara> a directory or a filename.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-source-style-scheme-manager-prepend-search-path" role="function">
<title>gtk_source_style_scheme_manager_prepend_search_path ()</title>
<indexterm zone="gtk-source-style-scheme-manager-prepend-search-path"><primary>gtk_source_style_scheme_manager_prepend_search_path</primary></indexterm><programlisting><link linkend="void">void</link> gtk_source_style_scheme_manager_prepend_search_path
(<link linkend="GtkSourceStyleSchemeManager">GtkSourceStyleSchemeManager</link> *manager,
const <link linkend="gchar">gchar</link> *path);</programlisting>
<para>
Prepends <parameter>path</parameter> to the list of directories where the <parameter>manager</parameter> looks
for style scheme files.
See <link linkend="gtk-source-style-scheme-manager-set-search-path"><function>gtk_source_style_scheme_manager_set_search_path()</function></link> for details.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>manager</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourceStyleSchemeManager"><type>GtkSourceStyleSchemeManager</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>path</parameter> :</term>
<listitem><simpara> a directory or a filename.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-source-style-scheme-manager-get-search-path" role="function">
<title>gtk_source_style_scheme_manager_get_search_path ()</title>
<indexterm zone="gtk-source-style-scheme-manager-get-search-path"><primary>gtk_source_style_scheme_manager_get_search_path</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* const * gtk_source_style_scheme_manager_get_search_path
(<link linkend="GtkSourceStyleSchemeManager">GtkSourceStyleSchemeManager</link> *manager);</programlisting>
<para>
Returns the current search path for the <parameter>manager</parameter>.
See <link linkend="gtk-source-style-scheme-manager-set-search-path"><function>gtk_source_style_scheme_manager_set_search_path()</function></link> for details.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>manager</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourceStyleSchemeManager"><type>GtkSourceStyleSchemeManager</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a NULL-terminated array of string containing the search path.
The array is owned by the <parameter>manager</parameter> and must not be modified.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-source-style-scheme-manager-get-scheme-ids" role="function">
<title>gtk_source_style_scheme_manager_get_scheme_ids ()</title>
<indexterm zone="gtk-source-style-scheme-manager-get-scheme-ids"><primary>gtk_source_style_scheme_manager_get_scheme_ids</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* const * gtk_source_style_scheme_manager_get_scheme_ids
(<link linkend="GtkSourceStyleSchemeManager">GtkSourceStyleSchemeManager</link> *manager);</programlisting>
<para>
Returns the ids of the available style schemes.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>manager</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourceStyleSchemeManager"><type>GtkSourceStyleSchemeManager</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 style schemes or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if no style scheme is available. The array
is owned by the <parameter>manager</parameter> and must not be modified.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-source-style-scheme-manager-get-scheme" role="function">
<title>gtk_source_style_scheme_manager_get_scheme ()</title>
<indexterm zone="gtk-source-style-scheme-manager-get-scheme"><primary>gtk_source_style_scheme_manager_get_scheme</primary></indexterm><programlisting><link linkend="GtkSourceStyleScheme">GtkSourceStyleScheme</link>* gtk_source_style_scheme_manager_get_scheme
(<link linkend="GtkSourceStyleSchemeManager">GtkSourceStyleSchemeManager</link> *manager,
const <link linkend="gchar">gchar</link> *scheme_id);</programlisting>
<para>
Looks up style scheme by id.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>manager</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourceStyleSchemeManager"><type>GtkSourceStyleSchemeManager</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>scheme_id</parameter> :</term>
<listitem><simpara> style scheme id to find
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="GtkSourceStyleScheme"><type>GtkSourceStyleScheme</type></link> object. Returned value is owned by
<parameter>manager</parameter> and must not be unref'ed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gtk-source-style-scheme-manager-force-rescan" role="function">
<title>gtk_source_style_scheme_manager_force_rescan ()</title>
<indexterm zone="gtk-source-style-scheme-manager-force-rescan"><primary>gtk_source_style_scheme_manager_force_rescan</primary></indexterm><programlisting><link linkend="void">void</link> gtk_source_style_scheme_manager_force_rescan
(<link linkend="GtkSourceStyleSchemeManager">GtkSourceStyleSchemeManager</link> *manager);</programlisting>
<para>
Mark any currently cached information about the available style scehems
as invalid. All the available style schemes will be reloaded next time
the <parameter>manager</parameter> is accessed.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>manager</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourceStyleSchemeManager"><type>GtkSourceStyleSchemeManager</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="GtkSourceStyleSchemeManager.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GtkSourceStyleSchemeManager--scheme-ids"><title>The <literal>"scheme-ids"</literal> property</title>
<indexterm zone="GtkSourceStyleSchemeManager--scheme-ids"><primary>GtkSourceStyleSchemeManager:scheme-ids</primary></indexterm><programlisting> "scheme-ids" <link linkend="GStrv">GStrv</link>* : Read</programlisting>
<para>List of the ids of the available style schemes.</para></refsect2>
<refsect2 id="GtkSourceStyleSchemeManager--search-path"><title>The <literal>"search-path"</literal> property</title>
<indexterm zone="GtkSourceStyleSchemeManager--search-path"><primary>GtkSourceStyleSchemeManager:search-path</primary></indexterm><programlisting> "search-path" <link linkend="GStrv">GStrv</link>* : Read / Write</programlisting>
<para>List of directories and files where the style schemes are located.</para></refsect2>
</refsect1>
</refentry>
|
