2008-07-01 22:57:50 +00:00
|
|
|
/* GTK - The GIMP Toolkit
|
2003-03-21 20:34:02 +00:00
|
|
|
* gtkfilechooser.h: Abstract interface for file selector GUIs
|
|
|
|
|
* Copyright (C) 2003, Red Hat, Inc.
|
|
|
|
|
*
|
|
|
|
|
* This library is free software; you can redistribute it and/or
|
|
|
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
|
|
|
* License as published by the Free Software Foundation; either
|
|
|
|
|
* version 2 of the License, or (at your option) any later version.
|
|
|
|
|
*
|
|
|
|
|
* This library is distributed in the hope that it will be useful,
|
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
|
* Lesser General Public License for more details.
|
|
|
|
|
*
|
|
|
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
|
|
|
* License along with this library; if not, write to the
|
|
|
|
|
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
|
|
* Boston, MA 02111-1307, USA.
|
|
|
|
|
*/
|
|
|
|
|
|
2008-05-28 15:07:04 +00:00
|
|
|
#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
|
|
|
|
|
#error "Only <gtk/gtk.h> can be included directly."
|
|
|
|
|
#endif
|
|
|
|
|
|
2003-03-21 20:34:02 +00:00
|
|
|
#ifndef __GTK_FILE_CHOOSER_H__
|
|
|
|
|
#define __GTK_FILE_CHOOSER_H__
|
|
|
|
|
|
2008-06-13 14:26:44 +00:00
|
|
|
#include <gtk/gtkfilefilter.h>
|
2003-03-21 20:34:02 +00:00
|
|
|
#include <gtk/gtkwidget.h>
|
|
|
|
|
|
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
|
|
|
|
|
|
#define GTK_TYPE_FILE_CHOOSER (gtk_file_chooser_get_type ())
|
|
|
|
|
#define GTK_FILE_CHOOSER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_FILE_CHOOSER, GtkFileChooser))
|
|
|
|
|
#define GTK_IS_FILE_CHOOSER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_FILE_CHOOSER))
|
|
|
|
|
|
|
|
|
|
typedef struct _GtkFileChooser GtkFileChooser;
|
|
|
|
|
|
|
|
|
|
typedef enum
|
|
|
|
|
{
|
|
|
|
|
GTK_FILE_CHOOSER_ACTION_OPEN,
|
2004-02-26 23:35:05 +00:00
|
|
|
GTK_FILE_CHOOSER_ACTION_SAVE,
|
|
|
|
|
GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER,
|
|
|
|
|
GTK_FILE_CHOOSER_ACTION_CREATE_FOLDER
|
2003-03-21 20:34:02 +00:00
|
|
|
} GtkFileChooserAction;
|
|
|
|
|
|
2005-07-15 04:55:56 +00:00
|
|
|
typedef enum
|
|
|
|
|
{
|
|
|
|
|
GTK_FILE_CHOOSER_CONFIRMATION_CONFIRM,
|
|
|
|
|
GTK_FILE_CHOOSER_CONFIRMATION_ACCEPT_FILENAME,
|
|
|
|
|
GTK_FILE_CHOOSER_CONFIRMATION_SELECT_AGAIN
|
|
|
|
|
} GtkFileChooserConfirmation;
|
|
|
|
|
|
2004-11-23 20:02:15 +00:00
|
|
|
GType gtk_file_chooser_get_type (void) G_GNUC_CONST;
|
2003-03-21 20:34:02 +00:00
|
|
|
|
2003-10-18 04:29:40 +00:00
|
|
|
/* GError enumeration for GtkFileChooser */
|
|
|
|
|
|
|
|
|
|
#define GTK_FILE_CHOOSER_ERROR (gtk_file_chooser_error_quark ())
|
|
|
|
|
|
|
|
|
|
typedef enum {
|
|
|
|
|
GTK_FILE_CHOOSER_ERROR_NONEXISTENT,
|
2005-10-10 14:29:03 +00:00
|
|
|
GTK_FILE_CHOOSER_ERROR_BAD_FILENAME,
|
2009-01-21 03:17:01 +00:00
|
|
|
GTK_FILE_CHOOSER_ERROR_ALREADY_EXISTS,
|
|
|
|
|
GTK_FILE_CHOOSER_ERROR_INCOMPLETE_HOSTNAME
|
2003-10-18 04:29:40 +00:00
|
|
|
} GtkFileChooserError;
|
|
|
|
|
|
|
|
|
|
GQuark gtk_file_chooser_error_quark (void);
|
|
|
|
|
|
2003-03-21 20:34:02 +00:00
|
|
|
/* Configuration
|
|
|
|
|
*/
|
|
|
|
|
void gtk_file_chooser_set_action (GtkFileChooser *chooser,
|
|
|
|
|
GtkFileChooserAction action);
|
|
|
|
|
GtkFileChooserAction gtk_file_chooser_get_action (GtkFileChooser *chooser);
|
|
|
|
|
void gtk_file_chooser_set_local_only (GtkFileChooser *chooser,
|
2003-11-15 23:44:33 +00:00
|
|
|
gboolean local_only);
|
2003-03-21 20:34:02 +00:00
|
|
|
gboolean gtk_file_chooser_get_local_only (GtkFileChooser *chooser);
|
|
|
|
|
void gtk_file_chooser_set_select_multiple (GtkFileChooser *chooser,
|
|
|
|
|
gboolean select_multiple);
|
|
|
|
|
gboolean gtk_file_chooser_get_select_multiple (GtkFileChooser *chooser);
|
2004-08-04 20:45:23 +00:00
|
|
|
void gtk_file_chooser_set_show_hidden (GtkFileChooser *chooser,
|
|
|
|
|
gboolean show_hidden);
|
|
|
|
|
gboolean gtk_file_chooser_get_show_hidden (GtkFileChooser *chooser);
|
2003-03-21 20:34:02 +00:00
|
|
|
|
2005-07-15 04:55:56 +00:00
|
|
|
void gtk_file_chooser_set_do_overwrite_confirmation (GtkFileChooser *chooser,
|
|
|
|
|
gboolean do_overwrite_confirmation);
|
|
|
|
|
gboolean gtk_file_chooser_get_do_overwrite_confirmation (GtkFileChooser *chooser);
|
|
|
|
|
|
2009-07-28 12:15:59 +00:00
|
|
|
void gtk_file_chooser_set_create_folders (GtkFileChooser *chooser,
|
|
|
|
|
gboolean create_folders);
|
|
|
|
|
gboolean gtk_file_chooser_get_create_folders (GtkFileChooser *chooser);
|
|
|
|
|
|
2004-03-05 20:47:05 +00:00
|
|
|
/* Suggested name for the Save-type actions
|
|
|
|
|
*/
|
|
|
|
|
void gtk_file_chooser_set_current_name (GtkFileChooser *chooser,
|
|
|
|
|
const gchar *name);
|
|
|
|
|
|
2003-03-21 20:34:02 +00:00
|
|
|
/* Filename manipulation
|
|
|
|
|
*/
|
2004-12-12 21:09:13 +00:00
|
|
|
#ifdef G_OS_WIN32
|
|
|
|
|
/* Reserve old names for DLL ABI backward compatibility */
|
|
|
|
|
#define gtk_file_chooser_get_filename gtk_file_chooser_get_filename_utf8
|
|
|
|
|
#define gtk_file_chooser_set_filename gtk_file_chooser_set_filename_utf8
|
|
|
|
|
#define gtk_file_chooser_select_filename gtk_file_chooser_select_filename_utf8
|
|
|
|
|
#define gtk_file_chooser_unselect_filename gtk_file_chooser_unselect_filename_utf8
|
|
|
|
|
#define gtk_file_chooser_get_filenames gtk_file_chooser_get_filenames_utf8
|
|
|
|
|
#define gtk_file_chooser_set_current_folder gtk_file_chooser_set_current_folder_utf8
|
|
|
|
|
#define gtk_file_chooser_get_current_folder gtk_file_chooser_get_current_folder_utf8
|
|
|
|
|
#define gtk_file_chooser_get_preview_filename gtk_file_chooser_get_preview_filename_utf8
|
|
|
|
|
#define gtk_file_chooser_add_shortcut_folder gtk_file_chooser_add_shortcut_folder_utf8
|
|
|
|
|
#define gtk_file_chooser_remove_shortcut_folder gtk_file_chooser_remove_shortcut_folder_utf8
|
|
|
|
|
#define gtk_file_chooser_list_shortcut_folders gtk_file_chooser_list_shortcut_folders_utf8
|
|
|
|
|
#endif
|
|
|
|
|
|
2004-03-05 20:47:05 +00:00
|
|
|
gchar * gtk_file_chooser_get_filename (GtkFileChooser *chooser);
|
|
|
|
|
gboolean gtk_file_chooser_set_filename (GtkFileChooser *chooser,
|
|
|
|
|
const char *filename);
|
|
|
|
|
gboolean gtk_file_chooser_select_filename (GtkFileChooser *chooser,
|
|
|
|
|
const char *filename);
|
|
|
|
|
void gtk_file_chooser_unselect_filename (GtkFileChooser *chooser,
|
|
|
|
|
const char *filename);
|
|
|
|
|
void gtk_file_chooser_select_all (GtkFileChooser *chooser);
|
|
|
|
|
void gtk_file_chooser_unselect_all (GtkFileChooser *chooser);
|
|
|
|
|
GSList * gtk_file_chooser_get_filenames (GtkFileChooser *chooser);
|
|
|
|
|
gboolean gtk_file_chooser_set_current_folder (GtkFileChooser *chooser,
|
|
|
|
|
const gchar *filename);
|
|
|
|
|
gchar * gtk_file_chooser_get_current_folder (GtkFileChooser *chooser);
|
2003-03-21 20:34:02 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
/* URI manipulation
|
|
|
|
|
*/
|
2004-03-05 20:47:05 +00:00
|
|
|
gchar * gtk_file_chooser_get_uri (GtkFileChooser *chooser);
|
|
|
|
|
gboolean gtk_file_chooser_set_uri (GtkFileChooser *chooser,
|
|
|
|
|
const char *uri);
|
|
|
|
|
gboolean gtk_file_chooser_select_uri (GtkFileChooser *chooser,
|
|
|
|
|
const char *uri);
|
|
|
|
|
void gtk_file_chooser_unselect_uri (GtkFileChooser *chooser,
|
|
|
|
|
const char *uri);
|
|
|
|
|
GSList * gtk_file_chooser_get_uris (GtkFileChooser *chooser);
|
|
|
|
|
gboolean gtk_file_chooser_set_current_folder_uri (GtkFileChooser *chooser,
|
|
|
|
|
const gchar *uri);
|
|
|
|
|
gchar * gtk_file_chooser_get_current_folder_uri (GtkFileChooser *chooser);
|
2003-03-21 20:34:02 +00:00
|
|
|
|
2008-08-04 14:43:05 +00:00
|
|
|
/* GFile manipulation */
|
|
|
|
|
GFile * gtk_file_chooser_get_file (GtkFileChooser *chooser);
|
|
|
|
|
gboolean gtk_file_chooser_set_file (GtkFileChooser *chooser,
|
|
|
|
|
GFile *file,
|
|
|
|
|
GError **error);
|
|
|
|
|
gboolean gtk_file_chooser_select_file (GtkFileChooser *chooser,
|
|
|
|
|
GFile *file,
|
|
|
|
|
GError **error);
|
|
|
|
|
void gtk_file_chooser_unselect_file (GtkFileChooser *chooser,
|
|
|
|
|
GFile *file);
|
|
|
|
|
GSList * gtk_file_chooser_get_files (GtkFileChooser *chooser);
|
|
|
|
|
gboolean gtk_file_chooser_set_current_folder_file (GtkFileChooser *chooser,
|
|
|
|
|
GFile *file,
|
|
|
|
|
GError **error);
|
|
|
|
|
GFile * gtk_file_chooser_get_current_folder_file (GtkFileChooser *chooser);
|
|
|
|
|
|
2003-03-21 20:34:02 +00:00
|
|
|
/* Preview widget
|
|
|
|
|
*/
|
|
|
|
|
void gtk_file_chooser_set_preview_widget (GtkFileChooser *chooser,
|
|
|
|
|
GtkWidget *preview_widget);
|
|
|
|
|
GtkWidget *gtk_file_chooser_get_preview_widget (GtkFileChooser *chooser);
|
|
|
|
|
void gtk_file_chooser_set_preview_widget_active (GtkFileChooser *chooser,
|
|
|
|
|
gboolean active);
|
|
|
|
|
gboolean gtk_file_chooser_get_preview_widget_active (GtkFileChooser *chooser);
|
2004-02-29 06:35:15 +00:00
|
|
|
void gtk_file_chooser_set_use_preview_label (GtkFileChooser *chooser,
|
|
|
|
|
gboolean use_label);
|
|
|
|
|
gboolean gtk_file_chooser_get_use_preview_label (GtkFileChooser *chooser);
|
2003-03-21 20:34:02 +00:00
|
|
|
|
2008-08-04 14:43:05 +00:00
|
|
|
char *gtk_file_chooser_get_preview_filename (GtkFileChooser *chooser);
|
|
|
|
|
char *gtk_file_chooser_get_preview_uri (GtkFileChooser *chooser);
|
|
|
|
|
GFile *gtk_file_chooser_get_preview_file (GtkFileChooser *chooser);
|
2003-03-21 20:34:02 +00:00
|
|
|
|
2003-09-03 05:52:35 +00:00
|
|
|
/* Extra widget
|
|
|
|
|
*/
|
|
|
|
|
void gtk_file_chooser_set_extra_widget (GtkFileChooser *chooser,
|
|
|
|
|
GtkWidget *extra_widget);
|
|
|
|
|
GtkWidget *gtk_file_chooser_get_extra_widget (GtkFileChooser *chooser);
|
|
|
|
|
|
2003-07-23 15:31:10 +00:00
|
|
|
/* List of user selectable filters
|
2003-03-21 20:34:02 +00:00
|
|
|
*/
|
2003-07-23 15:31:10 +00:00
|
|
|
void gtk_file_chooser_add_filter (GtkFileChooser *chooser,
|
|
|
|
|
GtkFileFilter *filter);
|
|
|
|
|
void gtk_file_chooser_remove_filter (GtkFileChooser *chooser,
|
|
|
|
|
GtkFileFilter *filter);
|
|
|
|
|
GSList *gtk_file_chooser_list_filters (GtkFileChooser *chooser);
|
2003-03-21 20:34:02 +00:00
|
|
|
|
2003-07-23 15:31:10 +00:00
|
|
|
/* Current filter
|
|
|
|
|
*/
|
|
|
|
|
void gtk_file_chooser_set_filter (GtkFileChooser *chooser,
|
|
|
|
|
GtkFileFilter *filter);
|
|
|
|
|
GtkFileFilter *gtk_file_chooser_get_filter (GtkFileChooser *chooser);
|
2003-03-21 20:34:02 +00:00
|
|
|
|
2003-10-08 04:14:55 +00:00
|
|
|
/* Per-application shortcut folders */
|
|
|
|
|
|
2003-10-18 04:29:40 +00:00
|
|
|
gboolean gtk_file_chooser_add_shortcut_folder (GtkFileChooser *chooser,
|
|
|
|
|
const char *folder,
|
|
|
|
|
GError **error);
|
|
|
|
|
gboolean gtk_file_chooser_remove_shortcut_folder (GtkFileChooser *chooser,
|
|
|
|
|
const char *folder,
|
|
|
|
|
GError **error);
|
|
|
|
|
GSList *gtk_file_chooser_list_shortcut_folders (GtkFileChooser *chooser);
|
|
|
|
|
|
|
|
|
|
gboolean gtk_file_chooser_add_shortcut_folder_uri (GtkFileChooser *chooser,
|
2003-11-15 23:44:33 +00:00
|
|
|
const char *uri,
|
2003-10-18 04:29:40 +00:00
|
|
|
GError **error);
|
|
|
|
|
gboolean gtk_file_chooser_remove_shortcut_folder_uri (GtkFileChooser *chooser,
|
2003-11-15 23:44:33 +00:00
|
|
|
const char *uri,
|
2003-10-18 04:29:40 +00:00
|
|
|
GError **error);
|
|
|
|
|
GSList *gtk_file_chooser_list_shortcut_folder_uris (GtkFileChooser *chooser);
|
2003-10-08 04:14:55 +00:00
|
|
|
|
2003-03-21 20:34:02 +00:00
|
|
|
G_END_DECLS
|
|
|
|
|
|
|
|
|
|
#endif /* __GTK_FILE_CHOOSER_H__ */
|
