FileSelection

Description GtkFileSelection has been superseded by the newer GtkFileChooser family of widgets. GtkFileSelection should be used to retrieve file or directory names from the user. It will create a new dialog window containing a directory list, and a file list corresponding to the current working directory. The filesystem can be navigated using the directory list or the drop-down history menu. Alternatively, the TAB key can be used to navigate using filename completion - common in text based editors such as emacs and jed. File selection dialogs are created with a call to gtk_file_selection_new(). The default filename can be set using gtk_file_selection_set_filename() and the selected filename retrieved using gtk_file_selection_get_filename(). Use gtk_file_selection_complete() to display files and directories that match a given pattern. This can be used for example, to show only *.txt files, or only files beginning with gtk*. Simple file operations; create directory, delete file, and rename file, are available from buttons at the top of the dialog. These can be hidden using gtk_file_selection_hide_fileop_buttons() and shown again using gtk_file_selection_show_fileop_buttons().

Constructors

this
this(GtkFileSelection* gtkFileSelection)

Sets our main struct and passes it to the parent class

this
this(string title)

Warning gtk_file_selection_new is deprecated and should not be used in newly-written code. Use gtk_file_chooser_dialog_new() instead Creates a new file selection dialog box. By default it will contain a GtkTreeView of the application's current working directory, and a file listing. Operation buttons that allow the user to create a directory, delete files and rename files, are also present.

Members

Functions

complete
void complete(string pattern)

Warning gtk_file_selection_complete is deprecated and should not be used in newly-written code. Will attempt to match pattern to a valid filenames or subdirectories in the current directory. If a match can be made, the matched filename will appear in the text entry field of the file selection dialog. If a partial match can be made, the "Files" list will contain those file names which have been partially matched, and the "Folders" list those directories which have been partially matched.

getFileSelectionStruct
GtkFileSelection* getFileSelectionStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getFilename
string getFilename()

Warning gtk_file_selection_get_filename is deprecated and should not be used in newly-written code. This function returns the selected filename in the GLib file name encoding. To convert to UTF-8, call g_filename_to_utf8(). The returned string points to a statically allocated buffer and should be copied if you plan to keep it around. If no file is selected then the selected directory path is returned.

getSelectMultiple
int getSelectMultiple()

Warning gtk_file_selection_get_select_multiple is deprecated and should not be used in newly-written code. Determines whether or not the user is allowed to select multiple files in the file list. See gtk_file_selection_set_select_multiple().

getSelections
string[] getSelections()

Warning gtk_file_selection_get_selections is deprecated and should not be used in newly-written code. Retrieves the list of file selections the user has made in the dialog box. This function is intended for use when the user can select multiple files in the file list. The filenames are in the GLib file name encoding. To convert to UTF-8, call g_filename_to_utf8() on each string.

getStruct
void* getStruct()

the main Gtk struct as a void*

hideFileopButtons
void hideFileopButtons()

Warning gtk_file_selection_hide_fileop_buttons is deprecated and should not be used in newly-written code. Hides the file operation buttons that normally appear at the top of the dialog. Useful if you wish to create a custom file selector, based on GtkFileSelection.

setFilename
void setFilename(string filename)

Warning gtk_file_selection_set_filename is deprecated and should not be used in newly-written code. Sets a default path for the file requestor. If filename includes a directory path, then the requestor will open with that path as its current working directory. This has the consequence that in order to open the requestor with a working directory and an empty filename, filename must have a trailing directory separator. The encoding of filename is preferred GLib file name encoding, which may not be UTF-8. See g_filename_from_utf8().

setSelectMultiple
void setSelectMultiple(int selectMultiple)

Warning gtk_file_selection_set_select_multiple is deprecated and should not be used in newly-written code. Sets whether the user is allowed to select multiple files in the file list. Use gtk_file_selection_get_selections() to get the list of selected files.

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
showFileopButtons
void showFileopButtons()

Warning gtk_file_selection_show_fileop_buttons is deprecated and should not be used in newly-written code. Shows the file operation buttons, if they have previously been hidden. The rest of the widgets in the dialog will be resized accordingly.

Variables

gtkFileSelection
GtkFileSelection* gtkFileSelection;

the main Gtk struct

Inherited Members

From Dialog

gtkDialog
GtkDialog* gtkDialog;

the main Gtk struct

getDialogStruct
GtkDialog* getDialogStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getStruct
void* getStruct()

the main Gtk struct as a void*

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
addButton
Widget addButton(StockID stockID, int responseId)
addButtons
void addButtons(string[] buttonsText, ResponseType[] responses)
addButtons
void addButtons(StockID[] stockIDs, ResponseType[] responses)
getActionArea
HButtonBox getActionArea()

Returns the action area of dialog. Since 2.14

getContentArea
VBox getContentArea()

Returns the content area of dialog. Since 2.14

connectedSignals
int[string] connectedSignals;
onCloseListeners
void delegate(Dialog)[] onCloseListeners;
Undocumented in source.
addOnClose
void addOnClose(void delegate(Dialog) dlg, ConnectFlags connectFlags)

