finch/libgnt/gntfilesel.h

   1 /*
   2  * GNT - The GLib Ncurses Toolkit
   3  *
   4  * GNT is the legal property of its developers, whose names are too numerous
   5  * to list here.  Please refer to the COPYRIGHT file distributed with this
   6  * source distribution.
   7  *
   8  * This library is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  21  */
  22
  23 #ifndef GNT_FILE_SEL_H
  24 #define GNT_FILE_SEL_H
  25 /**
  26  * SECTION:gntfilesel
  27  * @section_id: libgnt-gntfilesel
  28  * @short_description: <filename>gntfilesel.h</filename>
  29  * @title: File Selector
  30  */
  31
  32 #include "gntwindow.h"
  33 #include "gnt.h"
  34 #include "gntcolors.h"
  35 #include "gntkeys.h"
  36
  37 #define GNT_TYPE_FILE_SEL                               (gnt_file_sel_get_type())
  38 #define GNT_FILE_SEL(obj)                               (G_TYPE_CHECK_INSTANCE_CAST((obj), GNT_TYPE_FILE_SEL, GntFileSel))
  39 #define GNT_FILE_SEL_CLASS(klass)               (G_TYPE_CHECK_CLASS_CAST((klass), GNT_TYPE_FILE_SEL, GntFileSelClass))
  40 #define GNT_IS_FILE_SEL(obj)                    (G_TYPE_CHECK_INSTANCE_TYPE((obj), GNT_TYPE_FILE_SEL))
  41 #define GNT_IS_FILE_SEL_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE((klass), GNT_TYPE_FILE_SEL))
  42 #define GNT_FILE_SEL_GET_CLASS(obj)     (G_TYPE_INSTANCE_GET_CLASS((obj), GNT_TYPE_FILE_SEL, GntFileSelClass))
  43
  44 #define GNT_FILE_SEL_FLAGS(obj)                         (GNT_FILE_SEL(obj)->priv.flags)
  45 #define GNT_FILE_SEL_SET_FLAGS(obj, flags)              (GNT_FILE_SEL_FLAGS(obj) |= flags)
  46 #define GNT_FILE_SEL_UNSET_FLAGS(obj, flags)    (GNT_FILE_SEL_FLAGS(obj) &= ~(flags))
  47
  48 #define GNT_TYPE_FILE                                   (gnt_file_get_type())
  49
  50 typedef struct _GntFileSel                      GntFileSel;
  51 typedef struct _GntFileSelPriv          GntFileSelPriv;
  52 typedef struct _GntFileSelClass         GntFileSelClass;
  53 typedef struct _GntFile             GntFile;
  54
  55 struct _GntFileSel
  56 {
  57         GntWindow parent;
  58
  59         GntWidget *dirs;     /* list of files */
  60         GntWidget *files;    /* list of directories */
  61         GntWidget *location; /* location entry */
  62
  63         GntWidget *select;   /* select button */
  64         GntWidget *cancel;   /* cancel button */
  65
  66         char *current; /* Full path of the current location */
  67         char *suggest; /* Suggested filename */
  68         /* XXX: someone should make these useful */
  69         gboolean must_exist; /* Make sure the selected file (the name entered in 'location') exists */
  70         gboolean dirsonly;   /* Show only directories */
  71     gboolean multiselect;
  72     GList *tags;         /* List of tagged files when multiselect is set */
  73
  74         gboolean (*read_fn)(const char *path, GList **files, GError **error);
  75 };
  76
  77 struct _GntFileSelClass
  78 {
  79         GntWindowClass parent;
  80
  81         void (*file_selected)(GntFileSel *sel, const char *path, const char *filename);
  82
  83         /*< private >*/
  84         void (*gnt_reserved1)(void);
  85         void (*gnt_reserved2)(void);
  86         void (*gnt_reserved3)(void);
  87         void (*gnt_reserved4)(void);
  88 };
  89
  90 typedef enum
  91 {
  92         GNT_FILE_REGULAR,
  93         GNT_FILE_DIR
  94 } GntFileType;
  95
  96 struct _GntFile
  97 {
  98         char *fullpath;
  99         char *basename;
 100         GntFileType type;
 101         unsigned long size;
 102 };
 103
 104 G_BEGIN_DECLS
 105
 106 /**
 107  * gnt_file_sel_get_type:
 108  *
 109  * Returns: GType for GntFileSel.
 110  */
 111 GType gnt_file_sel_get_type(void);
 112
 113 /**
 114  * gnt_file_get_type:
 115  *
 116  * Returns: The #GType for the #GntFile boxed structure.
 117  */
 118 GType gnt_file_get_type(void);
 119
 120 /**
 121  * gnt_file_sel_new:
 122  *
 123  * Create a new file selector.
 124  *
 125  * Returns:  The newly created file selector.
 126  */
 127 GntWidget * gnt_file_sel_new(void);
 128
 129 /**
 130  * gnt_file_sel_set_current_location:
 131  * @sel:   The file selector.
 132  * @path:  The current path of the selector.
 133  *
 134  * Set the current location of the file selector.
 135  *
 136  * Returns: %TRUE if the current location was successfully changed, %FALSE otherwise.
 137  */
 138 gboolean gnt_file_sel_set_current_location(GntFileSel *sel, const char *path);
 139
 140 /**
 141  * gnt_file_sel_set_dirs_only:
 142  * @sel:    The file selector.
 143  * @dirs:   %TRUE if only directories can be selected, %FALSE if files
 144  *               can also be selected.
 145  *
 146  * Set wheter to only allow selecting directories.
 147  */
 148 void gnt_file_sel_set_dirs_only(GntFileSel *sel, gboolean dirs);
 149
 150 /**
 151  * gnt_file_sel_get_dirs_only:
 152  * @sel:  The file selector.
 153  *
 154  * Check whether the file selector allows only selecting directories.
 155  *
 156  * Returns:  %TRUE if only directories can be selected.
 157  */
 158 gboolean gnt_file_sel_get_dirs_only(GntFileSel *sel);
 159
 160 /**
 161  * gnt_file_sel_set_must_exist:
 162  * @sel:   The file selector.
 163  * @must:  %TRUE if the selected file must exist.
 164  *
 165  * Set whether a selected file must exist.
 166  */
 167 void gnt_file_sel_set_must_exist(GntFileSel *sel, gboolean must);
 168
 169 /**
 170  * gnt_file_sel_get_must_exist:
 171  * @sel:  The file selector.
 172  *
 173  * Check whether the selector allows selecting non-existent files.
 174  *
 175  * Returns:  %TRUE if the selected file must exist, %FALSE if a non-existent
 176  *          file can be selected.
 177  */
 178 gboolean gnt_file_sel_get_must_exist(GntFileSel *sel);
 179
 180 /**
 181  * gnt_file_sel_get_selected_file:
 182  * @sel:  The file selector.
 183  *
 184  * Get the selected file in the selector.
 185  *
 186  * Returns: The path of the selected file. The caller should g_free the returned
 187  *         string.
 188  */
 189 char * gnt_file_sel_get_selected_file(GntFileSel *sel);
 190
 191 /**
 192  * gnt_file_sel_get_selected_multi_files:
 193  * @sel:  The file selector.
 194  *
 195  * Get the list of selected files in the selector.
 196  *
 197  * Returns: (transfer full) (element-type filename): A list of paths for the
 198  *          selected files. The caller must g_free() the contents of the list,
 199  *          and g_list_free() the list.
 200  */
 201 GList * gnt_file_sel_get_selected_multi_files(GntFileSel *sel);
 202
 203 /**
 204  * gnt_file_sel_set_multi_select:
 205  * @sel:  The file selector.
 206  * @set:  %TRUE if selecting multiple files should be allowed.
 207  *
 208  * Allow selecting multiple files.
 209  */
 210 void gnt_file_sel_set_multi_select(GntFileSel *sel, gboolean set);
 211
 212 /**
 213  * gnt_file_sel_set_suggested_filename:
 214  * @sel:      The file selector.
 215  * @suggest:  The suggested filename.
 216  *
 217  * Set the suggested file to have selected at startup.
 218  */
 219 void gnt_file_sel_set_suggested_filename(GntFileSel *sel, const char *suggest);
 220
 221 /**
 222  * gnt_file_sel_set_read_fn:
 223  * @sel:      The file selector.
 224  * @read_fn:  The custom read function.
 225  *
 226  * Set custom functions to read the names of files.
 227  */
 228 void gnt_file_sel_set_read_fn(GntFileSel *sel, gboolean (*read_fn)(const char *path, GList **files, GError **error));
 229
 230 /**
 231  * gnt_file_new:
 232  * @name:   The name of the file.
 233  * @size:   The size of the file.
 234  *
 235  * Create a new GntFile.
 236  *
 237  * Returns:  The newly created GntFile.
 238  */
 239 GntFile* gnt_file_new(const char *name, unsigned long size);
 240
 241 /**
 242  * gnt_file_new_dir:
 243  * @name:  The name of the directory.
 244  *
 245  * Create a new GntFile for a directory.
 246  *
 247  * Returns:  The newly created GntFile.
 248  */
 249 GntFile* gnt_file_new_dir(const char *name);
 250
 251 G_END_DECLS
 252
 253 #endif /* GNT_FILE_SEL_H */
 254