---
name: "Gtk2::FileChooser"
section: "3pm"
platform: "linux"
package: "libgtk2-perl-doc"
version: "2:1.24992-1"
release: "Debian 10 (Buster)"
platforms: ["linux"]
url: "https://new.carta.tech/Gtk2::FileChooser"
---

# Gtk2::FileChooser(3pm)

wrapper for GtkFileChooser

## NAME

Gtk2::FileChooser - wrapper for GtkFileChooser

## HIERARCHY

```
  Glib::Interface
  +----Gtk2::FileChooser
```

## METHODS

### filechooseraction = $chooser-\>get\_action

### $chooser-\>set\_action ($action)

- •

  `$action` (Gtk2::FileChooserAction)

### $chooser-\>add\_filter ($filter)

- •

  `$filter` (Gtk2::FileFilter)

### $chooser-\>add\_shortcut\_folder ($folder)

- •

  `$folder` (string)

### $chooser-\>add\_shortcut\_folder\_uri ($folder)

- •

  `$folder` (string)

### boolean = $chooser-\>get\_create\_folders

Since: gtk+ 2.18

### $chooser-\>set\_create\_folders ($create\_folders)

- •

  `$create_folders` (boolean)

Since: gtk+ 2.18

### string = $chooser-\>get\_current\_folder

### boolean = $chooser-\>set\_current\_folder ($filename)

- •

  `$filename` (string)

### string = $chooser-\>get\_current\_folder\_uri

### boolean = $chooser-\>set\_current\_folder\_uri ($uri)

- •

  `$uri` (string)

### $chooser-\>set\_current\_name ($name)

- •

  `$name` (string)

### boolean = $chooser-\>get\_do\_overwrite\_confirmation

Since: gtk+ 2.8

### $chooser-\>set\_do\_overwrite\_confirmation ($do\_overwrite\_confirmation)

- •

  `$do_overwrite_confirmation` (boolean)

Since: gtk+ 2.8

### widget = $chooser-\>get\_extra\_widget

### $chooser-\>set\_extra\_widget ($extra\_widget)

- •

  `$extra_widget` (Gtk2::Widget)

### string = $chooser-\>get\_filename

### boolean = $chooser-\>set\_filename ($filename)

- •

  `$filename` (string)

### list = $chooser-\>get\_filenames

### filefilter = $chooser-\>get\_filter

### $chooser-\>set\_filter ($filter)

- •

  `$filter` (Gtk2::FileFilter)

### list = $chooser-\>list\_filters

### list = $chooser-\>list\_shortcut\_folder\_uris

### list = $chooser-\>list\_shortcut\_folders

### boolean = $chooser-\>get\_local\_only

### $chooser-\>set\_local\_only ($files\_only)

- •

  `$files_only` (boolean)

### localized file name = $file\_chooser-\>get\_preview\_filename

### string = $file\_chooser-\>get\_preview\_uri

### boolean = $chooser-\>get\_preview\_widget\_active

### $chooser-\>set\_preview\_widget\_active ($active)

- •

  `$active` (boolean)

### widget = $chooser-\>get\_preview\_widget

### $chooser-\>set\_preview\_widget ($preview\_widget)

- •

  `$preview_widget` (Gtk2::Widget)

### $chooser-\>remove\_filter ($filter)

- •

  `$filter` (Gtk2::FileFilter)

### $chooser-\>remove\_shortcut\_folder ($folder)

- •

  `$folder` (string)

### $chooser-\>remove\_shortcut\_folder\_uri ($folder)

- •

  `$folder` (string)

### $chooser-\>select\_all

### boolean = $chooser-\>select\_filename ($filename)

- •

  `$filename` (string)

### boolean = $chooser-\>get\_select\_multiple

### $chooser-\>set\_select\_multiple ($select\_multiple)

- •

  `$select_multiple` (boolean)

### boolean = $chooser-\>select\_uri ($uri)

- •

  `$uri` (string)

### boolean = $chooser-\>get\_show\_hidden

Since: gtk+ 2.6

### $chooser-\>set\_show\_hidden ($show\_hidden)

- •

  `$show_hidden` (boolean)

Since: gtk+ 2.6

