← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gimp/trusty

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Ari Pollak
  • Date: 2009-08-14 09:57:17 UTC
  • mto: (1.1.21 upstream) (0.1.5 squeeze)
  • mto: This revision was merged to the branch mainline in revision 48.
  • Revision ID: james.westby@ubuntu.com-20090814095717-37dh2xqy5t0rurpk
Import upstream version 2.6.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimppatheditor.xml
12
12
<refnamediv>
13
13
<refname>GimpPathEditor</refname>
14
14
<refpurpose>Widget for editing a file search path.</refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="GimpPathEditor.synopsis" role="synopsis">
20
19
 
21
20
<synopsis>
22
21
                    <link linkend="GimpPathEditor-struct">GimpPathEditor</link>;
23
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-path-editor-new">gimp_path_editor_new</link>                (const <link linkend="gchar">gchar</link> *title,
 
22
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-path-editor-new">gimp_path_editor_new</link>                (const <link linkend="gchar">gchar</link> *title,
24
23
                                                         const <link linkend="gchar">gchar</link> *path);
25
 
<link linkend="gchar">gchar</link>*              <link linkend="gimp-path-editor-get-path">gimp_path_editor_get_path</link>           (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor);
 
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);
26
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,
27
26
                                                         const <link linkend="gchar">gchar</link> *path);
28
 
<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);
 
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);
29
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,
30
29
                                                         const <link linkend="gchar">gchar</link> *path);
31
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,
48
47
                                 +----<link linkend="GtkVBox">GtkVBox</link>
49
48
                                       +----GimpPathEditor
50
49
</synopsis>
51
 
 
52
50
</refsect1>
53
51
 
54
52
 
57
55
<title role="impl_interfaces.title">Implemented Interfaces</title>
58
56
<para>
59
57
GimpPathEditor implements
60
 
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
61
 
 
 
58
 <link linkend="GtkBuildable">GtkBuildable</link>,  <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkOrientable">GtkOrientable</link>.</para>
62
59
</refsect1>
63
60
 
64
61
 
96
93
<title role="details.title">Details</title>
97
94
<refsect2 id="GimpPathEditor-struct" role="struct">
98
95
<title>GimpPathEditor</title>
99
 
<indexterm zone="GimpPathEditor-struct"><primary>GimpPathEditor</primary></indexterm><programlisting>typedef struct _GimpPathEditor GimpPathEditor;</programlisting>
 
96
<indexterm zone="GimpPathEditor-struct"><primary sortas="GimpPathEditor">GimpPathEditor</primary></indexterm><programlisting>typedef struct _GimpPathEditor GimpPathEditor;</programlisting>
100
97
<para>
101
 
 
102
98
</para></refsect2>
103
99
<refsect2 id="gimp-path-editor-new" role="function">
104
100
<title>gimp_path_editor_new ()</title>
105
 
<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,
 
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,
106
102
                                                         const <link linkend="gchar">gchar</link> *path);</programlisting>
107
103
<para>
108
104
Creates a new <link linkend="GimpPathEditor"><type>GimpPathEditor</type></link> widget.
109
105
</para>
110
106
<para>
111
107
The elements of the initial search path must be separated with the
112
 
<link linkend="G-SEARCHPATH-SEPARATOR:CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> character.</para>
 
108
<link linkend="G-SEARCHPATH-SEPARATOR--CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> character.</para>
113
109
<para>
114
 
 
115
110
</para><variablelist role="params">
116
 
<varlistentry><term><parameter>title</parameter>&nbsp;:</term>
 
111
<varlistentry><term><parameter>title</parameter>&#160;:</term>
117
112
<listitem><simpara> The title of the <link linkend="GtkFileChooser"><type>GtkFileChooser</type></link> dialog which can be popped up.
118
113
</simpara></listitem></varlistentry>
119
 
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
 
