Gtk.FileChooserDialog

const Gtk = imports.gi.Gtk;

let file_chooser_dialog = new Gtk.FileChooserDialog();
  

Gtk.FileChooserDialog is a dialog box suitable for use with "File/Open" or "File/Save as" commands. This widget works by putting a Gtk.FileChooserWidget inside a Gtk.Dialog. It exposes the Gtk.FileChooser interface, so you can use all of the Gtk.FileChooser functions on the file chooser dialog as well as those for Gtk.Dialog.

Note that Gtk.FileChooserDialog does not have any methods of its own. Instead, you should use the functions that work on a Gtk.FileChooser.

<example id="gtkfilechooser-typical-usage"> <title>Typical usage</title> In the simplest of cases, you can the following code to use Gtk.FileChooserDialog to select a file for opening: <para> <informalexample><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); </programlisting></informalexample> </para> To use a dialog for saving, you can use this: <para> <informalexample><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_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); </programlisting></informalexample> </para> </example> <section id="gtkfilechooserdialog-setting-up"> <title>Setting up a file chooser dialog</title> There are various cases in which you may need to use a Gtk.FileChooserDialog: <itemizedlist><listitem>To select a file for opening, as for a <guimenuitem>File/Open</guimenuitem> command. Use #GTK_FILE_CHOOSER_ACTION_OPEN. </listitem> <listitem>To save a file for the first time, as for a <guimenuitem>File/Save</guimenuitem> command. Use #GTK_FILE_CHOOSER_ACTION_SAVE, and suggest a name such as "Untitled" with Gtk.FileChooser.prototype.set_current_name. </listitem> <listitem>To save a file under a different name, as for a <guimenuitem>File/Save As</guimenuitem> command. Use #GTK_FILE_CHOOSER_ACTION_SAVE, and set the existing filename with Gtk.FileChooser.prototype.set_filename. </listitem> <listitem>To choose a folder instead of a file. Use #GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER. </listitem></itemizedlist> <note> <para> Old versions of the file chooser's documentation suggested using Gtk.FileChooser.prototype.set_current_folder in various situations, with the intention of letting the application suggest a reasonable default folder. This is no longer considered to be a good policy, as now the file chooser is able to make good suggestions on its own. In general, you should only cause the file chooser to show a specific folder when it is appropriate to use Gtk.FileChooser.prototype.set_filename, i.e. when you are doing a <guimenuitem>File/Save As</guimenuitem> command <emphasis>and</emphasis> you already have a file saved somewhere. </para> </note> </section> <section id="gtkfilechooserdialog-response-codes"> <title>Response Codes</title> Gtk.FileChooserDialog inherits from Gtk.Dialog, so buttons that go in its action area have response codes such as #GTK_RESPONSE_ACCEPT and #GTK_RESPONSE_CANCEL. For example, you could call Gtk.new as follows: <para> <informalexample><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); </programlisting></informalexample> </para> This will create buttons for "Cancel" and "Open" that use stock response identifiers from Gtk.ResponseType. For most dialog boxes you can use your own custom response codes rather than the ones in Gtk.ResponseType, but Gtk.FileChooserDialog assumes that its "accept"-type action, e.g. an "Open" or "Save" button, <emphasis>will</emphasis> have one of the following response codes: <para> <simplelist id="gtkfilechooserdialog-responses"> <member>#GTK_RESPONSE_ACCEPT</member> <member>#GTK_RESPONSE_OK</member> <member>#GTK_RESPONSE_YES</member> <member>#GTK_RESPONSE_APPLY</member> </simplelist> </para> This is because Gtk.FileChooserDialog must intercept responses and switch to folders if appropriate, rather than letting the dialog terminate &mdash; the implementation uses these known response codes to know which responses can be blocked if appropriate. <para> <note> To summarize, make sure you use a <link linkend="gtkfilechooserdialog-responses">stock response code</link> when you use Gtk.FileChooserDialog to ensure proper operation. </note> </para> </section>