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
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="GimpPathEditor">
<refmeta>
<refentrytitle role="top_of_page" id="GimpPathEditor.top_of_page">GimpPathEditor</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GimpPathEditor</refname>
<refpurpose>Widget for editing a file search path.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="GimpPathEditor.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="GimpPathEditor-struct">GimpPathEditor</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-path-editor-new">gimp_path_editor_new</link> (const <link linkend="gchar">gchar</link> *title,
const <link linkend="gchar">gchar</link> *path);
<link linkend="gchar">gchar</link>* <link linkend="gimp-path-editor-get-path">gimp_path_editor_get_path</link> (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor);
<link linkend="void">void</link> <link linkend="gimp-path-editor-set-path">gimp_path_editor_set_path</link> (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
const <link linkend="gchar">gchar</link> *path);
<link linkend="gchar">gchar</link>* <link linkend="gimp-path-editor-get-writable-path">gimp_path_editor_get_writable_path</link> (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor);
<link linkend="void">void</link> <link linkend="gimp-path-editor-set-writable-path">gimp_path_editor_set_writable_path</link> (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
const <link linkend="gchar">gchar</link> *path);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-path-editor-get-dir-writable">gimp_path_editor_get_dir_writable</link> (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
const <link linkend="gchar">gchar</link> *directory);
<link linkend="void">void</link> <link linkend="gimp-path-editor-set-dir-writable">gimp_path_editor_set_dir_writable</link> (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
const <link linkend="gchar">gchar</link> *directory,
<link linkend="gboolean">gboolean</link> writable);
</synopsis>
</refsynopsisdiv>
<refsect1 id="GimpPathEditor.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
+----<link linkend="GtkObject">GtkObject</link>
+----<link linkend="GtkWidget">GtkWidget</link>
+----<link linkend="GtkContainer">GtkContainer</link>
+----<link linkend="GtkBox">GtkBox</link>
+----<link linkend="GtkVBox">GtkVBox</link>
+----GimpPathEditor
</synopsis>
</refsect1>
<refsect1 id="GimpPathEditor.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GimpPathEditor implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkBuildable">GtkBuildable</link>.</para>
</refsect1>
<refsect1 id="GimpPathEditor.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="GimpPathEditor-path-changed">path-changed</link>" : Run First
"<link linkend="GimpPathEditor-writable-changed">writable-changed</link>" : Run First
</synopsis>
</refsect1>
<refsect1 id="GimpPathEditor.description" role="desc">
<title role="desc.title">Description</title>
<para>
This widget is used to edit file search paths.
</para>
<para>
It shows a list of all directories which are in the search path. You
can click a directory to select it. The widget provides a
<link linkend="GimpFileEntry"><type>GimpFileEntry</type></link> to change the currently selected directory.
</para>
<para>
There are buttons to add or delete directories as well as "up" and "down"
buttons to change the order in which the directories will be searched.
</para>
<para>
Whenever the user adds, deletes, changes or reorders a directory of
the search path, the "path_changed" signal will be emitted.
</para>
</refsect1>
<refsect1 id="GimpPathEditor.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GimpPathEditor-struct" role="struct">
<title>GimpPathEditor</title>
<indexterm zone="GimpPathEditor-struct"><primary>GimpPathEditor</primary></indexterm><programlisting>typedef struct _GimpPathEditor GimpPathEditor;</programlisting>
<para>
</para></refsect2>
<refsect2 id="gimp-path-editor-new" role="function">
<title>gimp_path_editor_new ()</title>
<indexterm zone="gimp-path-editor-new"><primary>gimp_path_editor_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_path_editor_new (const <link linkend="gchar">gchar</link> *title,
const <link linkend="gchar">gchar</link> *path);</programlisting>
<para>
Creates a new <link linkend="GimpPathEditor"><type>GimpPathEditor</type></link> widget.
</para>
<para>
The elements of the initial search path must be separated with the
<link linkend="G-SEARCHPATH-SEPARATOR:CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> character.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>title</parameter> :</term>
<listitem><simpara> The title of the <link linkend="GtkFileChooser"><type>GtkFileChooser</type></link> dialog which can be popped up.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>path</parameter> :</term>
<listitem><simpara> The initial search path.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the new <link linkend="GimpPathEditor"><type>GimpPathEditor</type></link> widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-path-editor-get-path" role="function">
<title>gimp_path_editor_get_path ()</title>
<indexterm zone="gimp-path-editor-get-path"><primary>gimp_path_editor_get_path</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_path_editor_get_path (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor);</programlisting>
<para>
The elements of the returned search path string are separated with the
<link linkend="G-SEARCHPATH-SEPARATOR:CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> character.
</para>
<para>
Note that you have to <link linkend="g-free"><function>g_free()</function></link> the returned string.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>editor</parameter> :</term>
<listitem><simpara> The path editor you want to get the search path from.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The search path the user has selected in the path editor.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-path-editor-set-path" role="function">
<title>gimp_path_editor_set_path ()</title>
<indexterm zone="gimp-path-editor-set-path"><primary>gimp_path_editor_set_path</primary></indexterm><programlisting><link linkend="void">void</link> gimp_path_editor_set_path (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
const <link linkend="gchar">gchar</link> *path);</programlisting>
<para>
The elements of the initial search path must be separated with the
<link linkend="G-SEARCHPATH-SEPARATOR:CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> character.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>editor</parameter> :</term>
<listitem><simpara> The path editor you want to set the search path from.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>path</parameter> :</term>
<listitem><simpara> The new path to set.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-path-editor-get-writable-path" role="function">
<title>gimp_path_editor_get_writable_path ()</title>
<indexterm zone="gimp-path-editor-get-writable-path"><primary>gimp_path_editor_get_writable_path</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_path_editor_get_writable_path (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>editor</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-path-editor-set-writable-path" role="function">
<title>gimp_path_editor_set_writable_path ()</title>
<indexterm zone="gimp-path-editor-set-writable-path"><primary>gimp_path_editor_set_writable_path</primary></indexterm><programlisting><link linkend="void">void</link> gimp_path_editor_set_writable_path (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
const <link linkend="gchar">gchar</link> *path);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>editor</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>path</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-path-editor-get-dir-writable" role="function">
<title>gimp_path_editor_get_dir_writable ()</title>
<indexterm zone="gimp-path-editor-get-dir-writable"><primary>gimp_path_editor_get_dir_writable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_path_editor_get_dir_writable (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
const <link linkend="gchar">gchar</link> *directory);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>editor</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>directory</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-path-editor-set-dir-writable" role="function">
<title>gimp_path_editor_set_dir_writable ()</title>
<indexterm zone="gimp-path-editor-set-dir-writable"><primary>gimp_path_editor_set_dir_writable</primary></indexterm><programlisting><link linkend="void">void</link> gimp_path_editor_set_dir_writable (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
const <link linkend="gchar">gchar</link> *directory,
<link linkend="gboolean">gboolean</link> writable);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>editor</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>directory</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>writable</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="GimpPathEditor.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="GimpPathEditor-path-changed"><title>The <literal>"path-changed"</literal> signal</title>
<indexterm zone="GimpPathEditor-path-changed"><primary>GimpPathEditor::path-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GimpPathEditor">GimpPathEditor</link> *arg0,
<link linkend="gpointer">gpointer</link> user_data) : Run First</programlisting>
<para>
This signal is emitted whenever the user adds, deletes, modifies
or reorders an element of the search path.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GimpPathEditor-writable-changed"><title>The <literal>"writable-changed"</literal> signal</title>
<indexterm zone="GimpPathEditor-writable-changed"><primary>GimpPathEditor::writable-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GimpPathEditor">GimpPathEditor</link> *arg0,
<link linkend="gpointer">gpointer</link> user_data) : Run First</programlisting>
<para>
This signal is emitted whenever the "writable" column of a directory
is changed, either by the user clicking on it or by calling
<link linkend="gimp-path-editor-set-dir-writable"><function>gimp_path_editor_set_dir_writable()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="GimpPathEditor.see-also">
<title>See Also</title>
<para>
<link linkend="GimpFileEntry"><type>GimpFileEntry</type></link>
</para>
<para>
<link linkend="G-SEARCHPATH-SEPARATOR:CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link>
</para>
</refsect1>
</refentry>
|
