]> Pileus Git - ~andy/gtk/blobdiff - gtk/gtkfilechooser.h
Silently return NULL if the widget is not realized. (#316023, Guillaume
[~andy/gtk] / gtk / gtkfilechooser.h
index 7b5d395c4a67379d6bf5db0067153cf887bd2ffa..9148fa670be91dd0b1d9d60a65668b50dbbe2b0a 100644 (file)
@@ -21,6 +21,7 @@
 #ifndef __GTK_FILE_CHOOSER_H__
 #define __GTK_FILE_CHOOSER_H__
 
+#include "gtkfilefilter.h"
 #include <gtk/gtkwidget.h>
 
 G_BEGIN_DECLS
@@ -28,103 +29,106 @@ 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))
-#define GTK_FILE_CHOOSER_GET_IFACE(inst)  (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GTK_TYPE_FILE_CHOOSER, GtkFileChooserIface))
 
 typedef struct _GtkFileChooser      GtkFileChooser;
-typedef struct _GtkFileChooserIface GtkFileChooserIface;
 
 typedef enum
 {
   GTK_FILE_CHOOSER_ACTION_OPEN,
-  GTK_FILE_CHOOSER_ACTION_SAVE
+  GTK_FILE_CHOOSER_ACTION_SAVE,
+  GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER,
+  GTK_FILE_CHOOSER_ACTION_CREATE_FOLDER
 } GtkFileChooserAction;
 
-struct _GtkFileChooserIface
+typedef enum
 {
-  GTypeInterface base_iface;
-
-  /* GtkFileChooser interface has the following properties:
-   *
-   *  action:          GtkFileChooserAction
-   *  folder_mode:     boolean
-   *  select_multiple: boolean
-   *  show_hidden:     boolean
-   *  local_only:      boolean
-   *
-   *  preview_widget:  GtkWidget
-   *  preview_widget_active: boolean
-   */
-
-  /* Methods
-   */
-  void (*set_current_folder)   (GtkFileChooser *chooser,
-                               const char     *uri);
-  char * (*get_current_folder) (GtkFileChooser *chooser);
-  void (*select_uri)           (GtkFileChooser *chooser,
-                               const char     *uri);
-  void (*unselect_uri)         (GtkFileChooser *chooser,
-                               const char     *uri);
-  void (*select_all)           (GtkFileChooser *chooser);
-  void (*unselect_all)         (GtkFileChooser *chooser);
-  GSList *(*get_uris)          (GtkFileChooser *chooser);
-
-
-  /* Signals
-   */
-  void (*current_folder_changed) (GtkFileChooser *chooser);
-  void (*selection_changed)      (GtkFileChooser *chooser);
-  void (*update_preview)         (GtkFileChooser *chooser,
-                                 const char     *uri);
-};
-
-GType gtk_file_chooser_get_type (void);
+  GTK_FILE_CHOOSER_CONFIRMATION_CONFIRM,
+  GTK_FILE_CHOOSER_CONFIRMATION_ACCEPT_FILENAME,
+  GTK_FILE_CHOOSER_CONFIRMATION_SELECT_AGAIN
+} GtkFileChooserConfirmation;
+
+GType gtk_file_chooser_get_type (void) G_GNUC_CONST;
+
+/* GError enumeration for GtkFileChooser */
+
+#define GTK_FILE_CHOOSER_ERROR (gtk_file_chooser_error_quark ())
+
+typedef enum {
+  GTK_FILE_CHOOSER_ERROR_NONEXISTENT,
+  GTK_FILE_CHOOSER_ERROR_BAD_FILENAME
+} GtkFileChooserError;
+
+GQuark gtk_file_chooser_error_quark (void);
 
 /* Configuration
  */
 void                 gtk_file_chooser_set_action          (GtkFileChooser       *chooser,
                                                           GtkFileChooserAction  action);
 GtkFileChooserAction gtk_file_chooser_get_action          (GtkFileChooser       *chooser);
-void                 gtk_file_chooser_set_directory_mode  (GtkFileChooser       *chooser,
-                                                          gboolean              directory_mode);
-gboolean             gtk_file_chooser_get_directory_mode  (GtkFileChooser       *chooser);
 void                 gtk_file_chooser_set_local_only      (GtkFileChooser       *chooser,
-                                                          gboolean              files_only);
+                                                          gboolean              local_only);
 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);
