File: GimpPathEditor.html

package info (click to toggle)
gimp 2.2.6-1sarge4
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 97,088 kB
  • ctags: 43,756
  • sloc: ansic: 525,782; xml: 36,543; lisp: 9,851; sh: 9,007; makefile: 7,974; python: 2,622; perl: 2,589; yacc: 520; lex: 334
file content (208 lines) | stat: -rw-r--r-- 17,519 bytes parent folder | download
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
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>GimpPathEditor</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual"><link rel="up" href="libgimpwidgets-widgets.html" title="PartI.GIMP Widgets"><link rel="prev" href="GimpOffsetArea.html" title="GimpOffsetArea"><link rel="next" href="GimpPickButton.html" title="GimpPickButton"><meta name="generator" content="GTK-Doc V1.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpwidgets-widgets.html" title="PartI.GIMP Widgets"><link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy"><link rel="chapter" href="libgimpwidgets-cell-renderers.html" title="Cell Renderers for GtkTreeView"><link rel="part" href="libgimpwidgets-colordisplay.html" title="PartII.GIMP Display Filters"><link rel="part" href="libgimpwidgets-colorselector.html" title="PartIII.GIMP Color Selectors"><link rel="part" href="libgimpwidgets-controller.html" title="PartIV.GIMP Controllers"><link rel="part" href="libgimpwidgets-utils.html" title="PartV.GIMP Widgets Utilities"><link rel="part" href="libgimpwidgets-deprecated.html" title="PartVI.Deprecated API"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="GimpOffsetArea.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="libgimpwidgets-widgets.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">GIMP Widgets Library Reference Manual</th><td><a accesskey="n" href="GimpPickButton.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="GimpPathEditor"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><span class="refentrytitle">GimpPathEditor</span></h2><p>GimpPathEditor &#8212; Widget for editing a file search path.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">



            <a href="GimpPathEditor.html#GimpPathEditor-struct">GimpPathEditor</a>;
<a
href="../gtk/GtkWidget.html"
>GtkWidget</a>*  <a href="GimpPathEditor.html#gimp-path-editor-new">gimp_path_editor_new</a>            (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *filesel_title,
                                             const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *path);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>*      <a href="GimpPathEditor.html#gimp-path-editor-get-path">gimp_path_editor_get_path</a>       (<a href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor);
void        <a href="GimpPathEditor.html#gimp-path-editor-set-path">gimp_path_editor_set_path</a>       (<a href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
                                             const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *path);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>*      <a href="GimpPathEditor.html#gimp-path-editor-get-writable-path">gimp_path_editor_get_writable_path</a>
                                            (<a href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor);
void        <a href="GimpPathEditor.html#gimp-path-editor-set-writable-path">gimp_path_editor_set_writable_path</a>
                                            (<a href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
                                             const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *path);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a>    <a href="GimpPathEditor.html#gimp-path-editor-get-dir-writable">gimp_path_editor_get_dir_writable</a>
                                            (<a href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
                                             const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *directory);
void        <a href="GimpPathEditor.html#gimp-path-editor-set-dir-writable">gimp_path_editor_set_dir_writable</a>
                                            (<a href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
                                             const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *directory,
                                             <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> writable);

</pre></div><div class="refsect1" lang="en"><a name="id2590171"></a><h2>Object Hierarchy</h2><pre class="synopsis">

  <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
   +----<a
href="../gtk/GtkObject.html"
>GtkObject</a>
         +----<a
href="../gtk/GtkWidget.html"
>GtkWidget</a>
               +----<a
href="../gtk/GtkContainer.html"
>GtkContainer</a>
                     +----<a
href="../gtk/GtkBox.html"
>GtkBox</a>
                           +----<a
href="../gtk/GtkVBox.html"
>GtkVBox</a>
                                 +----GimpPathEditor
</pre></div><div class="refsect1" lang="en"><a name="id2591058"></a><h2>Implemented Interfaces</h2><p>
GimpPathEditor implements
 AtkImplementorIface.</p></div><div class="refsect1" lang="en"><a name="id2591073"></a><h2>Signal Prototypes</h2><pre class="synopsis">

"<a href="GimpPathEditor.html#GimpPathEditor-path-changed">path-changed</a>"
            void        user_function      (<a href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *arg0,
                                            <a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);
"<a href="GimpPathEditor.html#GimpPathEditor-writable-changed">writable-changed</a>"
            void        user_function      (<a href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *arg0,
                                            <a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);
</pre></div><div class="refsect1" lang="en"><a name="id2591129"></a><h2>Description</h2><p>
This widget is used to edit file search paths.
</p><p>
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
<a href="GimpFileEntry.html" title="GimpFileEntry"><span class="type">GimpFileEntry</span></a> to change the currently selected directory.
</p><p>
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.
</p><p>
Whenever the user adds, deletes, changes or reorders a directory of
the search path, the "path_changed" signal will be emitted.
</p></div><div class="refsect1" lang="en"><a name="id2587404"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2587409"></a><h3><a name="GimpPathEditor-struct"></a>GimpPathEditor</h3><a class="indexterm" name="id2587417"></a><pre class="programlisting">typedef struct _GimpPathEditor GimpPathEditor;</pre><p>

</p></div><hr><div class="refsect2" lang="en"><a name="id2587428"></a><h3><a name="gimp-path-editor-new"></a>gimp_path_editor_new ()</h3><a class="indexterm" name="id2587436"></a><pre class="programlisting"><a
href="../gtk/GtkWidget.html"
>GtkWidget</a>*  gimp_path_editor_new            (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *filesel_title,
                                             const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *path);</pre><p>
