← Back to branch summary

~ubuntu-branches/ubuntu/edgy/gimp/edgy-proposed

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2006-08-28 16:54:33 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20060828165433-4a009iph3a8lq78s
Tags: 2.2.13-1ubuntu1
* Sync with Debian
* New upstream version, UVF exception granted by Colin Watson
* debian/patches/10_dont_show_wizard.patch:
  - don't use the setup wizard on first run
* debian/rules:
  - add gettext domain to the .desktop
  - run "intltool-update -p" for the different po directories of the package

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimppatheditor.xml
4
4
 
5
5
<refentry id="GimpPathEditor">
6
6
<refmeta>
7
 
<refentrytitle>GimpPathEditor</refentrytitle>
 
7
<refentrytitle id="top_of_page">GimpPathEditor</refentrytitle>
8
8
<manvolnum>3</manvolnum>
9
9
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
10
10
</refmeta>
11
11
 
12
12
<refnamediv>
13
 
<refname>GimpPathEditor</refname><refpurpose>Widget for editing a file search path.</refpurpose>
 
13
<refname>GimpPathEditor</refname>
 
14
<refpurpose>Widget for editing a file search path.</refpurpose>
 
15
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
14
16
</refnamediv>
15
17
 
16
 
<refsynopsisdiv><title>Synopsis</title>
 
18
<refsynopsisdiv id="synopsis">
 
19
<title id="synopsis.title">Synopsis</title>
17
20
 
18
21
<synopsis>
19
22
 
41
44
</synopsis>
42
45
</refsynopsisdiv>
43
46
 
44
 
<refsect1>
45
 
<title>Object Hierarchy</title>
 
47
<refsect1 id="object_hierarchy">
 
48
<title id="object_hierarchy.title">Object Hierarchy</title>
46
49
<synopsis>
47
50
 
48
51
  <link linkend="GObject">GObject</link>
49
 
   +----<link linkend="GtkObject">GtkObject</link>
50
 
         +----<link linkend="GtkWidget">GtkWidget</link>
51
 
               +----<link linkend="GtkContainer">GtkContainer</link>
52
 
                     +----<link linkend="GtkBox">GtkBox</link>
53
 
                           +----<link linkend="GtkVBox">GtkVBox</link>
54
 
                                 +----GimpPathEditor
 
52
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
 
53
         +----<link linkend="GtkObject">GtkObject</link>
 
54
               +----<link linkend="GtkWidget">GtkWidget</link>
 
55
                     +----<link linkend="GtkContainer">GtkContainer</link>
 
56
                           +----<link linkend="GtkBox">GtkBox</link>
 
57
                                 +----<link linkend="GtkVBox">GtkVBox</link>
 
58
                                       +----GimpPathEditor
55
59
</synopsis>
56
60
 
57
61
</refsect1>
58
62
 
59
63
 
60
64
 
61
 
<refsect1>
62
 
<title>Implemented Interfaces</title>
 
65
<refsect1 id="impl_interfaces">
 
66
<title id="impl_interfaces.title">Implemented Interfaces</title>
63
67
<para>
64
68
GimpPathEditor implements
65
69
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
68
72
 
69
73
 
70
74
 
71
 
<refsect1>
72
 
<title>Signal Prototypes</title>
 
75
<refsect1 id="signal_proto">
 
76
<title id="signal_proto.title">Signals</title>
73
77
<synopsis>
74
78
 
75
79
&quot;<link linkend="GimpPathEditor-path-changed">path-changed</link>&quot;
76
80
            <link linkend="void">void</link>        user_function      (<link linkend="GimpPathEditor">GimpPathEditor</link> *arg0,
77
 
                                            <link linkend="gpointer">gpointer</link> user_data);
 
81
                                            <link linkend="gpointer">gpointer</link>        user_data)      : Run first
78
82
&quot;<link linkend="GimpPathEditor-writable-changed">writable-changed</link>&quot;
79
83
            <link linkend="void">void</link>        user_function      (<link linkend="GimpPathEditor">GimpPathEditor</link> *arg0,
80
 
                                            <link linkend="gpointer">gpointer</link> user_data);
 
84
                                            <link linkend="gpointer">gpointer</link>        user_data)      : Run first
81
85
</synopsis>
82
86
</refsect1>
83
87
 
84
88
 
85
 
<refsect1>
86
 
<title>Description</title>
 
89
<refsect1 id="desc">
 
90
<title id="desc.title">Description</title>
87
91
<para>
88
92
This widget is used to edit file search paths.
89
93
</para>
102
106
</para>
103
107
</refsect1>
104
108
 
105
 
<refsect1>
106
 
<title>Details</title>
 
109
<refsect1 id="details">
 
110
<title id="details.title">Details</title>
107
111
<refsect2>
108
 
<title><anchor id="GimpPathEditor-struct"/>GimpPathEditor</title>
 
112
<title><anchor id="GimpPathEditor-struct" role="struct"/>GimpPathEditor</title>
109
113
<indexterm><primary>GimpPathEditor</primary></indexterm><programlisting>typedef struct _GimpPathEditor GimpPathEditor;</programlisting>
110
114
<para>
111
115
 
112
116
</para></refsect2>
113
117
<refsect2>
114
 
<title><anchor id="gimp-path-editor-new"/>gimp_path_editor_new ()</title>
 
