|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /usr/share/gtk-doc/html/gtk/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GtkFileChooserDialog</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="GTK+ Reference Manual">
<link rel="up" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
<link rel="prev" href="GtkFileChooserButton.html" title="GtkFileChooserButton">
<link rel="next" href="GtkFileChooserWidget.html" title="GtkFileChooserWidget">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gtk.html" title="Part I. GTK+ Overview">
<link rel="part" href="gtkbase.html" title="Part II. GTK+ Core Reference">
<link rel="part" href="gtkobjects.html" title="Part III. GTK+ Widgets and Objects">
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
<link rel="chapter" href="ch02.html" title="Widget Gallery">
<link rel="chapter" href="WindowWidgets.html" title="Windows">
<link rel="chapter" href="DisplayWidgets.html" title="Display Widgets">
<link rel="chapter" href="ButtonWidgets.html" title="Buttons and Toggles">
<link rel="chapter" href="NumericEntry.html" title="Numeric/Text Data Entry">
<link rel="chapter" href="TextWidgetObjects.html" title="Multiline Text Editor">
<link rel="chapter" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
<link rel="chapter" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="chapter" href="Actions.html" title="Action-based menus and toolbars">
<link rel="chapter" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
<link rel="chapter" href="LayoutContainers.html" title="Layout Containers">
<link rel="chapter" href="Ornaments.html" title="Ornaments">
<link rel="chapter" href="ScrollingWidgets.html" title="Scrolling">
<link rel="chapter" href="Printing.html" title="Printing">
<link rel="chapter" href="MiscObjects.html" title="Miscellaneous">
<link rel="chapter" href="AbstractObjects.html" title="Abstract Base Classes">
<link rel="chapter" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="chapter" href="SpecialObjects.html" title="Special-purpose features">
<link rel="chapter" href="RecentDocuments.html" title="Recently Used Documents">
<link rel="chapter" href="DeprecatedObjects.html" title="Deprecated">
<link rel="part" href="migrating.html" title="Part IV. Migrating from Previous Versions of GTK+">
<link rel="chapter" href="gtk-migrating-checklist.html" title="Migration Checklist">
<link rel="chapter" href="gtk-migrating-GtkFileChooser.html" title="Migrating from GtkFileSelection to GtkFileChooser">
<link rel="chapter" href="gtk-migrating-GtkAction.html" title="Migrating from old menu and toolbar systems to GtkAction">
<link rel="chapter" href="gtk-migrating-GtkComboBox.html" title="Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and
GtkComboBoxEntry">
<link rel="chapter" href="gtk-migrating-GtkIconView.html" title="Migrating from GnomeIconList to GtkIconView">
<link rel="chapter" href="gtk-migrating-GtkAboutDialog.html" title="Migrating from GnomeAbout to GtkAboutDialog">
<link rel="chapter" href="gtk-migrating-GtkColorButton.html" title="Migrating from GnomeColorPicker to GtkColorButton">
<link rel="chapter" href="gtk-migrating-GtkAssistant.html" title="Migrating from GnomeDruid to GtkAssistant">
<link rel="chapter" href="gtk-migrating-GtkRecentChooser.html" title="Migrating from EggRecent to GtkRecentChooser">
<link rel="chapter" href="gtk-migrating-GtkLinkButton.html" title="Migrating from GnomeHRef to GtkLinkButton">
<link rel="part" href="pt05.html" title="Part V. GTK+ Tools">
<link rel="glossary" href="glossary.html" title="Glossary">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in 2.2">
<link rel="index" href="ix04.html" title="Index of new symbols in 2.4">
<link rel="index" href="ix05.html" title="Index of new symbols in 2.6">
<link rel="index" href="ix06.html" title="Index of new symbols in 2.8">
<link rel="index" href="ix07.html" title="Index of new symbols in 2.10">
</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="GtkFileChooserButton.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="SelectorWidgets.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">GTK+ Reference Manual</th>
<td><a accesskey="n" href="GtkFileChooserWidget.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="#id3429846" class="shortcut">Top</a>
 | 
<a href="#id3430079" class="shortcut">Description</a>
 | 
