← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/gimp/oneiric-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/xml/gimppatheditor.xml

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2010-07-12 15:08:08 UTC
  • mfrom: (1.1.23) (0.4.6 sid)
  • Revision ID: package-import@ubuntu.com-20100712150808-db9xqgtxrvpyl3g2
Tags: 2.6.10-1ubuntu1
Resync on Debian, dropping changes which are in the new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimppatheditor.xml
1
 
<?xml version="1.0" encoding="UTF-8" ?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
 
5
 
<refentry id="GimpPathEditor">
6
 
<refmeta>
7
 
<refentrytitle role="top_of_page" id="GimpPathEditor.top_of_page">GimpPathEditor</refentrytitle>
8
 
<manvolnum>3</manvolnum>
9
 
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
10
 
</refmeta>
11
 
 
12
 
<refnamediv>
13
 
<refname>GimpPathEditor</refname>
14
 
<refpurpose>Widget for editing a file search path.</refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="GimpPathEditor.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>
21
 
                    <link linkend="GimpPathEditor-struct">GimpPathEditor</link>;
22
 
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-path-editor-new">gimp_path_editor_new</link>                (const <link linkend="gchar">gchar</link> *title,
23
 
                                                         const <link linkend="gchar">gchar</link> *path);
24
 
<link linkend="gchar">gchar</link> *             <link linkend="gimp-path-editor-get-path">gimp_path_editor_get_path</link>           (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor);
25
 
<link linkend="void">void</link>                <link linkend="gimp-path-editor-set-path">gimp_path_editor_set_path</link>           (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
26
 
                                                         const <link linkend="gchar">gchar</link> *path);
27
 
<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);
28
 
<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,
29
 
                                                         const <link linkend="gchar">gchar</link> *path);
30
 
<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,
31
 
                                                         const <link linkend="gchar">gchar</link> *directory);
32
 
<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,
33
 
                                                         const <link linkend="gchar">gchar</link> *directory,
34
 
                                                         <link linkend="gboolean">gboolean</link> writable);
35
 
</synopsis>
36
 
</refsynopsisdiv>
37
 
 
38
 
<refsect1 id="GimpPathEditor.object-hierarchy" role="object_hierarchy">
39
 
<title role="object_hierarchy.title">Object Hierarchy</title>
40
 
<synopsis>
41
 
  <link linkend="GObject">GObject</link>
42
 
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
43
 
         +----<link linkend="GtkObject">GtkObject</link>
44
 
               +----<link linkend="GtkWidget">GtkWidget</link>
45
 
                     +----<link linkend="GtkContainer">GtkContainer</link>
46
 
                           +----<link linkend="GtkBox">GtkBox</link>
47
 
                                 +----<link linkend="GtkVBox">GtkVBox</link>
48
 
                                       +----GimpPathEditor
49
 
</synopsis>
50
 
</refsect1>
51
 
 
52
 
 
53
 
 
54
 
<refsect1 id="GimpPathEditor.implemented-interfaces" role="impl_interfaces">
55
 
<title role="impl_interfaces.title">Implemented Interfaces</title>
56
 
<para>
57
 
GimpPathEditor implements
58
 
 <link linkend="GtkBuildable">GtkBuildable</link>,  <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkOrientable">GtkOrientable</link>.</para>
59
 
</refsect1>
60
 
 
61
 
 
62
 
 
63
 
<refsect1 id="GimpPathEditor.signals" role="signal_proto">
64
 
<title role="signal_proto.title">Signals</title>
65
 
<synopsis>
66
 
  &quot;<link linkend="GimpPathEditor-path-changed">path-changed</link>&quot;                                   : Run First
67
 
  &quot;<link linkend="GimpPathEditor-writable-changed">writable-changed</link>&quot;                               : Run First
68
 
</synopsis>
69
 
</refsect1>
70
 
 
71
 
 
72
 
<refsect1 id="GimpPathEditor.description" role="desc">
73
 
<title role="desc.title">Description</title>
74
 
<para>
75
 
This widget is used to edit file search paths.
76
 
</para>
77
 
<para>
78
 
It shows a list of all directories which are in the search path. You
79
 
can click a directory to select it. The widget provides a
80
 
<link linkend="GimpFileEntry"><type>GimpFileEntry</type></link> to change the currently selected directory.
81
 
</para>
82
 
<para>
83
 
There are buttons to add or delete directories as well as "up" and "down"
84
 
buttons to change the order in which the directories will be searched.
85
 
</para>
86
 
<para>
87
 
Whenever the user adds, deletes, changes or reorders a directory of
88
 
the search path, the "path_changed" signal will be emitted.
89
 
</para>
90
 
</refsect1>
91
 
 
92
 
<refsect1 id="GimpPathEditor.details" role="details">
93
 