114
<varlistentry><term><parameter>path</parameter>&#160;:</term>
120
115
<listitem><simpara>  The initial search path.
121
116
</simpara></listitem></varlistentry>
122
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A pointer to the new <link linkend="GimpPathEditor"><type>GimpPathEditor</type></link> widget.
 
117
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A pointer to the new <link linkend="GimpPathEditor"><type>GimpPathEditor</type></link> widget.
123
118
</simpara></listitem></varlistentry>
124
119
</variablelist></refsect2>
125
120
<refsect2 id="gimp-path-editor-get-path" role="function">
126
121
<title>gimp_path_editor_get_path ()</title>
127
 
<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>
 
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>
128
123
<para>
129
124
The elements of the returned search path string are separated with the
130
 
<link linkend="G-SEARCHPATH-SEPARATOR:CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> character.
 
125
<link linkend="G-SEARCHPATH-SEPARATOR--CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> character.
131
126
</para>
132
127
<para>
133
128
Note that you have to <link linkend="g-free"><function>g_free()</function></link> the returned string.</para>
134
129
<para>
135
 
 
136
130
</para><variablelist role="params">
137
 
<varlistentry><term><parameter>editor</parameter>&nbsp;:</term>
 
131
<varlistentry><term><parameter>editor</parameter>&#160;:</term>
138
132
<listitem><simpara> The path editor you want to get the search path from.
139
133
</simpara></listitem></varlistentry>
140
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The search path the user has selected in the path editor.
 
134
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The search path the user has selected in the path editor.
141
135
</simpara></listitem></varlistentry>
142
136
</variablelist></refsect2>
143
137
<refsect2 id="gimp-path-editor-set-path" role="function">
144
138
<title>gimp_path_editor_set_path ()</title>
145
 
<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,
 
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,
146
140
                                                         const <link linkend="gchar">gchar</link> *path);</programlisting>
147
141
<para>
148
142
The elements of the initial search path must be separated with the
149
 
<link linkend="G-SEARCHPATH-SEPARATOR:CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> character.</para>
 
143
<link linkend="G-SEARCHPATH-SEPARATOR--CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> character.</para>
150
144
<para>
151
 
 
152
145
</para><variablelist role="params">
153
 
<varlistentry><term><parameter>editor</parameter>&nbsp;:</term>
 
146
<varlistentry><term><parameter>editor</parameter>&#160;:</term>
154
147
<listitem><simpara> The path editor you want to set the search path from.
155
148
</simpara></listitem></varlistentry>
156
 
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
 
149
<varlistentry><term><parameter>path</parameter>&#160;:</term>
157
150
<listitem><simpara>   The new path to set.
158
151
</simpara></listitem></varlistentry>
159
152
</variablelist></refsect2>
160
153
<refsect2 id="gimp-path-editor-get-writable-path" role="function">
161
154
<title>gimp_path_editor_get_writable_path ()</title>
162
 
<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>
 
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>
163
156
<para>
164
 
 
165
157
</para><variablelist role="params">
166
 
<varlistentry><term><parameter>editor</parameter>&nbsp;:</term>
 
158
<varlistentry><term><parameter>editor</parameter>&#160;:</term>
167
159
<listitem><simpara>
168
160
</simpara></listitem></varlistentry>
169
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
170
 
 
171
 
 
 
161
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
172
162
</simpara></listitem></varlistentry>
173
163
</variablelist></refsect2>
174
164
<refsect2 id="gimp-path-editor-set-writable-path" role="function">
175
165
<title>gimp_path_editor_set_writable_path ()</title>
176
 
<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,
 
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,
177
167
                                                         const <link linkend="gchar">gchar</link> *path);</programlisting>
178
168
<para>
179
 
 
180
169
</para><variablelist role="params">
181
 
<varlistentry><term><parameter>editor</parameter>&nbsp;:</term>
 
170
<varlistentry><term><parameter>editor</parameter>&#160;:</term>
182
171
<listitem><simpara>
183
172
</simpara></listitem></varlistentry>
184
 
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
 
