]> Pileus Git - ~andy/gtk/blob - gtk/gtkfilesystemmodel.h
Convert search to use a GtkFileSystemModel
[~andy/gtk] / gtk / gtkfilesystemmodel.h
1 /* GTK - The GIMP Toolkit
2  * gtkfilesystemmodel.h: GtkTreeModel wrapping a GtkFileSystem
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_SYSTEM_MODEL_H__
22 #define __GTK_FILE_SYSTEM_MODEL_H__
23
24 #include <gio/gio.h>
25 #include <gtk/gtkfilefilter.h>
26 #include <gtk/gtktreemodel.h>
27
28 G_BEGIN_DECLS
29
30 #define GTK_TYPE_FILE_SYSTEM_MODEL             (_gtk_file_system_model_get_type ())
31 #define GTK_FILE_SYSTEM_MODEL(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_FILE_SYSTEM_MODEL, GtkFileSystemModel))
32 #define GTK_IS_FILE_SYSTEM_MODEL(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_FILE_SYSTEM_MODEL))
33
34 typedef struct _GtkFileSystemModel      GtkFileSystemModel;
35
36 GType _gtk_file_system_model_get_type (void) G_GNUC_CONST;
37
38 typedef gboolean (*GtkFileSystemModelGetValue)   (GtkFileSystemModel *model,
39                                                   GFile              *file,
40                                                   GFileInfo          *info,
41                                                   int                 column,
42                                                   GValue             *value,
43                                                   gpointer            user_data);
44
45 GtkFileSystemModel *_gtk_file_system_model_new              (GtkFileSystemModelGetValue get_func,
46                                                              gpointer            get_data,
47                                                              guint               n_columns,
48                                                              ...);
49 GtkFileSystemModel *_gtk_file_system_model_new_for_directory(GFile *             dir,
50                                                              const gchar *       attributes,
51                                                              GtkFileSystemModelGetValue get_func,
52                                                              gpointer            get_data,
53                                                              guint               n_columns,
54                                                              ...);
55 GCancellable *      _gtk_file_system_model_get_cancellable  (GtkFileSystemModel *model);
56 GFileInfo *         _gtk_file_system_model_get_info         (GtkFileSystemModel *model,
57                                                              GtkTreeIter        *iter);
58 gboolean            _gtk_file_system_model_get_iter_for_file(GtkFileSystemModel *model,
59                                                              GtkTreeIter        *iter,
60                                                              GFile              *file);
61 GFile *             _gtk_file_system_model_get_file         (GtkFileSystemModel *model,
62                                                              GtkTreeIter        *iter);
63 const GValue *      _gtk_file_system_model_get_value        (GtkFileSystemModel *model,
64                                                              GtkTreeIter *       iter,
65                                                              int                 column);
66
67 void                _gtk_file_system_model_add_file         (GtkFileSystemModel *model,
68                                                              GFile              *file,
69                                                              GFileInfo          *info);
70 void                _gtk_file_system_model_add_and_query_file (GtkFileSystemModel *model,
71                                                              GFile              *file,
72                                                              const char         *attributes);
73 void                _gtk_file_system_model_remove_file      (GtkFileSystemModel *model,
74                                                              GFile              *file);
75 void                _gtk_file_system_model_update_file      (GtkFileSystemModel *model,
76                                                              GFile              *file,
77                                                              GFileInfo          *info,
78                                                              gboolean            requires_resort);
79
80 void                _gtk_file_system_model_set_show_hidden  (GtkFileSystemModel *model,
81                                                              gboolean            show_hidden);
82 void                _gtk_file_system_model_set_show_folders (GtkFileSystemModel *model,
83                                                              gboolean            show_folders);
84 void                _gtk_file_system_model_set_show_files   (GtkFileSystemModel *model,
85                                                              gboolean            show_files);
86 void                _gtk_file_system_model_freeze_updates   (GtkFileSystemModel *model);
87 void                _gtk_file_system_model_thaw_updates     (GtkFileSystemModel *model);
88 void                _gtk_file_system_model_clear_cache      (GtkFileSystemModel *model,
89                                                              int                 column);
90
91 void                _gtk_file_system_model_set_filter       (GtkFileSystemModel *model,
92                                                              GtkFileFilter      *filter);
93
94 void _gtk_file_system_model_add_editable    (GtkFileSystemModel *model,
95                                              GtkTreeIter        *iter);
96 void _gtk_file_system_model_remove_editable (GtkFileSystemModel *model);
97
98 G_END_DECLS
99
100 #endif /* __GTK_FILE_SYSTEM_MODEL_H__ */