### $chooser-\>unselect\_all

### $chooser-\>unselect\_filename ($filename)

- •

  `$filename` (string)

### $chooser-\>unselect\_uri ($uri)

- •

  `$uri` (string)

### string = $chooser-\>get\_uri

### boolean = $chooser-\>set\_uri ($uri)

- •

  `$uri` (string)

### list = $chooser-\>get\_uris

### boolean = $chooser-\>get\_use\_preview\_label

### $chooser-\>set\_use\_preview\_label ($use\_label)

- •

  `$use_label` (boolean)

## PROPERTIES

- 'action' (Gtk2::FileChooserAction : default "open" : readable / writable / private)

  The type of operation that the file selector is performing

- 'create-folders' (boolean : default true : readable / writable / private)

  Whether a file chooser not in open mode will offer the user to create new folders.

- 'do-overwrite-confirmation' (boolean : default false : readable / writable / private)

  Whether a file chooser in save mode will present an overwrite confirmation dialog if necessary.

- 'extra-widget' (Gtk2::Widget : default undef : readable / writable / private)

  Application supplied widget for extra options.

- 'file-system-backend' (string : default undef : writable / construct-only / private)

  Name of file system backend to use

- 'filter' (Gtk2::FileFilter : default undef : readable / writable / private)

  The current filter for selecting which files are displayed

- 'local-only' (boolean : default true : readable / writable / private)

  Whether the selected file(s) should be limited to local file: URLs

- 'preview-widget' (Gtk2::Widget : default undef : readable / writable / private)

  Application supplied widget for custom previews.

- 'preview-widget-active' (boolean : default true : readable / writable / private)

  Whether the application supplied widget for custom previews should be shown.

- 'select-multiple' (boolean : default false : readable / writable / private)

  Whether to allow multiple files to be selected

- 'show-hidden' (boolean : default false : readable / writable / private)

  Whether the hidden files and folders should be displayed

- 'use-preview-label' (boolean : default true : readable / writable / private)

  Whether to display a stock label with the name of the previewed file.

## SIGNALS

- Gtk2::FileChooserConfirmation = **confirm-overwrite** (Gtk2::FileChooser)

  - **current-folder-changed** (Gtk2::FileChooser)

  - **file-activated** (Gtk2::FileChooser)

  - **selection-changed** (Gtk2::FileChooser)

  - **update-preview** (Gtk2::FileChooser)

  ## ENUMS AND FLAGS

### enum Gtk2::FileChooserAction

- •

  'open' / 'GTK\_FILE\_CHOOSER\_ACTION\_OPEN'

- •

  'save' / 'GTK\_FILE\_CHOOSER\_ACTION\_SAVE'

- •

  'select-folder' / 'GTK\_FILE\_CHOOSER\_ACTION\_SELECT\_FOLDER'

- •

  'create-folder' / 'GTK\_FILE\_CHOOSER\_ACTION\_CREATE\_FOLDER'

### enum Gtk2::FileChooserConfirmation

- •

  'confirm' / 'GTK\_FILE\_CHOOSER\_CONFIRMATION\_CONFIRM'

- •

  'accept-filename' / 'GTK\_FILE\_CHOOSER\_CONFIRMATION\_ACCEPT\_FILENAME'

- •

  'select-again' / 'GTK\_FILE\_CHOOSER\_CONFIRMATION\_SELECT\_AGAIN'

### enum Gtk2::FileChooserError

- •

  'nonexistent' / 'GTK\_FILE\_CHOOSER\_ERROR\_NONEXISTENT'

- •

  'bad-filename' / 'GTK\_FILE\_CHOOSER\_ERROR\_BAD\_FILENAME'

- •

  'already-exists' / 'GTK\_FILE\_CHOOSER\_ERROR\_ALREADY\_EXISTS'

- •

  'incomplete-hostname' / 'GTK\_FILE\_CHOOSER\_ERROR\_INCOMPLETE\_HOSTNAME'

## SEE ALSO

Gtk2, Glib::Interface

## COPYRIGHT

Copyright (C) 2003-2011 by the gtk2-perl team.

This software is licensed under the LGPL.  See Gtk2 for a full notice.