Creates a new <a href="GimpPathEditor.html" title="GimpPathEditor"><span class="type">GimpPathEditor</span></a> widget.
</p><p>
The elements of the initial search path must be separated with the
<a
href="../glib/glib-Standard-Macros.html#G-SEARCHPATH-SEPARATOR--CAPS"
><span class="type">G_SEARCHPATH_SEPARATOR</span></a> character.</p><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>filesel_title</tt></i>:</span></td><td> The title of the <a
href="../gtk/GtkFileSelection.html"
><span class="type">GtkFileSelection</span></a> dialog which can be
                popped up by the attached <span class="type">GimpFileSelection</span>.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>path</tt></i>:</span></td><td>          The initial search path.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td> A pointer to the new <a href="GimpPathEditor.html" title="GimpPathEditor"><span class="type">GimpPathEditor</span></a> widget.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2587538"></a><h3><a name="gimp-path-editor-get-path"></a>gimp_path_editor_get_path ()</h3><a class="indexterm" name="id2587548"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>*      gimp_path_editor_get_path       (<a href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor);</pre><p>
The elements of the returned search path string are separated with the
<a
href="../glib/glib-Standard-Macros.html#G-SEARCHPATH-SEPARATOR--CAPS"
><span class="type">G_SEARCHPATH_SEPARATOR</span></a> character.
</p><p>
Note that you have to <a
href="../glib/glib-Memory-Allocation.html#g-free"
><tt class="function">g_free()</tt></a> the returned string.</p><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>editor</tt></i>:</span></td><td> The path editor you want to get the search path from.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td> The search path the user has selected in the path editor.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2587614"></a><h3><a name="gimp-path-editor-set-path"></a>gimp_path_editor_set_path ()</h3><a class="indexterm" name="id2587623"></a><pre class="programlisting">void        gimp_path_editor_set_path       (<a href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
                                             const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *path);</pre><p>
The elements of the initial search path must be separated with the
<a
href="../glib/glib-Standard-Macros.html#G-SEARCHPATH-SEPARATOR--CAPS"
><span class="type">G_SEARCHPATH_SEPARATOR</span></a> character.</p><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>editor</tt></i>:</span></td><td> The path editor you want to set the search path from.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>path</tt></i>:</span></td><td>   The new path to set.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2588503"></a><h3><a name="gimp-path-editor-get-writable-path"></a>gimp_path_editor_get_writable_path ()</h3><a class="indexterm" name="id2588514"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>*      gimp_path_editor_get_writable_path
                                            (<a href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor);</pre><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>editor</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>


</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2588559"></a><h3><a name="gimp-path-editor-set-writable-path"></a>gimp_path_editor_set_writable_path ()</h3><a class="indexterm" name="id2588570"></a><pre class="programlisting">void        gimp_path_editor_set_writable_path
                                            (<a href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
                                             const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *path);</pre><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>editor</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>path</tt></i>:</span></td><td>


</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2588623"></a><h3><a name="gimp-path-editor-get-dir-writable"></a>gimp_path_editor_get_dir_writable ()</h3><a class="indexterm" name="id2588635"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a>    gimp_path_editor_get_dir_writable
                                            (<a href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
                                             const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *directory);</pre><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>editor</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>directory</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>


</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2588696"></a><h3><a name="gimp-path-editor-set-dir-writable"></a>gimp_path_editor_set_dir_writable ()</h3><a class="indexterm" name="id2588708"></a><pre class="programlisting">void        gimp_path_editor_set_dir_writable
                                            (<a href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *editor,
                                             const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *directory,
                                             <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> writable);</pre><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>editor</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>directory</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>writable</tt></i>:</span></td><td>


</td></tr></tbody></table></div></div></div><div class="refsect1" lang="en"><a name="id2592791"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="id2592796"></a><h3><a name="GimpPathEditor-path-changed"></a>The "path-changed" signal</h3><pre class="programlisting">void        user_function                  (<a href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *arg0,
                                            <a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);</pre><p>
This signal is emitted whenever the user adds, deletes, modifies
or reorders an element of the search path.</p><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i>:</span></td><td>user data set when the signal handler was connected.</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2592845"></a><h3><a name="GimpPathEditor-writable-changed"></a>The "writable-changed" signal</h3><pre class="programlisting">void        user_function                  (<a href="GimpPathEditor.html" title="GimpPathEditor">GimpPathEditor</a> *arg0,
                                            <a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);</pre><p>
This signal is emitted whenever the "writable" column of a directory
is changed, either by the user clicking on it or by calling
<a href="GimpPathEditor.html#gimp-path-editor-set-dir-writable"><tt class="function">gimp_path_editor_set_dir_writable()</tt></a>.</p><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i>:</span></td><td>user data set when the signal handler was connected.</td></tr></tbody></table></div></div></div><div class="refsect1" lang="en"><a name="id2592908"></a><h2>See Also</h2><p>
<a href="GimpFileEntry.html" title="GimpFileEntry"><span class="type">GimpFileEntry</span></a>
</p><p>
<a
href="../glib/glib-Standard-Macros.html#G-SEARCHPATH-SEPARATOR--CAPS"
><span class="type">G_SEARCHPATH_SEPARATOR</span></a>
</p></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="GimpOffsetArea.html"><b>&lt;&lt;GimpOffsetArea</b></a></td><td align="right"><a accesskey="n" href="GimpPickButton.html"><b>GimpPickButton&gt;&gt;</b></a></td></tr></table></body></html>