Files
gimp/devel-docs/libgimpwidgets/html/GimpFileEntry.html
2010-08-11 01:21:39 -04:00

281 lines
12 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GimpFileEntry</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual">
<link rel="up" href="libgimpwidgets-widgets.html" title="Part&#160;I.&#160;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.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpwidgets-widgets.html" title="Part&#160;I.&#160;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&#160;II.&#160;GIMP Display Filters">
<link rel="part" href="libgimpwidgets-colorselector.html" title="Part&#160;III.&#160;GIMP Color Selectors">
<link rel="part" href="libgimpwidgets-controller.html" title="Part&#160;IV.&#160;GIMP Controllers">
<link rel="part" href="libgimpwidgets-utils.html" title="Part&#160;V.&#160;GIMP Widgets Utilities">
<link rel="part" href="libgimpwidgets-deprecated.html" title="Part&#160;VI.&#160;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-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="#id2556309" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2589123" class="shortcut">Description</a>
&#160;|&#160;
<a href="#id2562993" class="shortcut">Object Hierarchy</a>
&#160;|&#160;
<a href="#id2563054" class="shortcut">Implemented Interfaces</a>
&#160;|&#160;
<a href="#id2589098" 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>
<a name="id2556309"></a><span class="refentrytitle">GimpFileEntry</span>
</h2>
<p>GimpFileEntry &#8212; 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">
<h2>Synopsis</h2>
<pre class="synopsis">
<a href="GimpFileEntry.html#GimpFileEntry-struct">GimpFileEntry</a>;
GtkWidget* <a href="GimpFileEntry.html#gimp-file-entry-new">gimp_file_entry_new</a> (const gchar *title,
const gchar *filename,
gboolean dir_only,
gboolean check_valid);
gchar* <a href="GimpFileEntry.html#gimp-file-entry-get-filename">gimp_file_entry_get_filename</a> (<a href="GimpFileEntry.html" title="GimpFileEntry">GimpFileEntry</a> *entry);
void <a href="GimpFileEntry.html#gimp-file-entry-set-filename">gimp_file_entry_set_filename</a> (<a href="GimpFileEntry.html" title="GimpFileEntry">GimpFileEntry</a> *entry,
const gchar *filename);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2562993"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkObject
+----GtkWidget
+----GtkContainer
+----GtkBox
+----GtkHBox
+----GimpFileEntry
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2563054"></a><h2>Implemented Interfaces</h2>
<p>
GimpFileEntry implements
AtkImplementorIface.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2589098"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GimpFileEntry.html#GimpFileEntry-filename-changed">filename-changed</a>" : Run First
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2589123"></a><h2>Description</h2>
<p>
This widget is used to enter filenames or directories.
</p>
<p>
There is a <span class="type">GtkEntry</span> for entering the filename manually and a "..."
button which will pop up a <span class="type">GtkFileSelection</span> dialog.
</p>
<p>
You can restrict the <span class="type">GimpFileSelection</span> to directories. In this case
the filename listbox of the <span class="type">GtkFileSelection</span> dialog will be hidden.
</p>
<p>
If you specify <em class="parameter"><code>check_valid</code></em> as <span class="type">TRUE</span> in <a href="GimpFileEntry.html#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="id2589210"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2589221"></a><h3>
<a name="GimpFileEntry-struct"></a>GimpFileEntry</h3>
<a class="indexterm" name="id2589233"></a><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="id2609881"></a><h3>
<a name="gimp-file-entry-new"></a>gimp_file_entry_new ()</h3>
<a class="indexterm" name="id2609896"></a><pre class="programlisting">GtkWidget* gimp_file_entry_new (const gchar *title,
const gchar *filename,
gboolean dir_only,
gboolean 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 <span class="type">GtkFileChooserButton</span> instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>title</code></em>&#160;:</span></td>
<td> The title of the <span class="type">GtkFileEntry</span> dialog.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>filename</code></em>&#160;:</span></td>
<td> The initial filename.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>dir_only</code></em>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if the file entry should accept directories only.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>check_valid</code></em>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if the widget should check if the entered file
really exists.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> A pointer to the new <a 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="id2610074"></a><h3>
<a name="gimp-file-entry-get-filename"></a>gimp_file_entry_get_filename ()</h3>
<a class="indexterm" name="id2610088"></a><pre class="programlisting">gchar* gimp_file_entry_get_filename (<a 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 <code class="function">g_free()</code> the returned string.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>entry</code></em>&#160;:</span></td>
<td> The file entry you want to know the filename from.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The file or directory the user has entered.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559989"></a><h3>
<a name="gimp-file-entry-set-filename"></a>gimp_file_entry_set_filename ()</h3>
<a class="indexterm" name="id2560003"></a><pre class="programlisting">void gimp_file_entry_set_filename (<a href="GimpFileEntry.html" title="GimpFileEntry">GimpFileEntry</a> *entry,
const gchar *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 <code class="literal">TRUE</code> in <a href="GimpFileEntry.html#gimp-file-entry-new"><code class="function">gimp_file_entry_new()</code></a>
the <a 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><span class="term"><em class="parameter"><code>entry</code></em>&#160;:</span></td>
<td> The file entry you want to set the filename for.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>filename</code></em>&#160;:</span></td>
<td> The new filename.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2560122"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2560133"></a><h3>
<a name="GimpFileEntry-filename-changed"></a>The "filename-changed" signal</h3>
<a class="indexterm" name="id2560143"></a><pre class="programlisting">void user_function (<a href="GimpFileEntry.html" title="GimpFileEntry">GimpFileEntry</a> *arg0,
gpointer 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><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</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="id2560203"></a><h2>See Also</h2>
<p>
<a href="GimpPathEditor.html" title="GimpPathEditor"><span class="type">GimpPathEditor</span></a>
</p>
</div>
</div>
</body>
</html>