Pileus Git - ~andy/gtk/blob - gtk/gtkfilechooser.h

   1 /* GTK - The GIMP Toolkit
   2  * gtkfilechooser.h: Abstract interface for file selector GUIs
   3  * Copyright (C) 2003, Red Hat, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 #ifndef __GTK_FILE_CHOOSER_H__
  22 #define __GTK_FILE_CHOOSER_H__
  23
  24 #include "gtkfilefilter.h"
  25 #include <gtk/gtkwidget.h>
  26
  27 G_BEGIN_DECLS
  28
  29 #define GTK_TYPE_FILE_CHOOSER             (gtk_file_chooser_get_type ())
  30 #define GTK_FILE_CHOOSER(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_FILE_CHOOSER, GtkFileChooser))
  31 #define GTK_IS_FILE_CHOOSER(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_FILE_CHOOSER))
  32
  33 typedef struct _GtkFileChooser      GtkFileChooser;
  34
  35 typedef enum
  36 {
  37   GTK_FILE_CHOOSER_ACTION_OPEN,
  38   GTK_FILE_CHOOSER_ACTION_SAVE
  39 } GtkFileChooserAction;
  40
  41 GType gtk_file_chooser_get_type (void);
  42
  43 /* GError enumeration for GtkFileChooser */
  44
  45 #define GTK_FILE_CHOOSER_ERROR (gtk_file_chooser_error_quark ())
  46
  47 typedef enum {
  48   GTK_FILE_CHOOSER_ERROR_NONEXISTENT,
  49   GTK_FILE_CHOOSER_ERROR_BAD_FILENAME
  50 } GtkFileChooserError;
  51
  52 GQuark gtk_file_chooser_error_quark (void);
  53
  54 /* Configuration
  55  */
  56 void                 gtk_file_chooser_set_action          (GtkFileChooser       *chooser,
  57                                                            GtkFileChooserAction  action);
  58 GtkFileChooserAction gtk_file_chooser_get_action          (GtkFileChooser       *chooser);
  59 void                 gtk_file_chooser_set_folder_mode     (GtkFileChooser       *chooser,
  60                                                            gboolean              folder_mode);
  61 gboolean             gtk_file_chooser_get_folder_mode     (GtkFileChooser       *chooser);
  62 void                 gtk_file_chooser_set_local_only      (GtkFileChooser       *chooser,
  63                                                            gboolean              files_only);
  64 gboolean             gtk_file_chooser_get_local_only      (GtkFileChooser       *chooser);
  65 void                 gtk_file_chooser_set_select_multiple (GtkFileChooser       *chooser,
  66                                                            gboolean              select_multiple);
  67 gboolean             gtk_file_chooser_get_select_multiple (GtkFileChooser       *chooser);
  68
  69 /* Filename manipulation
  70  */
  71 void    gtk_file_chooser_set_current_name  (GtkFileChooser *chooser,
  72                                             const gchar    *name);
  73 gchar * gtk_file_chooser_get_filename      (GtkFileChooser *chooser);
  74 void    gtk_file_chooser_set_filename      (GtkFileChooser *chooser,
  75                                             const char     *filename);
  76 void    gtk_file_chooser_select_filename   (GtkFileChooser *chooser,
  77                                             const char     *filename);
  78 void    gtk_file_chooser_unselect_filename (GtkFileChooser *chooser,
  79                                             const char     *filename);
  80 void    gtk_file_chooser_select_all        (GtkFileChooser *chooser);
  81 void    gtk_file_chooser_unselect_all      (GtkFileChooser *chooser);
  82 GSList *gtk_file_chooser_get_filenames     (GtkFileChooser *chooser);
  83 void   gtk_file_chooser_set_current_folder (GtkFileChooser *chooser,
  84                                             const gchar    *filename);
  85 gchar *gtk_file_chooser_get_current_folder (GtkFileChooser *chooser);
  86
  87
  88 /* URI manipulation
  89  */
  90 gchar * gtk_file_chooser_get_uri      (GtkFileChooser *chooser);
  91 void    gtk_file_chooser_set_uri      (GtkFileChooser *chooser,
  92                                        const char     *uri);
  93 void    gtk_file_chooser_select_uri   (GtkFileChooser *chooser,
  94                                        const char     *uri);
  95 void    gtk_file_chooser_unselect_uri (GtkFileChooser *chooser,
  96                                        const char     *uri);
  97 GSList *gtk_file_chooser_get_uris     (GtkFileChooser *chooser);
  98
  99 void   gtk_file_chooser_set_current_folder_uri (GtkFileChooser *chooser,
 100                                                 const gchar    *uri);
 101 gchar *gtk_file_chooser_get_current_folder_uri (GtkFileChooser *chooser);
 102
 103 /* Preview widget
 104  */
 105 void       gtk_file_chooser_set_preview_widget        (GtkFileChooser *chooser,
 106                                                        GtkWidget      *preview_widget);
 107 GtkWidget *gtk_file_chooser_get_preview_widget        (GtkFileChooser *chooser);
 108 void       gtk_file_chooser_set_preview_widget_active (GtkFileChooser *chooser,
 109                                                        gboolean        active);
 110 gboolean   gtk_file_chooser_get_preview_widget_active (GtkFileChooser *chooser);
 111
 112 char *gtk_file_chooser_get_preview_filename (GtkFileChooser *file_chooser);
 113 char *gtk_file_chooser_get_preview_uri      (GtkFileChooser *file_chooser);
 114
 115 /* Extra widget
 116  */
 117 void       gtk_file_chooser_set_extra_widget (GtkFileChooser *chooser,
 118                                               GtkWidget      *extra_widget);
 119 GtkWidget *gtk_file_chooser_get_extra_widget (GtkFileChooser *chooser);
 120
 121 /* List of user selectable filters
 122  */
 123 void    gtk_file_chooser_add_filter    (GtkFileChooser *chooser,
 124                                         GtkFileFilter  *filter);
 125 void    gtk_file_chooser_remove_filter (GtkFileChooser *chooser,
 126                                         GtkFileFilter  *filter);
 127 GSList *gtk_file_chooser_list_filters  (GtkFileChooser *chooser);
 128
 129 /* Current filter
 130  */
 131 void           gtk_file_chooser_set_filter (GtkFileChooser *chooser,
 132                                            GtkFileFilter  *filter);
 133 GtkFileFilter *gtk_file_chooser_get_filter (GtkFileChooser *chooser);
 134
 135 /* Per-application shortcut folders */
 136
 137 gboolean gtk_file_chooser_add_shortcut_folder    (GtkFileChooser *chooser,
 138                                                   const char     *folder,
 139                                                   GError        **error);
 140 gboolean gtk_file_chooser_remove_shortcut_folder (GtkFileChooser *chooser,
 141                                                   const char     *folder,
 142                                                   GError        **error);
 143 GSList *gtk_file_chooser_list_shortcut_folders   (GtkFileChooser *chooser);
 144
 145 gboolean gtk_file_chooser_add_shortcut_folder_uri    (GtkFileChooser *chooser,
 146                                                       const char     *folder,
 147                                                       GError        **error);
 148 gboolean gtk_file_chooser_remove_shortcut_folder_uri (GtkFileChooser *chooser,
 149                                                       const char     *folder,
 150                                                       GError        **error);
 151 GSList *gtk_file_chooser_list_shortcut_folder_uris   (GtkFileChooser *chooser);
 152
 153 G_END_DECLS
 154
 155 #endif /* __GTK_FILE_CHOOSER_H__ */