1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
|
/* vi:set et ai sw=2 sts=2 ts=2: */
/*-
* Copyright (c) 2005-2007 Benedikt Meurer <benny@xfce.org>
* Copyright (c) 2009 Jannis Pohlmann <jannis@xfce.org>
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the Free
* Software Foundation; either version 2 of the License, or (at your option)
* any later version.
*
* This program 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 General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along with
* this program; if not, write to the Free Software Foundation, Inc., 59 Temple
* Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef __THUNAR_FILE_H__
#define __THUNAR_FILE_H__
#include <glib.h>
#include <thunarx/thunarx.h>
#include <thunar/thunar-enum-types.h>
#include <thunar/thunar-gio-extensions.h>
#include <thunar/thunar-user.h>
G_BEGIN_DECLS;
typedef struct _ThunarFileClass ThunarFileClass;
typedef struct _ThunarFile ThunarFile;
#define THUNAR_TYPE_FILE (thunar_file_get_type ())
#define THUNAR_FILE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), THUNAR_TYPE_FILE, ThunarFile))
#define THUNAR_FILE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), THUNAR_TYPE_FILE, ThunarFileClass))
#define THUNAR_IS_FILE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), THUNAR_TYPE_FILE))
#define THUNAR_IS_FILE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), THUNAR_TYPE_FILE))
#define THUNAR_FILE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), THUNAR_TYPE_FILE, ThunarFileClass))
/**
* ThunarFileDateType:
* @THUNAR_FILE_DATE_ACCESSED : date of last access to the file.
* @THUNAR_FILE_DATE_CHANGED : date of last change to the file meta data or the content.
* @THUNAR_FILE_DATE_MODIFIED : date of last modification of the file's content.
*
* The various dates that can be queried about a #ThunarFile. Note, that not all
* #ThunarFile implementations support all types listed above. See the documentation
* of the thunar_file_get_date() method for details.
**/
typedef enum
{
THUNAR_FILE_DATE_ACCESSED,
THUNAR_FILE_DATE_CHANGED,
THUNAR_FILE_DATE_MODIFIED,
} ThunarFileDateType;
/**
* ThunarFileIconState:
* @THUNAR_FILE_ICON_STATE_DEFAULT : the default icon for the file.
* @THUNAR_FILE_ICON_STATE_DROP : the drop accept icon for the file.
* @THUNAR_FILE_ICON_STATE_OPEN : the folder is expanded.
*
* The various file icon states that are used within the file manager
* views.
**/
typedef enum /*< enum >*/
{
THUNAR_FILE_ICON_STATE_DEFAULT,
THUNAR_FILE_ICON_STATE_DROP,
THUNAR_FILE_ICON_STATE_OPEN,
} ThunarFileIconState;
/**
* ThunarFileThumbState:
* @THUNAR_FILE_THUMB_STATE_UNKNOWN : unknown whether there's a thumbnail.
* @THUNAR_FILE_THUMB_STATE_NONE : no thumbnail is available.
* @THUNAR_FILE_THUMB_STATE_READY : a thumbnail is available.
* @THUNAR_FILE_THUMB_STATE_LOADING : a thumbnail is being generated.
*
* The state of the thumbnailing for a given #ThunarFile.
**/
typedef enum /*< flags >*/
{
THUNAR_FILE_THUMB_STATE_UNKNOWN = 0,
THUNAR_FILE_THUMB_STATE_NONE = 1,
THUNAR_FILE_THUMB_STATE_READY = 2,
THUNAR_FILE_THUMB_STATE_LOADING = 3,
} ThunarFileThumbState;
#define THUNAR_FILE_EMBLEM_NAME_SYMBOLIC_LINK "emblem-symbolic-link"
#define THUNAR_FILE_EMBLEM_NAME_CANT_READ "emblem-noread"
#define THUNAR_FILE_EMBLEM_NAME_CANT_WRITE "emblem-nowrite"
#define THUNAR_FILE_EMBLEM_NAME_DESKTOP "emblem-desktop"
/**
* ThunarFileGetFunc:
*
* Callback type for loading #ThunarFile<!---->s asynchronously. If you
* want to keep the #ThunarFile, you need to ref it, else it will be
* destroyed.
**/
typedef void (*ThunarFileGetFunc) (GFile *location,
ThunarFile *file,
GError *error,
gpointer user_data);
GType thunar_file_get_type (void) G_GNUC_CONST;
ThunarFile *thunar_file_get (GFile *file,
GError **error);
ThunarFile *thunar_file_get_with_info (GFile *file,
GFileInfo *info,
gboolean not_mounted);
ThunarFile *thunar_file_get_for_uri (const gchar *uri,
GError **error);
void thunar_file_get_async (GFile *location,
GCancellable *cancellable,
ThunarFileGetFunc func,
gpointer user_data);
GFile *thunar_file_get_file (const ThunarFile *file) G_GNUC_PURE;
GFileInfo *thunar_file_get_info (const ThunarFile *file) G_GNUC_PURE;
ThunarFile *thunar_file_get_parent (const ThunarFile *file,
GError **error);
gboolean thunar_file_check_loaded (ThunarFile *file);
gboolean thunar_file_execute (ThunarFile *file,
GFile *working_directory,
gpointer parent,
GList *path_list,
const gchar *startup_id,
GError **error);
gboolean thunar_file_launch (ThunarFile *file,
gpointer parent,
const gchar *startup_id,
GError **error);
gboolean thunar_file_rename (ThunarFile *file,
const gchar *name,
GCancellable *cancellable,
gboolean called_from_job,
GError **error);
GdkDragAction thunar_file_accepts_drop (ThunarFile *file,
GList *path_list,
GdkDragContext *context,
GdkDragAction *suggested_action_return);
guint64 thunar_file_get_date (const ThunarFile *file,
ThunarFileDateType date_type) G_GNUC_PURE;
gchar *thunar_file_get_date_string (const ThunarFile *file,
ThunarFileDateType date_type,
ThunarDateStyle date_style,
const gchar *date_custom_style) G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
gchar *thunar_file_get_mode_string (const ThunarFile *file) G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
gchar *thunar_file_get_size_string (const ThunarFile *file) G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
gchar *thunar_file_get_size_in_bytes_string (const ThunarFile *file) G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
gchar *thunar_file_get_size_string_formatted (const ThunarFile *file,
const gboolean file_size_binary);
gchar *thunar_file_get_size_string_long (const ThunarFile *file,
const gboolean file_size_binary);
GVolume *thunar_file_get_volume (const ThunarFile *file);
ThunarGroup *thunar_file_get_group (const ThunarFile *file);
ThunarUser *thunar_file_get_user (const ThunarFile *file);
const gchar *thunar_file_get_content_type (ThunarFile *file);
gboolean thunar_file_load_content_type (ThunarFile *file);
const gchar *thunar_file_get_symlink_target (const ThunarFile *file);
const gchar *thunar_file_get_basename (const ThunarFile *file) G_GNUC_CONST;
gboolean thunar_file_is_symlink (const ThunarFile *file);
guint64 thunar_file_get_size (const ThunarFile *file);
GAppInfo *thunar_file_get_default_handler (const ThunarFile *file);
GFileType thunar_file_get_kind (const ThunarFile *file) G_GNUC_PURE;
GFile *thunar_file_get_target_location (const ThunarFile *file);
ThunarFileMode thunar_file_get_mode (const ThunarFile *file);
gboolean thunar_file_is_mounted (const ThunarFile *file);
gboolean thunar_file_exists (const ThunarFile *file);
gboolean thunar_file_is_directory (const ThunarFile *file) G_GNUC_PURE;
gboolean thunar_file_is_shortcut (const ThunarFile *file) G_GNUC_PURE;
gboolean thunar_file_is_mountable (const ThunarFile *file) G_GNUC_PURE;
gboolean thunar_file_is_local (const ThunarFile *file);
gboolean thunar_file_is_parent (const ThunarFile *file,
const ThunarFile *child);
gboolean thunar_file_is_gfile_ancestor (const ThunarFile *file,
GFile *ancestor);
gboolean thunar_file_is_ancestor (const ThunarFile *file,
const ThunarFile *ancestor);
gboolean thunar_file_is_executable (const ThunarFile *file);
gboolean thunar_file_is_writable (const ThunarFile *file);
gboolean thunar_file_is_hidden (const ThunarFile *file);
gboolean thunar_file_is_home (const ThunarFile *file);
gboolean thunar_file_is_regular (const ThunarFile *file) G_GNUC_PURE;
gboolean thunar_file_is_trashed (const ThunarFile *file);
gboolean thunar_file_is_desktop_file (const ThunarFile *file,
gboolean *is_secure);
const gchar *thunar_file_get_display_name (const ThunarFile *file) G_GNUC_CONST;
gchar *thunar_file_get_deletion_date (const ThunarFile *file,
ThunarDateStyle date_style,
const gchar *date_custom_style) G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
const gchar *thunar_file_get_original_path (const ThunarFile *file);
guint32 thunar_file_get_item_count (const ThunarFile *file);
gboolean thunar_file_is_chmodable (const ThunarFile *file);
gboolean thunar_file_is_renameable (const ThunarFile *file);
gboolean thunar_file_can_be_trashed (const ThunarFile *file);
GList *thunar_file_get_emblem_names (ThunarFile *file);
void thunar_file_set_emblem_names (ThunarFile *file,
GList *emblem_names);
const gchar *thunar_file_get_custom_icon (const ThunarFile *file);
gboolean thunar_file_set_custom_icon (ThunarFile *file,
const gchar *custom_icon,
GError **error);
const gchar *thunar_file_get_thumbnail_path (ThunarFile *file,
ThunarThumbnailSize thumbnail_size);
ThunarFileThumbState thunar_file_get_thumb_state (const ThunarFile *file);
void thunar_file_set_thumb_state (ThunarFile *file,
ThunarFileThumbState state);
GIcon *thunar_file_get_preview_icon (const ThunarFile *file);
GFilesystemPreviewType thunar_file_get_preview_type (const ThunarFile *file);
const gchar *thunar_file_get_icon_name (ThunarFile *file,
ThunarFileIconState icon_state,
GtkIconTheme *icon_theme);
void thunar_file_watch (ThunarFile *file);
void thunar_file_unwatch (ThunarFile *file);
gboolean thunar_file_reload (ThunarFile *file);
void thunar_file_reload_idle (ThunarFile *file);
void thunar_file_reload_idle_unref (ThunarFile *file);
void thunar_file_reload_parent (ThunarFile *file);
void thunar_file_destroy (ThunarFile *file);
gint thunar_file_compare_by_type (ThunarFile *file_a,
ThunarFile *file_b);
gint thunar_file_compare_by_name (const ThunarFile *file_a,
const ThunarFile *file_b,
gboolean case_sensitive) G_GNUC_PURE;
ThunarFile *thunar_file_cache_lookup (const GFile *file);
gchar *thunar_file_cached_display_name (const GFile *file);
GList *thunar_file_list_get_applications (GList *file_list);
GList *thunar_file_list_to_thunar_g_file_list (GList *file_list);
gboolean thunar_file_is_desktop (const ThunarFile *file);
const gchar* thunar_file_get_metadata_setting (ThunarFile *file,
const gchar *setting_name);
void thunar_file_set_metadata_setting (ThunarFile *file,
const gchar *setting_name,
const gchar *setting_value);
void thunar_file_clear_directory_specific_settings (ThunarFile *file);
gboolean thunar_file_has_directory_specific_settings (ThunarFile *file);
/**
* thunar_file_is_root:
* @file : a #ThunarFile.
*
* Checks whether @file refers to the root directory.
*
* Return value: %TRUE if @file is the root directory.
**/
#define thunar_file_is_root(file) (thunar_g_file_is_root (thunar_file_get_file (file)))
/**
* thunar_file_has_parent:
* @file : a #ThunarFile instance.
*
* Checks whether it is possible to determine the parent #ThunarFile
* for @file.
*
* Return value: whether @file has a parent.
**/
#define thunar_file_has_parent(file) (!thunar_file_is_root (THUNAR_FILE ((file))))
/**
* thunar_file_dup_uri:
* @file : a #ThunarFile instance.
*
* Returns the URI for the @file. The caller is responsible
* to free the returned string when no longer needed.
*
* Return value: the URI for @file.
**/
#define thunar_file_dup_uri(file) (g_file_get_uri (thunar_file_get_file (file)))
/**
* thunar_file_has_uri_scheme:
* @file : a #ThunarFile instance.
* @uri_scheme : a URI scheme string.
*
* Checks whether the URI scheme of the file matches @uri_scheme.
*
* Return value: TRUE, if the schemes match, FALSE otherwise.
**/
#define thunar_file_has_uri_scheme(file, uri_scheme) (g_file_has_uri_scheme (thunar_file_get_file (file), (uri_scheme)))
/**
* thunar_file_changed:
* @file : a #ThunarFile instance.
*
* Emits the ::changed signal on @file. This function is meant to be called
* by derived classes whenever they notice changes to the @file.
**/
#define thunar_file_changed(file) \
G_STMT_START{ \
thunarx_file_info_changed (THUNARX_FILE_INFO ((file))); \
}G_STMT_END
G_END_DECLS;
#endif /* !__THUNAR_FILE_H__ */
|
