336 lines
15 KiB
HTML
336 lines
15 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
<html>
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
<title>GimpFileEntry</title>
|
||
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
|
||
<link rel="start" 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.10 (XML mode)">
|
||
<link rel="stylesheet" href="style.css" type="text/css">
|
||
<link rel="part" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
|
||
<link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy">
|
||
<link rel="chapter" href="libgimpwidgets-gallery.html" title="Widget Gallery">
|
||
<link rel="chapter" href="libgimpwidgets-cell-renderers.html" title="Cell Renderers for GtkTreeView">
|
||
<link rel="part" href="libgimpwidgets-colordisplay.html" title="Part II. GIMP Display Filters">
|
||
<link rel="part" href="libgimpwidgets-colorselector.html" title="Part III. GIMP Color Selectors">
|
||
<link rel="part" href="libgimpwidgets-controller.html" title="Part IV. GIMP Controllers">
|
||
<link rel="part" href="libgimpwidgets-utils.html" title="Part V. GIMP Widgets Utilities">
|
||
<link rel="part" href="libgimpwidgets-deprecated.html" title="Part VI. Deprecated API">
|
||
<link rel="index" href="libgimpwidgets-index.html" title="Index">
|
||
<link rel="index" href="libgimpwidgets-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
|
||
<link rel="index" href="libgimpwidgets-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
|
||
<link rel="index" href="libgimpwidgets-index-new-in-2-6.html" title="Index of new symbols in GIMP 2.6">
|
||
<link rel="index" href="libgimpwidgets-index-deprecated.html" title="Index of deprecated symbols">
|
||
</head>
|
||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
|
||
<tr valign="middle">
|
||
<td><a accesskey="p" href="GimpEnumLabel.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="GimpFrame.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
|
||
</tr>
|
||
<tr><td colspan="5" class="shortcuts"><nobr><a href="#GimpFileEntry.synopsis" class="shortcut">Top</a>
|
||
|
|
||
<a href="#GimpFileEntry.description" class="shortcut">Description</a>
|
||
|
|
||
<a href="#GimpFileEntry.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
||
|
|
||
<a href="#GimpFileEntry.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
||
|
|
||
<a href="#GimpFileEntry.signals" class="shortcut">Signals</a></nobr></td></tr>
|
||
</table>
|
||
<div class="refentry" lang="en">
|
||
<a name="GimpFileEntry"></a><div class="titlepage"></div>
|
||
<div class="refnamediv"><table width="100%"><tr>
|
||
<td valign="top">
|
||
<h2><span class="refentrytitle"><a name="GimpFileEntry.top_of_page"></a>GimpFileEntry</span></h2>
|
||
<p>GimpFileEntry — Widget for entering a filename.</p>
|
||
</td>
|
||
<td valign="top" align="right"><img src="gimp-file-entry.png"></td>
|
||
</tr></table></div>
|
||
<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"
|
||
>GtkWidget</a>* <a class="link" href="GimpFileEntry.html#gimp-file-entry-new" title="gimp_file_entry_new ()">gimp_file_entry_new</a> (const <a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *title,
|
||
const <a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *filename,
|
||
<a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
|
||
>gboolean</a> dir_only,
|
||
<a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
|
||
>gboolean</a> check_valid);
|
||
<a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
|
||
>gchar</a>* <a class="link" href="GimpFileEntry.html#gimp-file-entry-get-filename" title="gimp_file_entry_get_filename ()">gimp_file_entry_get_filename</a> (<a class="link" href="GimpFileEntry.html" title="GimpFileEntry">GimpFileEntry</a> *entry);
|
||
void <a class="link" href="GimpFileEntry.html#gimp-file-entry-set-filename" title="gimp_file_entry_set_filename ()">gimp_file_entry_set_filename</a> (<a class="link" href="GimpFileEntry.html" title="GimpFileEntry">GimpFileEntry</a> *entry,
|
||
const <a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *filename);
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1" lang="en">
|
||
<a name="GimpFileEntry.object-hierarchy"></a><h2>Object Hierarchy</h2>
|
||
<pre class="synopsis">
|
||
<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="/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>
|
||
+----GimpFileEntry
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1" lang="en">
|
||
<a name="GimpFileEntry.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
|
||
<p>
|
||
GimpFileEntry implements
|
||
AtkImplementorIface and <a
|
||
href="/usr/share/gtk-doc/html/gtk/gtk-gtkbuildable.html#GtkBuildable"
|
||
>GtkBuildable</a>.</p>
|
||
</div>
|
||
<div class="refsect1" lang="en">
|
||
<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
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1" lang="en">
|
||
<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.
|
||
</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.
|
||
</p>
|
||
<p>
|
||
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>
|
||
<p>
|
||
Whenever the user changes the filename, the "filename_changed" signal
|
||
will be emitted.
|
||
</p>
|
||
</div>
|
||
<div class="refsect1" lang="en">
|
||
<a name="GimpFileEntry.details"></a><h2>Details</h2>
|
||
<div class="refsect2" lang="en">
|
||
<a name="GimpFileEntry-struct"></a><h3>GimpFileEntry</h3>
|
||
<pre class="programlisting">typedef struct _GimpFileEntry GimpFileEntry;</pre>
|
||
<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>
|
||
<p>
|
||
|
||
</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2" lang="en">
|
||
<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"
|
||
>GtkWidget</a>* gimp_file_entry_new (const <a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *title,
|
||
const <a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *filename,
|
||
<a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
|
||
>gboolean</a> dir_only,
|
||
<a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
|
||
>gboolean</a> check_valid);</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.</p>
|
||
<p>
|
||
|
||
</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>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></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="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="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>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2" lang="en">
|
||
<a name="gimp-file-entry-get-filename"></a><h3>gimp_file_entry_get_filename ()</h3>
|
||
<pre class="programlisting"><a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
|
||
>gchar</a>* gimp_file_entry_get_filename (<a class="link" href="GimpFileEntry.html" title="GimpFileEntry">GimpFileEntry</a> *entry);</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="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"
|
||
><code class="function">g_free()</code></a> the returned string.</p>
|
||
<p>
|
||
|
||
</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>
|
||
</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>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2" lang="en">
|
||
<a name="gimp-file-entry-set-filename"></a><h3>gimp_file_entry_set_filename ()</h3>
|
||
<pre class="programlisting">void gimp_file_entry_set_filename (<a class="link" href="GimpFileEntry.html" title="GimpFileEntry">GimpFileEntry</a> *entry,
|
||
const <a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *filename);</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="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>
|
||
<p>
|
||
|
||
</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 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>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1" lang="en">
|
||
<a name="GimpFileEntry.signal-details"></a><h2>Signal Details</h2>
|
||
<div class="refsect2" lang="en">
|
||
<a name="GimpFileEntry-filename-changed"></a><h3>The <code class="literal">"filename-changed"</code> signal</h3>
|
||
<pre class="programlisting">void user_function (<a class="link" href="GimpFileEntry.html" title="GimpFileEntry">GimpFileEntry</a> *arg0,
|
||
<a
|
||
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
|
||
>gpointer</a> user_data) : Run First</pre>
|
||
<p>
|
||
This signal is emitted whenever the user changes the filename.</p>
|
||
<p>
|
||
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody><tr>
|
||
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></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="GimpFileEntry.see-also"></a><h2>See Also</h2>
|
||
<p>
|
||
<a class="link" href="GimpPathEditor.html" title="GimpPathEditor"><span class="type">GimpPathEditor</span></a>
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<div class="footer">
|
||
<hr>
|
||
Generated by GTK-Doc V1.10</div>
|
||
</body>
|
||
</html>
|