118
<title><anchor id="gimp-path-editor-new" role="function"/>gimp_path_editor_new ()</title>
115
119
<indexterm><primary>gimp_path_editor_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gimp_path_editor_new            (const <link linkend="gchar">gchar</link> *filesel_title,
116
120
                                             const <link linkend="gchar">gchar</link> *path);</programlisting>
117
121
<para>
134
138
</simpara></listitem></varlistentry>
135
139
</variablelist></refsect2>
136
140
<refsect2>
137
 
<title><anchor id="gimp-path-editor-get-path"/>gimp_path_editor_get_path ()</title>
 
141
<title><anchor id="gimp-path-editor-get-path" role="function"/>gimp_path_editor_get_path ()</title>
138
142
<indexterm><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>
139
143
<para>
140
144
The elements of the returned search path string are separated with the
152
156
</simpara></listitem></varlistentry>
153
157
</variablelist></refsect2>
154
158
<refsect2>
155
 
<title><anchor id="gimp-path-editor-set-path"/>gimp_path_editor_set_path ()</title>
 
159
<title><anchor id="gimp-path-editor-set-path" role="function"/>gimp_path_editor_set_path ()</title>
156
160
<indexterm><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,
157
161
                                             const <link linkend="gchar">gchar</link> *path);</programlisting>
158
162
<para>
169
173
</simpara></listitem></varlistentry>
170
174
</variablelist></refsect2>
171
175
<refsect2>
172
 
<title><anchor id="gimp-path-editor-get-writable-path"/>gimp_path_editor_get_writable_path ()</title>
 
176
<title><anchor id="gimp-path-editor-get-writable-path" role="function"/>gimp_path_editor_get_writable_path ()</title>
173
177
<indexterm><primary>gimp_path_editor_get_writable_path</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_path_editor_get_writable_path
174
178
                                            (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor);</programlisting>
175
179
<para>
184
188
</simpara></listitem></varlistentry>
185
189
</variablelist></refsect2>
186
190
<refsect2>
187
 
<title><anchor id="gimp-path-editor-set-writable-path"/>gimp_path_editor_set_writable_path ()</title>
 
191
<title><anchor id="gimp-path-editor-set-writable-path" role="function"/>gimp_path_editor_set_writable_path ()</title>
188
192
<indexterm><primary>gimp_path_editor_set_writable_path</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_path_editor_set_writable_path
189
193
                                            (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
190
194
                                             const <link linkend="gchar">gchar</link> *path);</programlisting>
201
205
</simpara></listitem></varlistentry>
202
206
</variablelist></refsect2>
203
207
<refsect2>
204
 
<title><anchor id="gimp-path-editor-get-dir-writable"/>gimp_path_editor_get_dir_writable ()</title>
 
208
<title><anchor id="gimp-path-editor-get-dir-writable" role="function"/>gimp_path_editor_get_dir_writable ()</title>
205
209
<indexterm><primary>gimp_path_editor_get_dir_writable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_path_editor_get_dir_writable
206
210
                                            (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
207
211
                                             const <link linkend="gchar">gchar</link> *directory);</programlisting>
220
224
</simpara></listitem></varlistentry>
221
225
</variablelist></refsect2>
222
226
<refsect2>
223
 
<title><anchor id="gimp-path-editor-set-dir-writable"/>gimp_path_editor_set_dir_writable ()</title>
 
227
<title><anchor id="gimp-path-editor-set-dir-writable" role="function"/>gimp_path_editor_set_dir_writable ()</title>
224
228
<indexterm><primary>gimp_path_editor_set_dir_writable</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_path_editor_set_dir_writable
225
229
                                            (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
226
230
                                             const <link linkend="gchar">gchar</link> *directory,
243
247
 
244
248
</refsect1>
245
249
 
246
 
<refsect1>
247
 
<title>Signals</title>
 
250
<refsect1 id="signals">
 
251
<title id="signals.title">Signal Details</title>
248
252
<refsect2><title><anchor id="GimpPathEditor-path-changed"/>The &quot;path-changed&quot; signal</title>
249
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="GimpPathEditor">GimpPathEditor</link> *arg0,
250
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
253
<indexterm><primary>GimpPathEditor::path-changed</primary></indexterm><programlisting><link linkend="void">void</link>        user_function                  (<link linkend="GimpPathEditor">GimpPathEditor</link> *arg0,
 
254
                                            <link linkend="gpointer">gpointer</link>        user_data)      : Run first</programlisting>
251
255
<para>
252
256
This signal is emitted whenever the user adds, deletes, modifies
253
257
or reorders an element of the search path.</para>
257
261
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
258
262
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
259
263
</variablelist></refsect2><refsect2><title><anchor id="GimpPathEditor-writable-changed"/>The &quot;writable-changed&quot; signal</title>
260
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="GimpPathEditor">GimpPathEditor</link> *arg0,
261
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
264
<indexterm><primary>GimpPathEditor::writable-changed</primary></indexterm><programlisting><link linkend="void">void</link>        user_function                  (<link linkend="GimpPathEditor">GimpPathEditor</link> *arg0,
 
265
                                            <link linkend="gpointer">gpointer</link>        user_data)      : Run first</programlisting>
262
266
<para>
263
267
This signal is emitted whenever the "writable" column of a directory
264
268
is changed, either by the user clicking on it or by calling