173
<varlistentry><term><parameter>path</parameter>&#160;:</term>
185
174
<listitem><simpara>
186
 
 
187
 
 
188
175
</simpara></listitem></varlistentry>
189
176
</variablelist></refsect2>
190
177
<refsect2 id="gimp-path-editor-get-dir-writable" role="function">
191
178
<title>gimp_path_editor_get_dir_writable ()</title>
192
 
<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,
 
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,
193
180
                                                         const <link linkend="gchar">gchar</link> *directory);</programlisting>
194
181
<para>
195
 
 
196
182
</para><variablelist role="params">
197
 
<varlistentry><term><parameter>editor</parameter>&nbsp;:</term>
198
 
<listitem><simpara>
199
 
</simpara></listitem></varlistentry>
200
 
<varlistentry><term><parameter>directory</parameter>&nbsp;:</term>
201
 
<listitem><simpara>
202
 
</simpara></listitem></varlistentry>
203
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
204
 
 
205
 
 
 
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>
206
190
</simpara></listitem></varlistentry>
207
191
</variablelist></refsect2>
208
192
<refsect2 id="gimp-path-editor-set-dir-writable" role="function">
209
193
<title>gimp_path_editor_set_dir_writable ()</title>
210
 
<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,
 
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,
211
195
                                                         const <link linkend="gchar">gchar</link> *directory,
212
196
                                                         <link linkend="gboolean">gboolean</link> writable);</programlisting>
213
197
<para>
214
 
 
215
198
</para><variablelist role="params">
216
 
<varlistentry><term><parameter>editor</parameter>&nbsp;:</term>
217
 
<listitem><simpara>
218
 
</simpara></listitem></varlistentry>
219
 
<varlistentry><term><parameter>directory</parameter>&nbsp;:</term>
220
 
<listitem><simpara>
221
 
</simpara></listitem></varlistentry>
222
 
<varlistentry><term><parameter>writable</parameter>&nbsp;:</term>
223
 
<listitem><simpara>
224
 
 
225
 
 
 
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>
226
207
</simpara></listitem></varlistentry>
227
208
</variablelist></refsect2>
228
209
 
230
211
 
231
212
<refsect1 id="GimpPathEditor.signal-details" role="signals">
232
213
<title role="signals.title">Signal Details</title>
233
 
<refsect2 id="GimpPathEditor-path-changed"><title>The <literal>&quot;path-changed&quot;</literal> signal</title>
234
 
<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,
 
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,
235
216
                                                        <link linkend="gpointer">gpointer</link>        user_data)      : Run First</programlisting>
236
217
<para>
237
218
This signal is emitted whenever the user adds, deletes, modifies
238
219
or reorders an element of the search path.</para>
239
220
<para>
240
 
 
241
221
</para><variablelist role="params">
242
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
222
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
243
223
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
244
 
</variablelist></refsect2><refsect2 id="GimpPathEditor-writable-changed"><title>The <literal>&quot;writable-changed&quot;</literal> signal</title>
245
 
<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,
 
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,
246
226
                                                        <link linkend="gpointer">gpointer</link>        user_data)      : Run First</programlisting>
247
227
<para>
248
228
This signal is emitted whenever the "writable" column of a directory
249
229
is changed, either by the user clicking on it or by calling
250
230
<link linkend="gimp-path-editor-set-dir-writable"><function>gimp_path_editor_set_dir_writable()</function></link>.</para>
251
231
<para>
252
 
 
253
232
</para><variablelist role="params">
254
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
233
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
255
234
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
256
235
</variablelist></refsect2>
257
236
</refsect1>
263
242
<link linkend="GimpFileEntry"><type>GimpFileEntry</type></link>
264
243
</para>
265
244
<para>
266
 
<link linkend="G-SEARCHPATH-SEPARATOR:CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link>
 
245
<link linkend="G-SEARCHPATH-SEPARATOR--CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link>
267
246
</para>
268
247
</refsect1>
269
248