Imported Upstream version 2.6.12

This commit is contained in:
Ari Pollak
2012-02-18 13:51:51 -05:00
parent 357cf155b6
commit 3fcab19200
550 changed files with 140833 additions and 99740 deletions

View File

@ -3,12 +3,12 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GimpFileEntry</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GIMP Widgets Library Reference Manual">
<link rel="up" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
<link rel="prev" href="GimpEnumLabel.html" title="GimpEnumLabel">
<link rel="next" href="GimpFrame.html" title="GimpFrame">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@ -32,7 +32,7 @@
<a href="#GimpFileEntry.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="GimpFileEntry">
<div class="refentry">
<a name="GimpFileEntry"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
@ -41,58 +41,58 @@
</td>
<td valign="top" align="right"><img src="gimp-file-entry.png"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<div class="refsynopsisdiv">
<a name="GimpFileEntry.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="GimpFileEntry.html#GimpFileEntry-struct" title="GimpFileEntry">GimpFileEntry</a>;
<a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GimpFileEntry.html#gimp-file-entry-new" title="gimp_file_entry_new ()">gimp_file_entry_new</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> dir_only</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> check_valid</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GimpFileEntry.html#gimp-file-entry-get-filename" title="gimp_file_entry_get_filename ()">gimp_file_entry_get_filename</a> (<em class="parameter"><code><a class="link" href="GimpFileEntry.html" title="GimpFileEntry"><span class="type">GimpFileEntry</span></a> *entry</code></em>);
<a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GimpFileEntry.html#gimp-file-entry-new" title="gimp_file_entry_new ()">gimp_file_entry_new</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> dir_only</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> check_valid</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GimpFileEntry.html#gimp-file-entry-get-filename" title="gimp_file_entry_get_filename ()">gimp_file_entry_get_filename</a> (<em class="parameter"><code><a class="link" href="GimpFileEntry.html" title="GimpFileEntry"><span class="type">GimpFileEntry</span></a> *entry</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GimpFileEntry.html#gimp-file-entry-set-filename" title="gimp_file_entry_set_filename ()">gimp_file_entry_set_filename</a> (<em class="parameter"><code><a class="link" href="GimpFileEntry.html" title="GimpFileEntry"><span class="type">GimpFileEntry</span></a> *entry</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<div class="refsect1">
<a name="GimpFileEntry.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
+----<a href="/usr/share/gtk-doc/html/gtk/GtkObject.html">GtkObject</a>
+----<a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html">GtkWidget</a>
+----<a href="/usr/share/gtk-doc/html/gtk/GtkContainer.html">GtkContainer</a>
+----<a href="/usr/share/gtk-doc/html/gtk/GtkBox.html">GtkBox</a>
+----<a href="/usr/share/gtk-doc/html/gtk/GtkHBox.html">GtkHBox</a>
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
+----<a href="http://library.gnome.org/devel/gtk3/GtkObject.html">GtkObject</a>
+----<a href="http://library.gnome.org/devel/gtk3/GtkWidget.html">GtkWidget</a>
+----<a href="http://library.gnome.org/devel/gtk3/GtkContainer.html">GtkContainer</a>
+----<a href="http://library.gnome.org/devel/gtk3/GtkBox.html">GtkBox</a>
+----<a href="http://library.gnome.org/devel/gtk3/GtkHBox.html">GtkHBox</a>
+----GimpFileEntry
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<div class="refsect1">
<a name="GimpFileEntry.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GimpFileEntry implements
AtkImplementorIface, <a href="/usr/share/gtk-doc/html/gtk/gtk-gtkbuildable.html#GtkBuildable">GtkBuildable</a> and <a href="/usr/share/gtk-doc/html/gtk/gtk-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
AtkImplementorIface, <a href="http://library.gnome.org/devel/gtk3/GtkBuildable.html">GtkBuildable</a> and <a href="http://library.gnome.org/devel/gtk3/gtk-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
</div>
<div class="refsect1" title="Signals">
<div class="refsect1">
<a name="GimpFileEntry.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GimpFileEntry.html#GimpFileEntry-filename-changed" title='The "filename-changed" signal'>filename-changed</a>" : Run First
"<a class="link" href="GimpFileEntry.html#GimpFileEntry-filename-changed" title='The "filename-changed" signal'>filename-changed</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
</pre>
</div>
<div class="refsect1" title="Description">
<div class="refsect1">
<a name="GimpFileEntry.description"></a><h2>Description</h2>
<p>
This widget is used to enter filenames or directories.
</p>
<p>
There is a <a href="/usr/share/gtk-doc/html/gtk/GtkEntry.html"><span class="type">GtkEntry</span></a> for entering the filename manually and a "..."
button which will pop up a <a href="/usr/share/gtk-doc/html/gtk/GtkFileSelection.html"><span class="type">GtkFileSelection</span></a> dialog.
There is a <a href="http://library.gnome.org/devel/gtk3/GtkEntry.html"><span class="type">GtkEntry</span></a> for entering the filename manually and a "..."
button which will pop up a <a href="http://library.gnome.org/devel/gtk3/GtkFileSelection.html"><span class="type">GtkFileSelection</span></a> dialog.
</p>
<p>
You can restrict the <span class="type">GimpFileSelection</span> to directories. In this case
the filename listbox of the <a href="/usr/share/gtk-doc/html/gtk/GtkFileSelection.html"><span class="type">GtkFileSelection</span></a> dialog will be hidden.
the filename listbox of the <a href="http://library.gnome.org/devel/gtk3/GtkFileSelection.html"><span class="type">GtkFileSelection</span></a> dialog will be hidden.
</p>
<p>
If you specify <em class="parameter"><code>check_valid</code></em> as <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> in <a class="link" href="GimpFileEntry.html#gimp-file-entry-new" title="gimp_file_entry_new ()"><code class="function">gimp_file_entry_new()</code></a>
If you specify <em class="parameter"><code>check_valid</code></em> as <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> in <a class="link" href="GimpFileEntry.html#gimp-file-entry-new" title="gimp_file_entry_new ()"><code class="function">gimp_file_entry_new()</code></a>
the entered filename will be checked for validity and a pixmap will be
shown which indicates if the file exists or not.
</p>
@ -101,12 +101,12 @@ Whenever the user changes the filename, the "filename_changed" signal
will be emitted.
</p>
</div>
<div class="refsect1" title="Details">
<div class="refsect1">
<a name="GimpFileEntry.details"></a><h2>Details</h2>
<div class="refsect2" title="GimpFileEntry">
<div class="refsect2">
<a name="GimpFileEntry-struct"></a><h3>GimpFileEntry</h3>
<pre class="programlisting">typedef struct _GimpFileEntry GimpFileEntry;</pre>
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">GimpFileEntry</code> is deprecated and should not be used in newly-written code.</p>
</div>
@ -114,91 +114,84 @@ will be emitted.
</p>
</div>
<hr>
<div class="refsect2" title="gimp_file_entry_new ()">
<div class="refsect2">
<a name="gimp-file-entry-new"></a><h3>gimp_file_entry_new ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * gimp_file_entry_new (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> dir_only</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> check_valid</code></em>);</pre>
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * gimp_file_entry_new (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> dir_only</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> check_valid</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_file_entry_new</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
You should use <a href="/usr/share/gtk-doc/html/gtk/GtkFileChooserButton.html"><span class="type">GtkFileChooserButton</span></a> instead.
You should use <a href="http://library.gnome.org/devel/gtk3/GtkFileChooserButton.html"><span class="type">GtkFileChooserButton</span></a> instead.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
<td>The title of the <span class="type">GtkFileEntry</span> dialog.
</td>
<td>The title of the <span class="type">GtkFileEntry</span> dialog.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>The initial filename.
</td>
<td>The initial filename.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dir_only</code></em> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the file entry should accept directories only.
</td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the file entry should accept directories only.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>check_valid</code></em> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the widget should check if the entered file
really exists.
</td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the widget should check if the entered file
really exists.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A pointer to the new <a class="link" href="GimpFileEntry.html" title="GimpFileEntry"><span class="type">GimpFileEntry</span></a> widget.
</td>
<td>A pointer to the new <a class="link" href="GimpFileEntry.html" title="GimpFileEntry"><span class="type">GimpFileEntry</span></a> widget.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gimp_file_entry_get_filename ()">
<div class="refsect2">
<a name="gimp-file-entry-get-filename"></a><h3>gimp_file_entry_get_filename ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gimp_file_entry_get_filename (<em class="parameter"><code><a class="link" href="GimpFileEntry.html" title="GimpFileEntry"><span class="type">GimpFileEntry</span></a> *entry</code></em>);</pre>
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gimp_file_entry_get_filename (<em class="parameter"><code><a class="link" href="GimpFileEntry.html" title="GimpFileEntry"><span class="type">GimpFileEntry</span></a> *entry</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_file_entry_get_filename</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Note that you have to <a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> the returned string.
Note that you have to <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> the returned string.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>entry</code></em> :</span></p></td>
<td>The file entry you want to know the filename from.
</td>
<td>The file entry you want to know the filename from.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The file or directory the user has entered.
</td>
<td>The file or directory the user has entered.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gimp_file_entry_set_filename ()">
<div class="refsect2">
<a name="gimp-file-entry-set-filename"></a><h3>gimp_file_entry_set_filename ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_file_entry_set_filename (<em class="parameter"><code><a class="link" href="GimpFileEntry.html" title="GimpFileEntry"><span class="type">GimpFileEntry</span></a> *entry</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);</pre>
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_file_entry_set_filename</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
If you specified <em class="parameter"><code>check_valid</code></em> as <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> in <a class="link" href="GimpFileEntry.html#gimp-file-entry-new" title="gimp_file_entry_new ()"><code class="function">gimp_file_entry_new()</code></a>
If you specified <em class="parameter"><code>check_valid</code></em> as <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> in <a class="link" href="GimpFileEntry.html#gimp-file-entry-new" title="gimp_file_entry_new ()"><code class="function">gimp_file_entry_new()</code></a>
the <a class="link" href="GimpFileEntry.html" title="GimpFileEntry"><span class="type">GimpFileEntry</span></a> will immediately check the validity of the file
name.
</p>
@ -207,24 +200,22 @@ name.
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>entry</code></em> :</span></p></td>
<td>The file entry you want to set the filename for.
</td>
<td>The file entry you want to set the filename for.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>The new filename.
</td>
<td>The new filename.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Signal Details">
<div class="refsect1">
<a name="GimpFileEntry.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" title='The "filename-changed" signal'>
<div class="refsect2">
<a name="GimpFileEntry-filename-changed"></a><h3>The <code class="literal">"filename-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GimpFileEntry.html" title="GimpFileEntry"><span class="type">GimpFileEntry</span></a> *arg0,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run First</pre>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
<p>
This signal is emitted whenever the user changes the filename.
</p>
@ -237,7 +228,7 @@ This signal is emitted whenever the user changes the filename.
</table></div>
</div>
</div>
<div class="refsect1" title="See Also">
<div class="refsect1">
<a name="GimpFileEntry.see-also"></a><h2>See Also</h2>
<p>
<a class="link" href="GimpPathEditor.html" title="GimpPathEditor"><span class="type">GimpPathEditor</span></a>
@ -246,6 +237,6 @@ This signal is emitted whenever the user changes the filename.
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.15</div>
Generated by GTK-Doc V1.18</div>
</body>
</html>