Files
gtk2/docs/reference/gtk/tmpl/gtkfilechooser.sgml
Federico Mena Quintero 8d7d50cb7f Added the text for the initial section, and descriptions for the signals
2003-10-23  Federico Mena Quintero  <federico@ximian.com>

	* gtk/tmpl/gtkfilechooser.sgml: Added the text for the initial
	section, and descriptions for the signals and enumerations.

	* gtk/tmpl/gtkfilechooserdialog.sgml: Added the text for the
	initial section, and a short example.

	* gtk/tmpl/gtkfilechooserwidget.sgml: Added the text for the
	initial section.
2003-10-23 22:59:34 +00:00

470 lines
6.4 KiB
Plaintext

<!-- ##### SECTION Title ##### -->
GtkFileChooser
<!-- ##### SECTION Short_Description ##### -->
File chooser interface used by #GtkFileChooserWidget and #GtkFileChooserDialog.
<!-- ##### SECTION Long_Description ##### -->
<para>
#GtkFileChooser is an interface that can be implemented by file
selection widgets. In GTK+, the main objects that implement
this interface are #GtkFileChooserWidget and
#GtkFileChooserDialog. You do not need to write an object that
implements the #GtkFileChooser interface unless you are trying
to adapt an existing file selector to expose a standard
programming interface.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GtkFileChooserDialog, #GtkFileChooserWidget
</para>
<!-- ##### ENUM GtkFileChooserAction ##### -->
<para>
Describes whether a #GtkFileChooser is being used to open
existing files or to save to a possibly new file.
</para>
@GTK_FILE_CHOOSER_ACTION_OPEN: Indicates Open mode. The file chooser
will only let the user pick an existing file.
@GTK_FILE_CHOOSER_ACTION_SAVE: Indicates Save mode. The file chooser
will let the user pick an existing file, or type in a new
filename.
<!-- ##### MACRO GTK_FILE_CHOOSER_ERROR ##### -->
<para>
Used to get the #GError quark for #GtkFileChooser errors.
</para>
<!-- ##### ENUM GtkFileChooserError ##### -->
<para>
These identify the various errors that can occur while calling
#GtkFileChooser functions.
</para>
@GTK_FILE_CHOOSER_ERROR_NONEXISTENT: Indicates that a file does not exist.
@GTK_FILE_CHOOSER_ERROR_BAD_FILENAME: Indicates a malformed filename.
<!-- ##### FUNCTION gtk_file_chooser_error_quark ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gtk_file_chooser_set_action ##### -->
<para>
</para>
@chooser:
@action:
<!-- ##### FUNCTION gtk_file_chooser_get_action ##### -->
<para>
</para>
@chooser:
@Returns:
<!-- ##### FUNCTION gtk_file_chooser_set_folder_mode ##### -->
<para>
</para>
@chooser:
@folder_mode:
<!-- ##### FUNCTION gtk_file_chooser_get_folder_mode ##### -->
<para>
</para>
@chooser:
@Returns:
<!-- ##### FUNCTION gtk_file_chooser_set_local_only ##### -->
<para>
</para>
@chooser:
@files_only:
<!-- ##### FUNCTION gtk_file_chooser_get_local_only ##### -->
<para>
</para>
@chooser:
@Returns:
<!-- ##### FUNCTION gtk_file_chooser_set_select_multiple ##### -->
<para>
</para>
@chooser:
@select_multiple:
<!-- ##### FUNCTION gtk_file_chooser_get_select_multiple ##### -->
<para>
</para>
@chooser:
@Returns:
<!-- ##### FUNCTION gtk_file_chooser_set_current_name ##### -->
<para>
</para>
@chooser:
@name:
<!-- ##### FUNCTION gtk_file_chooser_get_filename ##### -->
<para>
</para>
@chooser:
@Returns:
<!-- ##### FUNCTION gtk_file_chooser_set_filename ##### -->
<para>
</para>
@chooser:
@filename:
<!-- ##### FUNCTION gtk_file_chooser_select_filename ##### -->
<para>
</para>
@chooser:
@filename:
<!-- ##### FUNCTION gtk_file_chooser_unselect_filename ##### -->
<para>
</para>
@chooser:
@filename:
<!-- ##### FUNCTION gtk_file_chooser_select_all ##### -->
<para>
</para>
@chooser:
<!-- ##### FUNCTION gtk_file_chooser_unselect_all ##### -->
<para>
</para>
@chooser:
<!-- ##### FUNCTION gtk_file_chooser_get_filenames ##### -->
<para>
</para>
@chooser:
@Returns:
<!-- ##### FUNCTION gtk_file_chooser_set_current_folder ##### -->
<para>
</para>
@chooser:
@filename:
<!-- ##### FUNCTION gtk_file_chooser_get_current_folder ##### -->
<para>
</para>
@chooser:
@Returns:
<!-- ##### FUNCTION gtk_file_chooser_get_uri ##### -->
<para>
</para>
@chooser:
@Returns:
<!-- ##### FUNCTION gtk_file_chooser_set_uri ##### -->
<para>
</para>
@chooser:
@uri:
<!-- ##### FUNCTION gtk_file_chooser_select_uri ##### -->
<para>
</para>
@chooser:
@uri:
<!-- ##### FUNCTION gtk_file_chooser_unselect_uri ##### -->
<para>
</para>
@chooser:
@uri:
<!-- ##### FUNCTION gtk_file_chooser_get_uris ##### -->
<para>
</para>
@chooser:
@Returns:
<!-- ##### FUNCTION gtk_file_chooser_set_current_folder_uri ##### -->
<para>
</para>
@chooser:
@uri:
<!-- ##### FUNCTION gtk_file_chooser_get_current_folder_uri ##### -->
<para>
</para>
@chooser:
@Returns:
<!-- ##### FUNCTION gtk_file_chooser_set_preview_widget ##### -->
<para>
</para>
@chooser:
@preview_widget:
<!-- ##### FUNCTION gtk_file_chooser_get_preview_widget ##### -->
<para>
</para>
@chooser:
@Returns:
<!-- ##### FUNCTION gtk_file_chooser_set_preview_widget_active ##### -->
<para>
</para>
@chooser:
@active:
<!-- ##### FUNCTION gtk_file_chooser_get_preview_widget_active ##### -->
<para>
</para>
@chooser:
@Returns:
<!-- ##### FUNCTION gtk_file_chooser_get_preview_filename ##### -->
<para>
</para>
@file_chooser:
@Returns:
<!-- ##### FUNCTION gtk_file_chooser_get_preview_uri ##### -->
<para>
</para>
@file_chooser:
@Returns:
<!-- ##### FUNCTION gtk_file_chooser_set_extra_widget ##### -->
<para>
</para>
@chooser:
@extra_widget:
<!-- ##### FUNCTION gtk_file_chooser_get_extra_widget ##### -->
<para>
</para>
@chooser:
@Returns:
<!-- ##### FUNCTION gtk_file_chooser_add_filter ##### -->
<para>
</para>
@chooser:
@filter:
<!-- ##### FUNCTION gtk_file_chooser_remove_filter ##### -->
<para>
</para>
@chooser:
@filter:
<!-- ##### FUNCTION gtk_file_chooser_list_filters ##### -->
<para>
</para>
@chooser:
@Returns:
<!-- ##### FUNCTION gtk_file_chooser_set_filter ##### -->
<para>
</para>
@chooser:
@filter:
<!-- ##### FUNCTION gtk_file_chooser_get_filter ##### -->
<para>
</para>
@chooser:
@Returns:
<!-- ##### FUNCTION gtk_file_chooser_add_shortcut_folder ##### -->
<para>
</para>
@chooser:
@folder:
@error:
@Returns:
<!-- ##### FUNCTION gtk_file_chooser_remove_shortcut_folder ##### -->
<para>
</para>
@chooser:
@folder:
@error:
@Returns:
<!-- ##### FUNCTION gtk_file_chooser_list_shortcut_folders ##### -->
<para>
</para>
@chooser:
@Returns:
<!-- ##### FUNCTION gtk_file_chooser_add_shortcut_folder_uri ##### -->
<para>
</para>
@chooser:
@folder:
@error:
@Returns:
<!-- ##### FUNCTION gtk_file_chooser_remove_shortcut_folder_uri ##### -->
<para>
</para>
@chooser:
@folder:
@error:
@Returns:
<!-- ##### FUNCTION gtk_file_chooser_list_shortcut_folder_uris ##### -->
<para>
</para>
@chooser:
@Returns:
<!--
Local variables:
mode: sgml
sgml-parent-document: ("../gtk-docs.sgml" "book" "refentry")
End:
-->