+void                 gtk_file_chooser_set_show_hidden     (GtkFileChooser       *chooser,
+                                                          gboolean              show_hidden);
+gboolean             gtk_file_chooser_get_show_hidden     (GtkFileChooser       *chooser);
+
+void                 gtk_file_chooser_set_do_overwrite_confirmation (GtkFileChooser *chooser,
+                                                                    gboolean        do_overwrite_confirmation);
+gboolean             gtk_file_chooser_get_do_overwrite_confirmation (GtkFileChooser *chooser);
+
+/* Suggested name for the Save-type actions
+ */
+void     gtk_file_chooser_set_current_name   (GtkFileChooser *chooser,
+                                             const gchar    *name);
 
 /* Filename manipulation
  */
-gchar * gtk_file_chooser_get_filename      (GtkFileChooser *chooser);
-void    gtk_file_chooser_set_filename      (GtkFileChooser *chooser,
-                                           const char     *filename);
-void    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);
-void   gtk_file_chooser_set_current_folder (GtkFileChooser *chooser,
-                                           const gchar    *filename);
-gchar *gtk_file_chooser_get_current_folder (GtkFileChooser *chooser);
+#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
+
+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);
 
 
 /* URI manipulation
  */
-gchar * gtk_file_chooser_get_uri      (GtkFileChooser *chooser);
-void    gtk_file_chooser_set_uri      (GtkFileChooser *chooser,
-                                      const char     *uri);
-void    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);
-
-void   gtk_file_chooser_set_current_folder_uri (GtkFileChooser *chooser,
-                                               const gchar    *uri);
-gchar *gtk_file_chooser_get_current_folder_uri (GtkFileChooser *chooser);
+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);
 
 /* Preview widget
  */
@@ -134,33 +138,50 @@ 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);
+void       gtk_file_chooser_set_use_preview_label     (GtkFileChooser *chooser,
+                                                      gboolean        use_label);
+gboolean   gtk_file_chooser_get_use_preview_label     (GtkFileChooser *chooser);
 
-const char *gtk_file_chooser_get_preview_filename (GtkFileChooser *file_chooser);
-const char *gtk_file_chooser_get_preview_uri      (GtkFileChooser *file_chooser);
+char *gtk_file_chooser_get_preview_filename (GtkFileChooser *chooser);
+char *gtk_file_chooser_get_preview_uri      (GtkFileChooser *chooser);
 
-
-#if 0
-/* Filters
+/* Extra widget
  */
-void   gtk_file_chooser_add_filter    (GtkFileChooser *chooser,
-                                      GtkFileFilter  *filter);
-void   gtk_file_chooser_remove_filter (GtkFileChooser *chooser,
-                                      GtkFileFilter  *filter);
-GList *gtk_file_chooser_get_filters   (GtkFileChooser  *chooser);
-
+void       gtk_file_chooser_set_extra_widget (GtkFileChooser *chooser,
+                                             GtkWidget      *extra_widget);
+GtkWidget *gtk_file_chooser_get_extra_widget (GtkFileChooser *chooser);
 
-/************************************************/
-
-static gboolean (*GtkFileFilterFunc) (const char *uri,
-                                     const char *filename,
-                                     gpointer    data);
+/* List of user selectable filters
+ */
+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);
 
-GtkFileFilter *gtk_file_filter_new_pattern   (const char            *pattern);
-GtkFileFilter *gtk_file_filter_new_mime_type (const char            *mime_type);
-GtkFileFilter *gtk_file_filter_new_callback  (GtkFileFilterFunction *func,
-                                             gpointer               data,
-                                             GDestroyNotify         notify);
-#endif
+/* Current filter
+ */
+void           gtk_file_chooser_set_filter (GtkFileChooser *chooser,
+                                          GtkFileFilter  *filter);
+GtkFileFilter *gtk_file_chooser_get_filter (GtkFileChooser *chooser);
+
+/* Per-application shortcut folders */
+
+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,
+                                                     const char     *uri,
+                                                     GError        **error);
+gboolean gtk_file_chooser_remove_shortcut_folder_uri (GtkFileChooser *chooser,
+                                                     const char     *uri,
+                                                     GError        **error);
+GSList *gtk_file_chooser_list_shortcut_folder_uris   (GtkFileChooser *chooser);
 
 G_END_DECLS