The ::close signal is a keybinding signal which gets emitted when the user uses a keybinding to close the dialog. The default binding for this signal is the Escape key.

callBackClose
void callBackClose(GtkDialog* arg0Struct, Dialog _dialog)
Undocumented in source. Be warned that the author may not have intended to support it.
onResponseListeners
void delegate(gint, Dialog)[] onResponseListeners;
Undocumented in source.
addOnResponse
void addOnResponse(void delegate(gint, Dialog) dlg, ConnectFlags connectFlags)

Emitted when an action widget is clicked, the dialog receives a delete event, or the application programmer calls gtk_dialog_response(). On a delete event, the response ID is GTK_RESPONSE_DELETE_EVENT. Otherwise, it depends on which action widget was clicked. See Also GtkVBox Pack widgets vertically. GtkWindow Alter the properties of your dialog box. GtkButton Add them to the action_area to get a response from the user.

callBackResponse
void callBackResponse(GtkDialog* dialogStruct, gint responseId, Dialog _dialog)
Undocumented in source. Be warned that the author may not have intended to support it.
run
int run()

Blocks in a recursive main loop until the dialog either emits the "response" signal, or is destroyed. If the dialog is destroyed during the call to gtk_dialog_run(), gtk_dialog_run() returns GTK_RESPONSE_NONE. Otherwise, it returns the response ID from the ::response signal emission. Before entering the recursive main loop, gtk_dialog_run() calls gtk_widget_show() on the dialog for you. Note that you still need to show any children of the dialog yourself. During gtk_dialog_run(), the default behavior of "delete-event" is disabled; if the dialog receives ::delete_event, it will not be destroyed as windows usually are, and gtk_dialog_run() will return GTK_RESPONSE_DELETE_EVENT. Also, during gtk_dialog_run() the dialog will be modal. You can force gtk_dialog_run() to return at any time by calling gtk_dialog_response() to emit the ::response signal. Destroying the dialog during gtk_dialog_run() is a very bad idea, because your post-run code won't know whether the dialog was destroyed or not. After gtk_dialog_run() returns, you are responsible for hiding or destroying the dialog if you wish to do so.

response
void response(int responseId)

Emits the "response" signal with the given response ID. Used to indicate that the user has responded to the dialog in some way; typically either you or gtk_dialog_run() will be monitoring the ::response signal and take appropriate action.

addButton
Widget addButton(string buttonText, int responseId)

Adds a button with the given text (or a stock button, if button_text is a stock ID) and sets things up so that clicking the button will emit the "response" signal with the given response_id. The button is appended to the end of the dialog's action area. The button widget is returned, but usually you don't need it.

addActionWidget
void addActionWidget(Widget child, int responseId)

Adds an activatable widget to the action area of a GtkDialog, connecting a signal handler that will emit the "response" signal on the dialog when the widget is activated. The widget is appended to the end of the dialog's action area. If you want to add a non-activatable widget, simply pack it into the action_area field of the GtkDialog struct.

getHasSeparator
int getHasSeparator()

Warning gtk_dialog_get_has_separator has been deprecated since version 2.22 and should not be used in newly-written code. This function will be removed in GTK+ 3 Accessor for whether the dialog has a separator.

setDefaultResponse
void setDefaultResponse(int responseId)

Sets the last widget in the dialog's action area with the given response_id as the default widget for the dialog. Pressing "Enter" normally activates the default widget.

setHasSeparator
void setHasSeparator(int setting)

Warning gtk_dialog_set_has_separator has been deprecated since version 2.22 and should not be used in newly-written code. This function will be removed in GTK+ 3 Sets whether the dialog has a separator above the buttons.

setResponseSensitive
void setResponseSensitive(int responseId, int setting)

Calls gtk_widget_set_sensitive (widget, setting) for each widget in the dialog's action area with the given response_id. A convenient way to sensitize/desensitize dialog buttons.

getResponseForWidget
int getResponseForWidget(Widget widget)

Gets the response id of a widget in the action area of a dialog. Since 2.8

getWidgetForResponse
Widget getWidgetForResponse(int responseId)

Gets the widget button that uses the given response ID in the action area of a dialog. Since 2.20

alternativeDialogButtonOrder
int alternativeDialogButtonOrder(Screen screen)

Returns TRUE if dialogs are expected to use an alternative button order on the screen screen. See gtk_dialog_set_alternative_button_order() for more details about alternative button order. If you need to use this function, you should probably connect to the ::notify:gtk-alternative-button-order signal on the GtkSettings object associated to screen, in order to be notified if the button order setting changes. Since 2.6

setAlternativeButtonOrderFromArray
void setAlternativeButtonOrderFromArray(int[] newOrder)

Sets an alternative button order. If the "gtk-alternative-button-order" setting is set to TRUE, the dialog buttons are reordered according to the order of the response ids in new_order. See gtk_dialog_set_alternative_button_order() for more information. This function is for use by language bindings. Since 2.6

Meta