<title role="details.title">Details</title>
94
 
<refsect2 id="GimpPathEditor-struct" role="struct">
95
 
<title>GimpPathEditor</title>
96
 
<indexterm zone="GimpPathEditor-struct"><primary sortas="GimpPathEditor">GimpPathEditor</primary></indexterm><programlisting>typedef struct _GimpPathEditor GimpPathEditor;</programlisting>
97
 
<para>
98
 
</para></refsect2>
99
 
<refsect2 id="gimp-path-editor-new" role="function">
100
 
<title>gimp_path_editor_new ()</title>
101
 
<indexterm zone="gimp-path-editor-new"><primary sortas="gimp_path_editor_new">gimp_path_editor_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_path_editor_new                (const <link linkend="gchar">gchar</link> *title,
102
 
                                                         const <link linkend="gchar">gchar</link> *path);</programlisting>
103
 
<para>
104
 
Creates a new <link linkend="GimpPathEditor"><type>GimpPathEditor</type></link> widget.
105
 
</para>
106
 
<para>
107
 
The elements of the initial search path must be separated with the
108
 
<link linkend="G-SEARCHPATH-SEPARATOR--CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> character.</para>
109
 
<para>
110
 
</para><variablelist role="params">
111
 
<varlistentry><term><parameter>title</parameter>&#160;:</term>
112
 
<listitem><simpara> The title of the <link linkend="GtkFileChooser"><type>GtkFileChooser</type></link> dialog which can be popped up.
113
 
</simpara></listitem></varlistentry>
114
 
<varlistentry><term><parameter>path</parameter>&#160;:</term>
115
 
<listitem><simpara>  The initial search path.
116
 
</simpara></listitem></varlistentry>
117
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A pointer to the new <link linkend="GimpPathEditor"><type>GimpPathEditor</type></link> widget.
118
 
</simpara></listitem></varlistentry>
119
 
</variablelist></refsect2>
120
 
<refsect2 id="gimp-path-editor-get-path" role="function">
121
 
<title>gimp_path_editor_get_path ()</title>
122
 
<indexterm zone="gimp-path-editor-get-path"><primary sortas="gimp_path_editor_get_path">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>
123
 
<para>
124
 
The elements of the returned search path string are separated with the
125
 
<link linkend="G-SEARCHPATH-SEPARATOR--CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> character.
126
 
</para>
127
 
<para>
128
 
Note that you have to <link linkend="g-free"><function>g_free()</function></link> the returned string.</para>
129
 
<para>
130
 
</para><variablelist role="params">
131
 
<varlistentry><term><parameter>editor</parameter>&#160;:</term>
132
 
<listitem><simpara> The path editor you want to get the search path from.
133
 
</simpara></listitem></varlistentry>
134
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The search path the user has selected in the path editor.
135
 
</simpara></listitem></varlistentry>
136
 
</variablelist></refsect2>
137
 
<refsect2 id="gimp-path-editor-set-path" role="function">
138
 
<title>gimp_path_editor_set_path ()</title>
139
 
<indexterm zone="gimp-path-editor-set-path"><primary sortas="gimp_path_editor_set_path">gimp_path_editor_set_path</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_path_editor_set_path           (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
140
 
                                                         const <link linkend="gchar">gchar</link> *path);</programlisting>
141
 
<para>
142
 
The elements of the initial search path must be separated with the
143
 
<link linkend="G-SEARCHPATH-SEPARATOR--CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> character.</para>
144
 
<para>
145
 
</para><variablelist role="params">
146
 
<varlistentry><term><parameter>editor</parameter>&#160;:</term>
147
 
<listitem><simpara> The path editor you want to set the search path from.
148
 
</simpara></listitem></varlistentry>
149
 
<varlistentry><term><parameter>path</parameter>&#160;:</term>
150
 
<listitem><simpara>   The new path to set.
151
 
</simpara></listitem></varlistentry>
152
 
</variablelist></refsect2>
153
 
<refsect2 id="gimp-path-editor-get-writable-path" role="function">
154
 
<title>gimp_path_editor_get_writable_path ()</title>
155
 
<indexterm zone="gimp-path-editor-get-writable-path"><primary sortas="gimp_path_editor_get_writable_path">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>
156
 
<para>
157
 
</para><variablelist role="params">
158
 
<varlistentry><term><parameter>editor</parameter>&#160;:</term>
159
 
<listitem><simpara>
160
 
</simpara></listitem></varlistentry>
161
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
162
 
</simpara></listitem></varlistentry>
163
 
</variablelist></refsect2>
164
 
<refsect2 id="gimp-path-editor-set-writable-path" role="function">
165
 
<title>gimp_path_editor_set_writable_path ()</title>
166
 