<a href="#id3429972" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id3430049" class="shortcut">Implemented Interfaces</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GtkFileChooserDialog"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id3429846"></a><span class="refentrytitle">GtkFileChooserDialog</span>
</h2>
<p>GtkFileChooserDialog — A file chooser dialog, suitable for "File/Open" or "File/Save" commands</p>
</td>
<td valign="top" align="right"><img src="filechooser.png"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <gtk/gtk.h>
<a href="GtkFileChooserDialog.html#GtkFileChooserDialog-struct">GtkFileChooserDialog</a>;
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* <a href="GtkFileChooserDialog.html#gtk-file-chooser-dialog-new">gtk_file_chooser_dialog_new</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *title,
<a href="GtkWindow.html" title="GtkWindow">GtkWindow</a> *parent,
<a href="GtkFileChooser.html#GtkFileChooserAction">GtkFileChooserAction</a> action,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *first_button_text,
...);
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* <a href="GtkFileChooserDialog.html#gtk-file-chooser-dialog-new-with-backend">gtk_file_chooser_dialog_new_with_backend</a>
(const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *title,
<a href="GtkWindow.html" title="GtkWindow">GtkWindow</a> *parent,
<a href="GtkFileChooser.html#GtkFileChooserAction">GtkFileChooserAction</a> action,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *backend,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *first_button_text,
...);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3429972"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a href="GtkObject.html" title="GtkObject">GtkObject</a>
+----<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
+----<a href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
+----<a href="GtkBin.html" title="GtkBin">GtkBin</a>
+----<a href="GtkWindow.html" title="GtkWindow">GtkWindow</a>
+----<a href="GtkDialog.html" title="GtkDialog">GtkDialog</a>
+----GtkFileChooserDialog
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3430049"></a><h2>Implemented Interfaces</h2>
<p>
GtkFileChooserDialog implements
<a href="GtkFileChooser.html" title="GtkFileChooser">GtkFileChooser</a> and AtkImplementorIface.</p>
</div>
<div class="refsect1" lang="en">
<a name="id3430079"></a><h2>Description</h2>
<p>
<a href="GtkFileChooserDialog.html" title="GtkFileChooserDialog"><span class="type">GtkFileChooserDialog</span></a> is a dialog box suitable for use with
"File/Open" or "File/Save as" commands. This widget works by
putting a <a href="GtkFileChooserWidget.html" title="GtkFileChooserWidget"><span class="type">GtkFileChooserWidget</span></a> inside a <a href="GtkDialog.html" title="GtkDialog"><span class="type">GtkDialog</span></a>. It exposes
the <span class="type">GtkFileChooserIface</span> interface, so you can use all of the
<a href="GtkFileChooser.html" title="GtkFileChooser"><span class="type">GtkFileChooser</span></a> functions on the file chooser dialog as well as
those for <a href="GtkDialog.html" title="GtkDialog"><span class="type">GtkDialog</span></a>.
</p>
<p>
Note that <a href="GtkFileChooserDialog.html" title="GtkFileChooserDialog"><span class="type">GtkFileChooserDialog</span></a> does not have any methods of its
own. Instead, you should use the functions that work on a
<a href="GtkFileChooser.html" title="GtkFileChooser"><span class="type">GtkFileChooser</span></a>.
</p>
<div class="example">
<a name="gtkfilechooser-typical-usage"></a><p class="title"><b>Example 7. Typical usage</b></p>
<p>
In the simplest of cases, you can the following code to use
<a href="GtkFileChooserDialog.html" title="GtkFileChooserDialog"><span class="type">GtkFileChooserDialog</span></a> to select a file for opening:
</p>
<pre class="programlisting">
GtkWidget *dialog;
dialog = gtk_file_chooser_dialog_new ("Open File",
parent_window,
GTK_FILE_CHOOSER_ACTION_OPEN,
GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
GTK_STOCK_OPEN, GTK_RESPONSE_ACCEPT,
NULL);
if (gtk_dialog_run (GTK_DIALOG (dialog)) == GTK_RESPONSE_ACCEPT)
{
char *filename;
filename = gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (dialog));
open_file (filename);
g_free (filename);
}
gtk_widget_destroy (dialog);
</pre>
<p>
To use a dialog for saving, you can use this:
</p>
<pre class="programlisting">
GtkWidget *dialog;
dialog = gtk_file_chooser_dialog_new ("Save File",
parent_window,
GTK_FILE_CHOOSER_ACTION_SAVE,
GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
GTK_STOCK_SAVE, GTK_RESPONSE_ACCEPT,
NULL);
gtk_file_chooser_set_do_overwrite_confirmation (GTK_FILE_CHOOSER (dialog), TRUE);
if (user_edited_a_new_document)
{
gtk_file_chooser_set_current_folder (GTK_FILE_CHOOSER (dialog), default_folder_for_saving);
gtk_file_chooser_set_current_name (GTK_FILE_CHOOSER (dialog), "Untitled document");
}
else
gtk_file_chooser_set_filename (GTK_FILE_CHOOSER (dialog), filename_for_existing_document);
if (gtk_dialog_run (GTK_DIALOG (dialog)) == GTK_RESPONSE_ACCEPT)
{
char *filename;
filename = gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (dialog));
save_to_file (filename);
g_free (filename);
}
gtk_widget_destroy (dialog);
</pre>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="gtkfilechooserdialog-response-codes"></a>Response Codes</h2></div></div></div>
<p>
<a href="GtkFileChooserDialog.html" title="GtkFileChooserDialog"><span class="type">GtkFileChooserDialog</span></a> inherits from <a href="GtkDialog.html" title="GtkDialog"><span class="type">GtkDialog</span></a>, so buttons that
go in its action area have response codes such as
<a href="GtkDialog.html#GTK-RESPONSE-ACCEPT:CAPS"><span class="type">GTK_RESPONSE_ACCEPT</span></a> and <a href="GtkDialog.html#GTK-RESPONSE-CANCEL:CAPS"><span class="type">GTK_RESPONSE_CANCEL</span></a>. For example, you
could call <a href="GtkFileChooserDialog.html#gtk-file-chooser-dialog-new"><code class="function">gtk_file_chooser_dialog_new()</code></a> as follows:
</p>
<pre class="programlisting">
GtkWidget *dialog;
dialog = gtk_file_chooser_dialog_new ("Open File",
parent_window,
GTK_FILE_CHOOSER_ACTION_OPEN,
GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
GTK_STOCK_OPEN, GTK_RESPONSE_ACCEPT,
NULL);
</pre>
<p>
This will create buttons for "Cancel" and "Open" that use stock
response identifiers from <a href="GtkDialog.html#GtkResponseType"><span class="type">GtkResponseType</span></a>. For most dialog
boxes you can use your own custom response codes rather than the
ones in <a href="GtkDialog.html#GtkResponseType"><span class="type">GtkResponseType</span></a>, but <a href="GtkFileChooserDialog.html" title="GtkFileChooserDialog"><span class="type">GtkFileChooserDialog</span></a> assumes that
its "accept"-type action, e.g. an "Open" or "Save" button,
<span class="emphasis"><em>will</em></span> have one of the following response
codes:
<a name="gtkfilechooserdialog-responses"></a></p>
<table class="simplelist" border="0" summary="Simple list">
<tr><td><a href="GtkDialog.html#GTK-RESPONSE-ACCEPT:CAPS"><span class="type">GTK_RESPONSE_ACCEPT</span></a></td></tr>
<tr><td><a href="GtkDialog.html#GTK-RESPONSE-OK:CAPS"><span class="type">GTK_RESPONSE_OK</span></a></td></tr>
<tr><td><a href="GtkDialog.html#GTK-RESPONSE-YES:CAPS"><span class="type">GTK_RESPONSE_YES</span></a></td></tr>
<tr><td><a href="GtkDialog.html#GTK-RESPONSE-APPLY:CAPS"><span class="type">GTK_RESPONSE_APPLY</span></a></td></tr>
</table>
<p>
</p>
<p>
This is because <a href="GtkFileChooserDialog.html" title="GtkFileChooserDialog"><span class="type">GtkFileChooserDialog</span></a> must intercept responses
and switch to folders if appropriate, rather than letting the
dialog terminate — the implementation uses these known
response codes to know which responses can be blocked if
appropriate.
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
To summarize, make sure you use a <a href="GtkFileChooserDialog.html#gtkfilechooserdialog-responses">stock response
code</a> when you use <a href="GtkFileChooserDialog.html" title="GtkFileChooserDialog"><span class="type">GtkFileChooserDialog</span></a> to ensure
proper operation.
</p>
</div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3430443"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id3430453"></a><h3>
<a name="GtkFileChooserDialog-struct"></a>GtkFileChooserDialog</h3>
<a class="indexterm" name="id3430466"></a><pre class="programlisting">typedef struct _GtkFileChooserDialog GtkFileChooserDialog;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3430482"></a><h3>
<a name="gtk-file-chooser-dialog-new"></a>gtk_file_chooser_dialog_new ()</h3>
<a class="indexterm" name="id3430498"></a><pre class="programlisting"><a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* gtk_file_chooser_dialog_new (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *title,
<a href="GtkWindow.html" title="GtkWindow">GtkWindow</a> *parent,
<a href="GtkFileChooser.html#GtkFileChooserAction">GtkFileChooserAction</a> action,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *first_button_text,
...);</pre>
<p>
Creates a new <a href="GtkFileChooserDialog.html" title="GtkFileChooserDialog"><span class="type">GtkFileChooserDialog</span></a>. This function is analogous to
<a href="GtkDialog.html#gtk-dialog-new-with-buttons"><code class="function">gtk_dialog_new_with_buttons()</code></a>.</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> :</span></td>
<td> Title of the dialog, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>parent</code></em> :</span></td>
<td> Transient parent of the dialog, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>action</code></em> :</span></td>
<td> Open or save mode for the dialog
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>first_button_text</code></em> :</span></td>
<td> stock ID or text to go in the first button, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>...</code></em> :</span></td>
<td> response ID for the first button, then additional (button, id) pairs, ending with <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a new <a href="GtkFileChooserDialog.html" title="GtkFileChooserDialog"><span class="type">GtkFileChooserDialog</span></a>
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3430714"></a><h3>
<a name="gtk-file-chooser-dialog-new-with-backend"></a>gtk_file_chooser_dialog_new_with_backend ()</h3>
<a class="indexterm" name="id3430730"></a><pre class="programlisting"><a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* gtk_file_chooser_dialog_new_with_backend
(const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *title,
<a href="GtkWindow.html" title="GtkWindow">GtkWindow</a> *parent,
<a href="GtkFileChooser.html#GtkFileChooserAction">GtkFileChooserAction</a> action,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *backend,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *first_button_text,
...);</pre>
<p>
Creates a new <a href="GtkFileChooserDialog.html" title="GtkFileChooserDialog"><span class="type">GtkFileChooserDialog</span></a> with a specified backend. This is
especially useful if you use <a href="GtkFileChooser.html#gtk-file-chooser-set-local-only"><code class="function">gtk_file_chooser_set_local_only()</code></a> to allow
non-local files and you use a more expressive vfs, such as gnome-vfs,
to load files.</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> :</span></td>
<td> Title of the dialog, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>parent</code></em> :</span></td>
<td> Transient parent of the dialog, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>action</code></em> :</span></td>
<td> Open or save mode for the dialog
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>backend</code></em> :</span></td>
<td> The name of the specific filesystem backend to use.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>first_button_text</code></em> :</span></td>
<td> stock ID or text to go in the first button, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>...</code></em> :</span></td>
<td> response ID for the first button, then additional (button, id) pairs, ending with <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a new <a href="GtkFileChooserDialog.html" title="GtkFileChooserDialog"><span class="type">GtkFileChooserDialog</span></a>
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3430974"></a><h2>See Also</h2>
<p>
<a href="GtkFileChooser.html" title="GtkFileChooser"><span class="type">GtkFileChooser</span></a>, <a href="GtkDialog.html" title="GtkDialog"><span class="type">GtkDialog</span></a>
</p>
</div>
</div>
</body>
</html>