.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Gtk2::FileChooser 3"
.TH Gtk2::FileChooser 3 2023-07-25 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Gtk2::FileChooser \- wrapper for GtkFileChooser
.SH HIERARCHY
.IX Header "HIERARCHY"
.Vb 2
\&  Glib::Interface
\&  +\-\-\-\-Gtk2::FileChooser
.Ve
.SH METHODS
.IX Header "METHODS"
.ie n .SS "filechooseraction = $chooser\->\fBget_action\fP"
.el .SS "filechooseraction = \f(CW$chooser\fP\->\fBget_action\fP"
.IX Subsection "filechooseraction = $chooser->get_action"
.ie n .SS "$chooser\->\fBset_action\fP ($action)"
.el .SS "\f(CW$chooser\fP\->\fBset_action\fP ($action)"
.IX Subsection "$chooser->set_action ($action)"
.IP \(bu 4
\&\f(CW$action\fR (Gtk2::FileChooserAction)
.ie n .SS "$chooser\->\fBadd_filter\fP ($filter)"
.el .SS "\f(CW$chooser\fP\->\fBadd_filter\fP ($filter)"
.IX Subsection "$chooser->add_filter ($filter)"
.IP \(bu 4
\&\f(CW$filter\fR (Gtk2::FileFilter)
.ie n .SS "$chooser\->\fBadd_shortcut_folder\fP ($folder)"
.el .SS "\f(CW$chooser\fP\->\fBadd_shortcut_folder\fP ($folder)"
.IX Subsection "$chooser->add_shortcut_folder ($folder)"
.IP \(bu 4
\&\f(CW$folder\fR (string)
.ie n .SS "$chooser\->\fBadd_shortcut_folder_uri\fP ($folder)"
.el .SS "\f(CW$chooser\fP\->\fBadd_shortcut_folder_uri\fP ($folder)"
.IX Subsection "$chooser->add_shortcut_folder_uri ($folder)"
.IP \(bu 4
\&\f(CW$folder\fR (string)
.ie n .SS "boolean = $chooser\->\fBget_create_folders\fP"
.el .SS "boolean = \f(CW$chooser\fP\->\fBget_create_folders\fP"
.IX Subsection "boolean = $chooser->get_create_folders"
Since: gtk+ 2.18
.ie n .SS "$chooser\->\fBset_create_folders\fP ($create_folders)"
.el .SS "\f(CW$chooser\fP\->\fBset_create_folders\fP ($create_folders)"
.IX Subsection "$chooser->set_create_folders ($create_folders)"
.IP \(bu 4
\&\f(CW$create_folders\fR (boolean)
.PP
Since: gtk+ 2.18
.ie n .SS "string = $chooser\->\fBget_current_folder\fP"
.el .SS "string = \f(CW$chooser\fP\->\fBget_current_folder\fP"
.IX Subsection "string = $chooser->get_current_folder"
.ie n .SS "boolean = $chooser\->\fBset_current_folder\fP ($filename)"
.el .SS "boolean = \f(CW$chooser\fP\->\fBset_current_folder\fP ($filename)"
.IX Subsection "boolean = $chooser->set_current_folder ($filename)"
.IP \(bu 4
\&\f(CW$filename\fR (string)
.ie n .SS "string = $chooser\->\fBget_current_folder_uri\fP"
.el .SS "string = \f(CW$chooser\fP\->\fBget_current_folder_uri\fP"
.IX Subsection "string = $chooser->get_current_folder_uri"
.ie n .SS "boolean = $chooser\->\fBset_current_folder_uri\fP ($uri)"
.el .SS "boolean = \f(CW$chooser\fP\->\fBset_current_folder_uri\fP ($uri)"
.IX Subsection "boolean = $chooser->set_current_folder_uri ($uri)"
.IP \(bu 4
\&\f(CW$uri\fR (string)
.ie n .SS "$chooser\->\fBset_current_name\fP ($name)"
.el .SS "\f(CW$chooser\fP\->\fBset_current_name\fP ($name)"
.IX Subsection "$chooser->set_current_name ($name)"
.IP \(bu 4
\&\f(CW$name\fR (string)
.ie n .SS "boolean = $chooser\->\fBget_do_overwrite_confirmation\fP"
.el .SS "boolean = \f(CW$chooser\fP\->\fBget_do_overwrite_confirmation\fP"
.IX Subsection "boolean = $chooser->get_do_overwrite_confirmation"
Since: gtk+ 2.8
.ie n .SS "$chooser\->\fBset_do_overwrite_confirmation\fP ($do_overwrite_confirmation)"
.el .SS "\f(CW$chooser\fP\->\fBset_do_overwrite_confirmation\fP ($do_overwrite_confirmation)"
.IX Subsection "$chooser->set_do_overwrite_confirmation ($do_overwrite_confirmation)"
.IP \(bu 4
\&\f(CW$do_overwrite_confirmation\fR (boolean)
.PP
Since: gtk+ 2.8
.ie n .SS "widget = $chooser\->\fBget_extra_widget\fP"
.el .SS "widget = \f(CW$chooser\fP\->\fBget_extra_widget\fP"
.IX Subsection "widget = $chooser->get_extra_widget"
.ie n .SS "$chooser\->\fBset_extra_widget\fP ($extra_widget)"
.el .SS "\f(CW$chooser\fP\->\fBset_extra_widget\fP ($extra_widget)"
.IX Subsection "$chooser->set_extra_widget ($extra_widget)"
.IP \(bu 4
\&\f(CW$extra_widget\fR (Gtk2::Widget)
.ie n .SS "string = $chooser\->\fBget_filename\fP"
.el .SS "string = \f(CW$chooser\fP\->\fBget_filename\fP"
.IX Subsection "string = $chooser->get_filename"
.ie n .SS "boolean = $chooser\->\fBset_filename\fP ($filename)"
.el .SS "boolean = \f(CW$chooser\fP\->\fBset_filename\fP ($filename)"
.IX Subsection "boolean = $chooser->set_filename ($filename)"
.IP \(bu 4
\&\f(CW$filename\fR (string)
.ie n .SS "list = $chooser\->\fBget_filenames\fP"
.el .SS "list = \f(CW$chooser\fP\->\fBget_filenames\fP"
.IX Subsection "list = $chooser->get_filenames"
.ie n .SS "filefilter = $chooser\->\fBget_filter\fP"
.el .SS "filefilter = \f(CW$chooser\fP\->\fBget_filter\fP"
.IX Subsection "filefilter = $chooser->get_filter"
.ie n .SS "$chooser\->\fBset_filter\fP ($filter)"
.el .SS "\f(CW$chooser\fP\->\fBset_filter\fP ($filter)"
.IX Subsection "$chooser->set_filter ($filter)"
.IP \(bu 4
\&\f(CW$filter\fR (Gtk2::FileFilter)
.ie n .SS "list = $chooser\->\fBlist_filters\fP"
.el .SS "list = \f(CW$chooser\fP\->\fBlist_filters\fP"
.IX Subsection "list = $chooser->list_filters"
.ie n .SS "list = $chooser\->\fBlist_shortcut_folder_uris\fP"
.el .SS "list = \f(CW$chooser\fP\->\fBlist_shortcut_folder_uris\fP"
.IX Subsection "list = $chooser->list_shortcut_folder_uris"
.ie n .SS "list = $chooser\->\fBlist_shortcut_folders\fP"
.el .SS "list = \f(CW$chooser\fP\->\fBlist_shortcut_folders\fP"
.IX Subsection "list = $chooser->list_shortcut_folders"
.ie n .SS "boolean = $chooser\->\fBget_local_only\fP"
.el .SS "boolean = \f(CW$chooser\fP\->\fBget_local_only\fP"
.IX Subsection "boolean = $chooser->get_local_only"
.ie n .SS "$chooser\->\fBset_local_only\fP ($files_only)"
.el .SS "\f(CW$chooser\fP\->\fBset_local_only\fP ($files_only)"
.IX Subsection "$chooser->set_local_only ($files_only)"
.IP \(bu 4
\&\f(CW$files_only\fR (boolean)
.ie n .SS "localized file name = $file_chooser\->\fBget_preview_filename\fP"
.el .SS "localized file name = \f(CW$file_chooser\fP\->\fBget_preview_filename\fP"
.IX Subsection "localized file name = $file_chooser->get_preview_filename"
.ie n .SS "string = $file_chooser\->\fBget_preview_uri\fP"
.el .SS "string = \f(CW$file_chooser\fP\->\fBget_preview_uri\fP"
.IX Subsection "string = $file_chooser->get_preview_uri"
.ie n .SS "boolean = $chooser\->\fBget_preview_widget_active\fP"
.el .SS "boolean = \f(CW$chooser\fP\->\fBget_preview_widget_active\fP"
.IX Subsection "boolean = $chooser->get_preview_widget_active"
.ie n .SS "$chooser\->\fBset_preview_widget_active\fP ($active)"
.el .SS "\f(CW$chooser\fP\->\fBset_preview_widget_active\fP ($active)"
.IX Subsection "$chooser->set_preview_widget_active ($active)"
.IP \(bu 4
\&\f(CW$active\fR (boolean)
.ie n .SS "widget = $chooser\->\fBget_preview_widget\fP"
.el .SS "widget = \f(CW$chooser\fP\->\fBget_preview_widget\fP"
.IX Subsection "widget = $chooser->get_preview_widget"
.ie n .SS "$chooser\->\fBset_preview_widget\fP ($preview_widget)"
.el .SS "\f(CW$chooser\fP\->\fBset_preview_widget\fP ($preview_widget)"
.IX Subsection "$chooser->set_preview_widget ($preview_widget)"
.IP \(bu 4
\&\f(CW$preview_widget\fR (Gtk2::Widget)
.ie n .SS "$chooser\->\fBremove_filter\fP ($filter)"
.el .SS "\f(CW$chooser\fP\->\fBremove_filter\fP ($filter)"
.IX Subsection "$chooser->remove_filter ($filter)"
.IP \(bu 4
\&\f(CW$filter\fR (Gtk2::FileFilter)
.ie n .SS "$chooser\->\fBremove_shortcut_folder\fP ($folder)"
.el .SS "\f(CW$chooser\fP\->\fBremove_shortcut_folder\fP ($folder)"
.IX Subsection "$chooser->remove_shortcut_folder ($folder)"
.IP \(bu 4
\&\f(CW$folder\fR (string)
.ie n .SS "$chooser\->\fBremove_shortcut_folder_uri\fP ($folder)"
.el .SS "\f(CW$chooser\fP\->\fBremove_shortcut_folder_uri\fP ($folder)"
.IX Subsection "$chooser->remove_shortcut_folder_uri ($folder)"
.IP \(bu 4
\&\f(CW$folder\fR (string)
.ie n .SS $chooser\->\fBselect_all\fP
.el .SS \f(CW$chooser\fP\->\fBselect_all\fP
.IX Subsection "$chooser->select_all"
.ie n .SS "boolean = $chooser\->\fBselect_filename\fP ($filename)"
.el .SS "boolean = \f(CW$chooser\fP\->\fBselect_filename\fP ($filename)"
.IX Subsection "boolean = $chooser->select_filename ($filename)"
.IP \(bu 4
\&\f(CW$filename\fR (string)
.ie n .SS "boolean = $chooser\->\fBget_select_multiple\fP"
.el .SS "boolean = \f(CW$chooser\fP\->\fBget_select_multiple\fP"
.IX Subsection "boolean = $chooser->get_select_multiple"
.ie n .SS "$chooser\->\fBset_select_multiple\fP ($select_multiple)"
.el .SS "\f(CW$chooser\fP\->\fBset_select_multiple\fP ($select_multiple)"
.IX Subsection "$chooser->set_select_multiple ($select_multiple)"
.IP \(bu 4
\&\f(CW$select_multiple\fR (boolean)
.ie n .SS "boolean = $chooser\->\fBselect_uri\fP ($uri)"
.el .SS "boolean = \f(CW$chooser\fP\->\fBselect_uri\fP ($uri)"
.IX Subsection "boolean = $chooser->select_uri ($uri)"
.IP \(bu 4
\&\f(CW$uri\fR (string)
.ie n .SS "boolean = $chooser\->\fBget_show_hidden\fP"
.el .SS "boolean = \f(CW$chooser\fP\->\fBget_show_hidden\fP"
.IX Subsection "boolean = $chooser->get_show_hidden"
Since: gtk+ 2.6
.ie n .SS "$chooser\->\fBset_show_hidden\fP ($show_hidden)"
.el .SS "\f(CW$chooser\fP\->\fBset_show_hidden\fP ($show_hidden)"
.IX Subsection "$chooser->set_show_hidden ($show_hidden)"
.IP \(bu 4
\&\f(CW$show_hidden\fR (boolean)
.PP
Since: gtk+ 2.6
.ie n .SS $chooser\->\fBunselect_all\fP
.el .SS \f(CW$chooser\fP\->\fBunselect_all\fP
.IX Subsection "$chooser->unselect_all"
.ie n .SS "$chooser\->\fBunselect_filename\fP ($filename)"
.el .SS "\f(CW$chooser\fP\->\fBunselect_filename\fP ($filename)"
.IX Subsection "$chooser->unselect_filename ($filename)"
.IP \(bu 4
\&\f(CW$filename\fR (string)
.ie n .SS "$chooser\->\fBunselect_uri\fP ($uri)"
.el .SS "\f(CW$chooser\fP\->\fBunselect_uri\fP ($uri)"
.IX Subsection "$chooser->unselect_uri ($uri)"
.IP \(bu 4
\&\f(CW$uri\fR (string)
.ie n .SS "string = $chooser\->\fBget_uri\fP"
.el .SS "string = \f(CW$chooser\fP\->\fBget_uri\fP"
.IX Subsection "string = $chooser->get_uri"
.ie n .SS "boolean = $chooser\->\fBset_uri\fP ($uri)"
.el .SS "boolean = \f(CW$chooser\fP\->\fBset_uri\fP ($uri)"
.IX Subsection "boolean = $chooser->set_uri ($uri)"
.IP \(bu 4
\&\f(CW$uri\fR (string)
.ie n .SS "list = $chooser\->\fBget_uris\fP"
.el .SS "list = \f(CW$chooser\fP\->\fBget_uris\fP"
.IX Subsection "list = $chooser->get_uris"
.ie n .SS "boolean = $chooser\->\fBget_use_preview_label\fP"
.el .SS "boolean = \f(CW$chooser\fP\->\fBget_use_preview_label\fP"
.IX Subsection "boolean = $chooser->get_use_preview_label"
.ie n .SS "$chooser\->\fBset_use_preview_label\fP ($use_label)"
.el .SS "\f(CW$chooser\fP\->\fBset_use_preview_label\fP ($use_label)"
.IX Subsection "$chooser->set_use_preview_label ($use_label)"
.IP \(bu 4
\&\f(CW$use_label\fR (boolean)
.SH PROPERTIES
.IX Header "PROPERTIES"
.IP "'action' (Gtk2::FileChooserAction : default ""open"" : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'action' (Gtk2::FileChooserAction : default ""open"" : readable / writable / private / static-nick / static-blurb)"
The type of operation that the file selector is performing
.IP "'create\-folders' (boolean : default true : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'create-folders' (boolean : default true : readable / writable / private / static-nick / static-blurb)"
Whether a file chooser not in open mode will offer the user to create new folders.
.IP "'do\-overwrite\-confirmation' (boolean : default false : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'do-overwrite-confirmation' (boolean : default false : readable / writable / private / static-nick / static-blurb)"
Whether a file chooser in save mode will present an overwrite confirmation dialog if necessary.
.IP "'extra\-widget' (Gtk2::Widget : default undef : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'extra-widget' (Gtk2::Widget : default undef : readable / writable / private / static-nick / static-blurb)"
Application supplied widget for extra options.
.IP "'file\-system\-backend' (string : default undef : writable / construct-only / private / static-nick / static-blurb)" 4
.IX Item "'file-system-backend' (string : default undef : writable / construct-only / private / static-nick / static-blurb)"
Name of file system backend to use
.IP "'filter' (Gtk2::FileFilter : default undef : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'filter' (Gtk2::FileFilter : default undef : readable / writable / private / static-nick / static-blurb)"
The current filter for selecting which files are displayed
.IP "'local\-only' (boolean : default true : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'local-only' (boolean : default true : readable / writable / private / static-nick / static-blurb)"
Whether the selected file(s) should be limited to local file: URLs
.IP "'preview\-widget' (Gtk2::Widget : default undef : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'preview-widget' (Gtk2::Widget : default undef : readable / writable / private / static-nick / static-blurb)"
Application supplied widget for custom previews.
.IP "'preview\-widget\-active' (boolean : default true : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'preview-widget-active' (boolean : default true : readable / writable / private / static-nick / static-blurb)"
Whether the application supplied widget for custom previews should be shown.
.IP "'select\-multiple' (boolean : default false : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'select-multiple' (boolean : default false : readable / writable / private / static-nick / static-blurb)"
Whether to allow multiple files to be selected
.IP "'show\-hidden' (boolean : default false : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'show-hidden' (boolean : default false : readable / writable / private / static-nick / static-blurb)"
Whether the hidden files and folders should be displayed
.IP "'use\-preview\-label' (boolean : default true : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'use-preview-label' (boolean : default true : readable / writable / private / static-nick / static-blurb)"
Whether to display a stock label with the name of the previewed file.
.SH SIGNALS
.IX Header "SIGNALS"
.IP "Gtk2::FileChooserConfirmation = \fBconfirm-overwrite\fR (Gtk2::FileChooser)" 4
.IX Item "Gtk2::FileChooserConfirmation = confirm-overwrite (Gtk2::FileChooser)"
.PD 0
.IP "\fBcurrent-folder-changed\fR (Gtk2::FileChooser)" 4
.IX Item "current-folder-changed (Gtk2::FileChooser)"
.IP "\fBfile-activated\fR (Gtk2::FileChooser)" 4
.IX Item "file-activated (Gtk2::FileChooser)"
.IP "\fBselection-changed\fR (Gtk2::FileChooser)" 4
.IX Item "selection-changed (Gtk2::FileChooser)"
.IP "\fBupdate-preview\fR (Gtk2::FileChooser)" 4
.IX Item "update-preview (Gtk2::FileChooser)"
.PD
.SH "ENUMS AND FLAGS"
.IX Header "ENUMS AND FLAGS"
.SS "enum Gtk2::FileChooserAction"
.IX Subsection "enum Gtk2::FileChooserAction"
.IP \(bu 4
\&'open' / 'GTK_FILE_CHOOSER_ACTION_OPEN'
.IP \(bu 4
\&'save' / 'GTK_FILE_CHOOSER_ACTION_SAVE'
.IP \(bu 4
\&'select\-folder' / 'GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER'
.IP \(bu 4
\&'create\-folder' / 'GTK_FILE_CHOOSER_ACTION_CREATE_FOLDER'
.SS "enum Gtk2::FileChooserConfirmation"
.IX Subsection "enum Gtk2::FileChooserConfirmation"
.IP \(bu 4
\&'confirm' / 'GTK_FILE_CHOOSER_CONFIRMATION_CONFIRM'
.IP \(bu 4
\&'accept\-filename' / 'GTK_FILE_CHOOSER_CONFIRMATION_ACCEPT_FILENAME'
.IP \(bu 4
\&'select\-again' / 'GTK_FILE_CHOOSER_CONFIRMATION_SELECT_AGAIN'
.SS "enum Gtk2::FileChooserError"
.IX Subsection "enum Gtk2::FileChooserError"
.IP \(bu 4
\&'nonexistent' / 'GTK_FILE_CHOOSER_ERROR_NONEXISTENT'
.IP \(bu 4
\&'bad\-filename' / 'GTK_FILE_CHOOSER_ERROR_BAD_FILENAME'
.IP \(bu 4
\&'already\-exists' / 'GTK_FILE_CHOOSER_ERROR_ALREADY_EXISTS'
.IP \(bu 4
\&'incomplete\-hostname' / 'GTK_FILE_CHOOSER_ERROR_INCOMPLETE_HOSTNAME'
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Gtk2, Glib::Interface
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2003\-2011 by the gtk2\-perl team.
.PP
This software is licensed under the LGPL.  See Gtk2 for a full notice.