<indexterm zone="gimp-path-editor-set-writable-path"><primary sortas="gimp_path_editor_set_writable_path">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,
167
 
                                                         const <link linkend="gchar">gchar</link> *path);</programlisting>
168
 
<para>
169
 
</para><variablelist role="params">
170
 
<varlistentry><term><parameter>editor</parameter>&#160;:</term>
171
 
<listitem><simpara>
172
 
</simpara></listitem></varlistentry>
173
 
<varlistentry><term><parameter>path</parameter>&#160;:</term>
174
 
<listitem><simpara>
175
 
</simpara></listitem></varlistentry>
176
 
</variablelist></refsect2>
177
 
<refsect2 id="gimp-path-editor-get-dir-writable" role="function">
178
 
<title>gimp_path_editor_get_dir_writable ()</title>
179
 
<indexterm zone="gimp-path-editor-get-dir-writable"><primary sortas="gimp_path_editor_get_dir_writable">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,
180
 
                                                         const <link linkend="gchar">gchar</link> *directory);</programlisting>
181
 
<para>
182
 
</para><variablelist role="params">
183
 
<varlistentry><term><parameter>editor</parameter>&#160;:</term>
184
 
<listitem><simpara>
185
 
</simpara></listitem></varlistentry>
186
 
<varlistentry><term><parameter>directory</parameter>&#160;:</term>
187
 
<listitem><simpara>
188
 
</simpara></listitem></varlistentry>
189
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
190
 
</simpara></listitem></varlistentry>
191
 
</variablelist></refsect2>
192
 
<refsect2 id="gimp-path-editor-set-dir-writable" role="function">
193
 
<title>gimp_path_editor_set_dir_writable ()</title>
194
 
<indexterm zone="gimp-path-editor-set-dir-writable"><primary sortas="gimp_path_editor_set_dir_writable">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,
195
 
                                                         const <link linkend="gchar">gchar</link> *directory,
196
 
                                                         <link linkend="gboolean">gboolean</link> writable);</programlisting>
197
 
<para>
198
 
</para><variablelist role="params">
199
 
<varlistentry><term><parameter>editor</parameter>&#160;:</term>
200
 
<listitem><simpara>
201
 
</simpara></listitem></varlistentry>
202
 
<varlistentry><term><parameter>directory</parameter>&#160;:</term>
203
 
<listitem><simpara>
204
 
</simpara></listitem></varlistentry>
205
 
<varlistentry><term><parameter>writable</parameter>&#160;:</term>
206
 
<listitem><simpara>
207
 
</simpara></listitem></varlistentry>
208
 
</variablelist></refsect2>
209
 
 
210
 
</refsect1>
211
 
 
212
 
<refsect1 id="GimpPathEditor.signal-details" role="signals">
213
 
<title role="signals.title">Signal Details</title>
214
 
<refsect2 id="GimpPathEditor-path-changed" role="signal"><title>The <literal>&quot;path-changed&quot;</literal> signal</title>
215
 
<indexterm zone="GimpPathEditor-path-changed"><primary sortas="GimpPathEditor::path-changed">GimpPathEditor::path-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpPathEditor">GimpPathEditor</link> *arg0,
216
 
                                                        <link linkend="gpointer">gpointer</link>        user_data)      : Run First</programlisting>
217
 
<para>
218
 
This signal is emitted whenever the user adds, deletes, modifies
219
 
or reorders an element of the search path.</para>
220
 
<para>
221
 
</para><variablelist role="params">
222
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
223
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
224
 
</variablelist></refsect2><refsect2 id="GimpPathEditor-writable-changed" role="signal"><title>The <literal>&quot;writable-changed&quot;</literal> signal</title>
225
 
<indexterm zone="GimpPathEditor-writable-changed"><primary sortas="GimpPathEditor::writable-changed">GimpPathEditor::writable-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpPathEditor">GimpPathEditor</link> *arg0,
226
 
                                                        <link linkend="gpointer">gpointer</link>        user_data)      : Run First</programlisting>
227
 
<para>
228
 
This signal is emitted whenever the "writable" column of a directory
229
 
is changed, either by the user clicking on it or by calling
230
 
<link linkend="gimp-path-editor-set-dir-writable"><function>gimp_path_editor_set_dir_writable()</function></link>.</para>
231
 
<para>
232
 
</para><variablelist role="params">
233
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
234
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
235
 
</variablelist></refsect2>
236
 
</refsect1>
237
 
 
238
 
 
239
 
<refsect1 id="GimpPathEditor.see-also">
240
 
<title>See Also</title>
241
 
<para>
242
 
<link linkend="GimpFileEntry"><type>GimpFileEntry</type></link>
243
 
</para>
244
 
<para>
245
 
<link linkend="G-SEARCHPATH-SEPARATOR--CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link>
246
 
</para>
247
 
</refsect1>
248
 
 
249
 
</refentry>