regex: unicode: Update to Unicode 6.1.0
[glib.git] / gio / gfileinfo.h
blob375a078ec5b0ea89fa26c253f45ed29c804967cb
1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
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.
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.
15 * You should have received a copy of the GNU Lesser General
16 * Public 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.
20 * Author: Alexander Larsson <alexl@redhat.com>
23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
24 #error "Only <gio/gio.h> can be included directly."
25 #endif
27 #ifndef __G_FILE_INFO_H__
28 #define __G_FILE_INFO_H__
30 #include <gio/giotypes.h>
32 G_BEGIN_DECLS
34 #define G_TYPE_FILE_INFO (g_file_info_get_type ())
35 #define G_FILE_INFO(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_INFO, GFileInfo))
36 #define G_FILE_INFO_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_INFO, GFileInfoClass))
37 #define G_IS_FILE_INFO(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_INFO))
38 #define G_IS_FILE_INFO_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_INFO))
39 #define G_FILE_INFO_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_INFO, GFileInfoClass))
41 /**
42 * GFileInfo:
44 * Stores information about a file system object referenced by a #GFile.
45 **/
46 typedef struct _GFileInfoClass GFileInfoClass;
49 /* Common Attributes: */
50 /**
51 * G_FILE_ATTRIBUTE_STANDARD_TYPE:
53 * A key in the "standard" namespace for storing file types.
54 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
55 * The value for this key should contain a #GFileType.
56 **/
57 #define G_FILE_ATTRIBUTE_STANDARD_TYPE "standard::type" /* uint32 (GFileType) */
59 /**
60 * G_FILE_ATTRIBUTE_STANDARD_IS_HIDDEN:
62 * A key in the "standard" namespace for checking if a file is hidden.
63 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
64 **/
65 #define G_FILE_ATTRIBUTE_STANDARD_IS_HIDDEN "standard::is-hidden" /* boolean */
67 /**
68 * G_FILE_ATTRIBUTE_STANDARD_IS_BACKUP:
70 * A key in the "standard" namespace for checking if a file is a backup file.
71 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
72 **/
73 #define G_FILE_ATTRIBUTE_STANDARD_IS_BACKUP "standard::is-backup" /* boolean */
75 /**
76 * G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINK:
78 * A key in the "standard" namespace for checking if the file is a symlink.
79 * Typically the actual type is something else, if we followed the symlink
80 * to get the type.
81 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
82 **/
83 #define G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINK "standard::is-symlink" /* boolean */
85 /**
86 * G_FILE_ATTRIBUTE_STANDARD_IS_VIRTUAL:
88 * A key in the "standard" namespace for checking if a file is virtual.
89 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
90 **/
91 #define G_FILE_ATTRIBUTE_STANDARD_IS_VIRTUAL "standard::is-virtual" /* boolean */
93 /**
94 * G_FILE_ATTRIBUTE_STANDARD_NAME:
96 * A key in the "standard" namespace for getting the name of the file.
97 * The name is the on-disk filename which may not be in any known encoding,
98 * and can thus not be generally displayed as is.
99 * Use #G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME if you need to display the
100 * name in a user interface.
101 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING.
103 #define G_FILE_ATTRIBUTE_STANDARD_NAME "standard::name" /* byte string */
106 * G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME:
108 * A key in the "standard" namespace for getting the display name of the file.
109 * A display name is guaranteed to be in UTF8 and can thus be displayed in
110 * the UI.
111 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
113 #define G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME "standard::display-name" /* string */
116 * G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME:
118 * A key in the "standard" namespace for edit name of the file.
119 * An edit name is similar to the display name, but it is meant to be
120 * used when you want to rename the file in the UI. The display name
121 * might contain information you don't want in the new filename (such as
122 * "(invalid unicode)" if the filename was in an invalid encoding).
124 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
126 #define G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME "standard::edit-name" /* string */
129 * G_FILE_ATTRIBUTE_STANDARD_COPY_NAME:
131 * A key in the "standard" namespace for getting the copy name of the file.
132 * The copy name is an optional version of the name. If available it's always
133 * in UTF8, and corresponds directly to the original filename (only transcoded to
134 * UTF8). This is useful if you want to copy the file to another filesystem that
135 * might have a different encoding. If the filename is not a valid string in the
136 * encoding selected for the filesystem it is in then the copy name will not be set.
138 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
140 #define G_FILE_ATTRIBUTE_STANDARD_COPY_NAME "standard::copy-name" /* string */
143 * G_FILE_ATTRIBUTE_STANDARD_DESCRIPTION:
145 * A key in the "standard" namespace for getting the description of the file.
146 * The description is a utf8 string that describes the file, generally containing
147 * the filename, but can also contain furter information. Example descriptions
148 * could be "filename (on hostname)" for a remote file or "filename (in trash)"
149 * for a file in the trash. This is useful for instance as the window title
150 * when displaying a directory or for a bookmarks menu.
152 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
154 #define G_FILE_ATTRIBUTE_STANDARD_DESCRIPTION "standard::description" /* string */
157 * G_FILE_ATTRIBUTE_STANDARD_ICON:
159 * A key in the "standard" namespace for getting the icon for the file.
160 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_OBJECT.
161 * The value for this key should contain a #GIcon.
163 #define G_FILE_ATTRIBUTE_STANDARD_ICON "standard::icon" /* object (GIcon) */
166 * G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE:
168 * A key in the "standard" namespace for getting the content type of the file.
169 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
170 * The value for this key should contain a valid content type.
172 #define G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE "standard::content-type" /* string */
175 * G_FILE_ATTRIBUTE_STANDARD_FAST_CONTENT_TYPE:
177 * A key in the "standard" namespace for getting the fast content type.
178 * The fast content type isn't as reliable as the regular one, as it
179 * only uses the filename to guess it, but it is faster to calculate than the
180 * regular content type.
181 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
184 #define G_FILE_ATTRIBUTE_STANDARD_FAST_CONTENT_TYPE "standard::fast-content-type" /* string */
187 * G_FILE_ATTRIBUTE_STANDARD_SIZE:
189 * A key in the "standard" namespace for getting the file's size (in bytes).
190 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64.
192 #define G_FILE_ATTRIBUTE_STANDARD_SIZE "standard::size" /* uint64 */
195 * G_FILE_ATTRIBUTE_STANDARD_ALLOCATED_SIZE:
197 * A key in the "standard" namespace for getting the amount of disk space
198 * that is consumed by the file (in bytes). This will generally be larger
199 * than the file size (due to block size overhead) but can occasionally be
200 * smaller (for example, for sparse files).
201 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64.
203 * Since: 2.20
205 #define G_FILE_ATTRIBUTE_STANDARD_ALLOCATED_SIZE "standard::allocated-size" /* uint64 */
208 * G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET:
210 * A key in the "standard" namespace for getting the symlink target, if the file
211 * is a symlink. Corresponding #GFileAttributeType is
212 * %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING.
214 #define G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET "standard::symlink-target" /* byte string */
217 * G_FILE_ATTRIBUTE_STANDARD_TARGET_URI:
219 * A key in the "standard" namespace for getting the target URI for the file, in
220 * the case of %G_FILE_TYPE_SHORTCUT or %G_FILE_TYPE_MOUNTABLE files.
221 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
223 #define G_FILE_ATTRIBUTE_STANDARD_TARGET_URI "standard::target-uri" /* string */
226 * G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER:
228 * A key in the "standard" namespace for setting the sort order of a file.
229 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_INT32.
230 * An example use would be in file managers, which would use this key
231 * to set the order files are displayed. Files with smaller sort order
232 * should be sorted first, and files without sort order as if sort order
233 * was zero.
235 #define G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER "standard::sort-order" /* int32 */
237 /* Entity tags, used to avoid missing updates on save */
240 * G_FILE_ATTRIBUTE_ETAG_VALUE:
242 * A key in the "etag" namespace for getting the value of the file's
243 * entity tag. Corresponding #GFileAttributeType is
244 * %G_FILE_ATTRIBUTE_TYPE_STRING.
246 #define G_FILE_ATTRIBUTE_ETAG_VALUE "etag::value" /* string */
248 /* File identifier, for e.g. avoiding loops when doing recursive
249 * directory scanning
253 * G_FILE_ATTRIBUTE_ID_FILE:
255 * A key in the "id" namespace for getting a file identifier.
256 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
257 * An example use would be during listing files, to avoid recursive
258 * directory scanning.
260 #define G_FILE_ATTRIBUTE_ID_FILE "id::file" /* string */
263 * G_FILE_ATTRIBUTE_ID_FILESYSTEM:
265 * A key in the "id" namespace for getting the file system identifier.
266 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
267 * An example use would be during drag and drop to see if the source
268 * and target are on the same filesystem (default to move) or not (default
269 * to copy).
271 #define G_FILE_ATTRIBUTE_ID_FILESYSTEM "id::filesystem" /* string */
273 /* Calculated Access Rights for current user */
276 * G_FILE_ATTRIBUTE_ACCESS_CAN_READ:
278 * A key in the "access" namespace for getting read privileges.
279 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
280 * This attribute will be %TRUE if the user is able to read the file.
282 #define G_FILE_ATTRIBUTE_ACCESS_CAN_READ "access::can-read" /* boolean */
285 * G_FILE_ATTRIBUTE_ACCESS_CAN_WRITE:
287 * A key in the "access" namespace for getting write privileges.
288 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
289 * This attribute will be %TRUE if the user is able to write to the file.
291 #define G_FILE_ATTRIBUTE_ACCESS_CAN_WRITE "access::can-write" /* boolean */
294 * G_FILE_ATTRIBUTE_ACCESS_CAN_EXECUTE:
296 * A key in the "access" namespace for getting execution privileges.
297 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
298 * This attribute will be %TRUE if the user is able to execute the file.
300 #define G_FILE_ATTRIBUTE_ACCESS_CAN_EXECUTE "access::can-execute" /* boolean */
303 * G_FILE_ATTRIBUTE_ACCESS_CAN_DELETE:
305 * A key in the "access" namespace for checking deletion privileges.
306 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
307 * This attribute will be %TRUE if the user is able to delete the file.
309 #define G_FILE_ATTRIBUTE_ACCESS_CAN_DELETE "access::can-delete" /* boolean */
312 * G_FILE_ATTRIBUTE_ACCESS_CAN_TRASH:
314 * A key in the "access" namespace for checking trashing privileges.
315 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
316 * This attribute will be %TRUE if the user is able to move the file to
317 * the trash.
319 #define G_FILE_ATTRIBUTE_ACCESS_CAN_TRASH "access::can-trash" /* boolean */
322 * G_FILE_ATTRIBUTE_ACCESS_CAN_RENAME:
324 * A key in the "access" namespace for checking renaming privileges.
325 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
326 * This attribute will be %TRUE if the user is able to rename the file.
328 #define G_FILE_ATTRIBUTE_ACCESS_CAN_RENAME "access::can-rename" /* boolean */
330 /* TODO: Should we have special version for directories? can_enumerate, etc */
332 /* Mountable attributes */
335 * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_MOUNT:
337 * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) is mountable.
338 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
340 #define G_FILE_ATTRIBUTE_MOUNTABLE_CAN_MOUNT "mountable::can-mount" /* boolean */
343 * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_UNMOUNT:
345 * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) is unmountable.
346 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
348 #define G_FILE_ATTRIBUTE_MOUNTABLE_CAN_UNMOUNT "mountable::can-unmount" /* boolean */
351 * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_EJECT:
353 * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be ejected.
354 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
356 #define G_FILE_ATTRIBUTE_MOUNTABLE_CAN_EJECT "mountable::can-eject" /* boolean */
359 * G_FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE:
361 * A key in the "mountable" namespace for getting the unix device.
362 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
364 #define G_FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE "mountable::unix-device" /* uint32 */
367 * G_FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE_FILE:
369 * A key in the "mountable" namespace for getting the unix device file.
370 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
372 * Since: 2.22
374 #define G_FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE_FILE "mountable::unix-device-file" /* string */
377 * G_FILE_ATTRIBUTE_MOUNTABLE_HAL_UDI:
379 * A key in the "mountable" namespace for getting the HAL UDI for the mountable
380 * file. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
382 #define G_FILE_ATTRIBUTE_MOUNTABLE_HAL_UDI "mountable::hal-udi" /* string */
385 * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_START:
387 * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be started.
388 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
390 * Since: 2.22
392 #define G_FILE_ATTRIBUTE_MOUNTABLE_CAN_START "mountable::can-start" /* boolean */
395 * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_START_DEGRADED:
397 * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be started
398 * degraded.
399 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
401 * Since: 2.22
403 #define G_FILE_ATTRIBUTE_MOUNTABLE_CAN_START_DEGRADED "mountable::can-start-degraded" /* boolean */
406 * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_STOP:
408 * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be stopped.
409 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
411 * Since: 2.22
413 #define G_FILE_ATTRIBUTE_MOUNTABLE_CAN_STOP "mountable::can-stop" /* boolean */
416 * G_FILE_ATTRIBUTE_MOUNTABLE_START_STOP_TYPE:
418 * A key in the "mountable" namespace for getting the #GDriveStartStopType.
419 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
421 * Since: 2.22
423 #define G_FILE_ATTRIBUTE_MOUNTABLE_START_STOP_TYPE "mountable::start-stop-type" /* uint32 (GDriveStartStopType) */
426 * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_POLL:
428 * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be polled.
429 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
431 * Since: 2.22
433 #define G_FILE_ATTRIBUTE_MOUNTABLE_CAN_POLL "mountable::can-poll" /* boolean */
436 * G_FILE_ATTRIBUTE_MOUNTABLE_IS_MEDIA_CHECK_AUTOMATIC:
438 * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE)
439 * is automatically polled for media.
440 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
442 * Since: 2.22
444 #define G_FILE_ATTRIBUTE_MOUNTABLE_IS_MEDIA_CHECK_AUTOMATIC "mountable::is-media-check-automatic" /* boolean */
446 /* Time attributes */
449 * G_FILE_ATTRIBUTE_TIME_MODIFIED:
451 * A key in the "time" namespace for getting the time the file was last
452 * modified. Corresponding #GFileAttributeType is
453 * %G_FILE_ATTRIBUTE_TYPE_UINT64, and contains the UNIX time since the
454 * file was modified.
456 #define G_FILE_ATTRIBUTE_TIME_MODIFIED "time::modified" /* uint64 */
459 * G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC:
461 * A key in the "time" namespace for getting the miliseconds of the time
462 * the file was last modified. This should be used in conjunction with
463 * #G_FILE_ATTRIBUTE_TIME_MODIFIED. Corresponding #GFileAttributeType is
464 * %G_FILE_ATTRIBUTE_TYPE_UINT32.
466 #define G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC "time::modified-usec" /* uint32 */
469 * G_FILE_ATTRIBUTE_TIME_ACCESS:
471 * A key in the "time" namespace for getting the time the file was last
472 * accessed. Corresponding #GFileAttributeType is
473 * %G_FILE_ATTRIBUTE_TYPE_UINT64, and contains the UNIX time since the
474 * file was last accessed.
476 #define G_FILE_ATTRIBUTE_TIME_ACCESS "time::access" /* uint64 */
479 * G_FILE_ATTRIBUTE_TIME_ACCESS_USEC:
481 * A key in the "time" namespace for getting the microseconds of the time
482 * the file was last accessed. This should be used in conjunction with
483 * #G_FILE_ATTRIBUTE_TIME_ACCESS. Corresponding #GFileAttributeType is
484 * %G_FILE_ATTRIBUTE_TYPE_UINT32.
486 #define G_FILE_ATTRIBUTE_TIME_ACCESS_USEC "time::access-usec" /* uint32 */
489 * G_FILE_ATTRIBUTE_TIME_CHANGED:
491 * A key in the "time" namespace for getting the time the file was last
492 * changed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64,
493 * and contains the UNIX time since the file was last changed.
495 * This corresponds to the traditional UNIX ctime.
497 #define G_FILE_ATTRIBUTE_TIME_CHANGED "time::changed" /* uint64 */
500 * G_FILE_ATTRIBUTE_TIME_CHANGED_USEC:
502 * A key in the "time" namespace for getting the microseconds of the time
503 * the file was last changed. This should be used in conjunction with
504 * #G_FILE_ATTRIBUTE_TIME_CHANGED. Corresponding #GFileAttributeType is
505 * %G_FILE_ATTRIBUTE_TYPE_UINT32.
507 #define G_FILE_ATTRIBUTE_TIME_CHANGED_USEC "time::changed-usec" /* uint32 */
510 * G_FILE_ATTRIBUTE_TIME_CREATED:
512 * A key in the "time" namespace for getting the time the file was created.
513 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64,
514 * and contains the UNIX time since the file was created.
516 * This corresponds to the NTFS ctime.
518 #define G_FILE_ATTRIBUTE_TIME_CREATED "time::created" /* uint64 */
521 * G_FILE_ATTRIBUTE_TIME_CREATED_USEC:
523 * A key in the "time" namespace for getting the microseconds of the time
524 * the file was created. This should be used in conjunction with
525 * #G_FILE_ATTRIBUTE_TIME_CREATED. Corresponding #GFileAttributeType is
526 * %G_FILE_ATTRIBUTE_TYPE_UINT32.
528 #define G_FILE_ATTRIBUTE_TIME_CREATED_USEC "time::created-usec" /* uint32 */
530 /* Unix specific attributes */
533 * G_FILE_ATTRIBUTE_UNIX_DEVICE:
535 * A key in the "unix" namespace for getting the device id of the device the
536 * file is located on (see stat() documentation). This attribute is only
537 * available for UNIX file systems. Corresponding #GFileAttributeType is
538 * %G_FILE_ATTRIBUTE_TYPE_UINT32.
540 #define G_FILE_ATTRIBUTE_UNIX_DEVICE "unix::device" /* uint32 */
543 * G_FILE_ATTRIBUTE_UNIX_INODE:
545 * A key in the "unix" namespace for getting the inode of the file.
546 * This attribute is only available for UNIX file systems. Corresponding
547 * #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64.
549 #define G_FILE_ATTRIBUTE_UNIX_INODE "unix::inode" /* uint64 */
552 * G_FILE_ATTRIBUTE_UNIX_MODE:
554 * A key in the "unix" namespace for getting the mode of the file
555 * (e.g. whether the file is a regular file, symlink, etc). See lstat()
556 * documentation. This attribute is only available for UNIX file systems.
557 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
559 #define G_FILE_ATTRIBUTE_UNIX_MODE "unix::mode" /* uint32 */
562 * G_FILE_ATTRIBUTE_UNIX_NLINK:
564 * A key in the "unix" namespace for getting the number of hard links
565 * for a file. See lstat() documentation. This attribute is only available
566 * for UNIX file systems. Corresponding #GFileAttributeType is
567 * %G_FILE_ATTRIBUTE_TYPE_UINT32.
569 #define G_FILE_ATTRIBUTE_UNIX_NLINK "unix::nlink" /* uint32 */
572 * G_FILE_ATTRIBUTE_UNIX_UID:
574 * A key in the "unix" namespace for getting the user ID for the file.
575 * This attribute is only available for UNIX file systems.
576 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
578 #define G_FILE_ATTRIBUTE_UNIX_UID "unix::uid" /* uint32 */
581 * G_FILE_ATTRIBUTE_UNIX_GID:
583 * A key in the "unix" namespace for getting the group ID for the file.
584 * This attribute is only available for UNIX file systems.
585 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
587 #define G_FILE_ATTRIBUTE_UNIX_GID "unix::gid" /* uint32 */
590 * G_FILE_ATTRIBUTE_UNIX_RDEV:
592 * A key in the "unix" namespace for getting the device ID for the file
593 * (if it is a special file). See lstat() documentation. This attribute
594 * is only available for UNIX file systems. Corresponding #GFileAttributeType
595 * is %G_FILE_ATTRIBUTE_TYPE_UINT32.
597 #define G_FILE_ATTRIBUTE_UNIX_RDEV "unix::rdev" /* uint32 */
600 * G_FILE_ATTRIBUTE_UNIX_BLOCK_SIZE:
602 * A key in the "unix" namespace for getting the block size for the file
603 * system. This attribute is only available for UNIX file systems.
604 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
606 #define G_FILE_ATTRIBUTE_UNIX_BLOCK_SIZE "unix::block-size" /* uint32 */
609 * G_FILE_ATTRIBUTE_UNIX_BLOCKS:
611 * A key in the "unix" namespace for getting the number of blocks allocated
612 * for the file. This attribute is only available for UNIX file systems.
613 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64.
615 #define G_FILE_ATTRIBUTE_UNIX_BLOCKS "unix::blocks" /* uint64 */
618 * G_FILE_ATTRIBUTE_UNIX_IS_MOUNTPOINT:
620 * A key in the "unix" namespace for checking if the file represents a
621 * UNIX mount point. This attribute is %TRUE if the file is a UNIX mount
622 * point. This attribute is only available for UNIX file systems.
623 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
625 #define G_FILE_ATTRIBUTE_UNIX_IS_MOUNTPOINT "unix::is-mountpoint" /* boolean */
627 /* DOS specific attributes */
630 * G_FILE_ATTRIBUTE_DOS_IS_ARCHIVE:
632 * A key in the "dos" namespace for checking if the file's archive flag
633 * is set. This attribute is %TRUE if the archive flag is set. This attribute
634 * is only available for DOS file systems. Corresponding #GFileAttributeType
635 * is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
637 #define G_FILE_ATTRIBUTE_DOS_IS_ARCHIVE "dos::is-archive" /* boolean */
640 * G_FILE_ATTRIBUTE_DOS_IS_SYSTEM:
642 * A key in the "dos" namespace for checking if the file's backup flag
643 * is set. This attribute is %TRUE if the backup flag is set. This attribute
644 * is only available for DOS file systems. Corresponding #GFileAttributeType
645 * is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
647 #define G_FILE_ATTRIBUTE_DOS_IS_SYSTEM "dos::is-system" /* boolean */
649 /* Owner attributes */
652 * G_FILE_ATTRIBUTE_OWNER_USER:
654 * A key in the "owner" namespace for getting the user name of the
655 * file's owner. Corresponding #GFileAttributeType is
656 * %G_FILE_ATTRIBUTE_TYPE_STRING.
658 #define G_FILE_ATTRIBUTE_OWNER_USER "owner::user" /* string */
661 * G_FILE_ATTRIBUTE_OWNER_USER_REAL:
663 * A key in the "owner" namespace for getting the real name of the
664 * user that owns the file. Corresponding #GFileAttributeType is
665 * %G_FILE_ATTRIBUTE_TYPE_STRING.
667 #define G_FILE_ATTRIBUTE_OWNER_USER_REAL "owner::user-real" /* string */
670 * G_FILE_ATTRIBUTE_OWNER_GROUP:
672 * A key in the "owner" namespace for getting the file owner's group.
673 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
675 #define G_FILE_ATTRIBUTE_OWNER_GROUP "owner::group" /* string */
677 /* Thumbnails */
680 * G_FILE_ATTRIBUTE_THUMBNAIL_PATH:
682 * A key in the "thumbnail" namespace for getting the path to the thumbnail
683 * image. Corresponding #GFileAttributeType is
684 * %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING.
686 #define G_FILE_ATTRIBUTE_THUMBNAIL_PATH "thumbnail::path" /* bytestring */
688 * G_FILE_ATTRIBUTE_THUMBNAILING_FAILED:
690 * A key in the "thumbnail" namespace for checking if thumbnailing failed.
691 * This attribute is %TRUE if thumbnailing failed. Corresponding
692 * #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
694 #define G_FILE_ATTRIBUTE_THUMBNAILING_FAILED "thumbnail::failed" /* boolean */
696 /* Preview */
699 * G_FILE_ATTRIBUTE_PREVIEW_ICON:
701 * A key in the "preview" namespace for getting a #GIcon that can be
702 * used to get preview of the file. For example, it may be a low
703 * resolution thumbnail without metadata. Corresponding
704 * #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_OBJECT. The value
705 * for this key should contain a #GIcon.
707 * Since: 2.20
709 #define G_FILE_ATTRIBUTE_PREVIEW_ICON "preview::icon" /* object (GIcon) */
711 /* File system info (for g_file_get_filesystem_info) */
714 * G_FILE_ATTRIBUTE_FILESYSTEM_SIZE:
716 * A key in the "filesystem" namespace for getting the total size (in bytes) of the file system,
717 * used in g_file_query_filesystem_info(). Corresponding #GFileAttributeType
718 * is %G_FILE_ATTRIBUTE_TYPE_UINT64.
720 #define G_FILE_ATTRIBUTE_FILESYSTEM_SIZE "filesystem::size" /* uint64 */
723 * G_FILE_ATTRIBUTE_FILESYSTEM_FREE:
725 * A key in the "filesystem" namespace for getting the number of bytes of free space left on the
726 * file system. Corresponding #GFileAttributeType is
727 * %G_FILE_ATTRIBUTE_TYPE_UINT64.
729 #define G_FILE_ATTRIBUTE_FILESYSTEM_FREE "filesystem::free" /* uint64 */
732 * G_FILE_ATTRIBUTE_FILESYSTEM_USED:
734 * A key in the "filesystem" namespace for getting the number of bytes of used on the
735 * file system. Corresponding #GFileAttributeType is
736 * %G_FILE_ATTRIBUTE_TYPE_UINT64.
738 * Since: 2.32
740 #define G_FILE_ATTRIBUTE_FILESYSTEM_USED "filesystem::used" /* uint64 */
743 * G_FILE_ATTRIBUTE_FILESYSTEM_TYPE:
745 * A key in the "filesystem" namespace for getting the file system's type.
746 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
748 #define G_FILE_ATTRIBUTE_FILESYSTEM_TYPE "filesystem::type" /* string */
751 * G_FILE_ATTRIBUTE_FILESYSTEM_READONLY:
753 * A key in the "filesystem" namespace for checking if the file system
754 * is read only. Is set to %TRUE if the file system is read only.
755 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
757 #define G_FILE_ATTRIBUTE_FILESYSTEM_READONLY "filesystem::readonly" /* boolean */
760 * G_FILE_ATTRIBUTE_FILESYSTEM_USE_PREVIEW:
762 * A key in the "filesystem" namespace for hinting a file manager
763 * application whether it should preview (e.g. thumbnail) files on the
764 * file system. The value for this key contain a
765 * #GFilesystemPreviewType.
767 #define G_FILE_ATTRIBUTE_FILESYSTEM_USE_PREVIEW "filesystem::use-preview" /* uint32 (GFilesystemPreviewType) */
770 * G_FILE_ATTRIBUTE_GVFS_BACKEND:
772 * A key in the "gvfs" namespace that gets the name of the current
773 * GVFS backend in use. Corresponding #GFileAttributeType is
774 * %G_FILE_ATTRIBUTE_TYPE_STRING.
776 #define G_FILE_ATTRIBUTE_GVFS_BACKEND "gvfs::backend" /* string */
779 * G_FILE_ATTRIBUTE_SELINUX_CONTEXT:
781 * A key in the "selinux" namespace for getting the file's SELinux
782 * context. Corresponding #GFileAttributeType is
783 * %G_FILE_ATTRIBUTE_TYPE_STRING. Note that this attribute is only
784 * available if GLib has been built with SELinux support.
786 #define G_FILE_ATTRIBUTE_SELINUX_CONTEXT "selinux::context" /* string */
789 * G_FILE_ATTRIBUTE_TRASH_ITEM_COUNT:
791 * A key in the "trash" namespace. When requested against
792 * "trash:///" returns the number of (toplevel) items in the trash folder.
793 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
795 #define G_FILE_ATTRIBUTE_TRASH_ITEM_COUNT "trash::item-count" /* uint32 */
798 * G_FILE_ATTRIBUTE_TRASH_ORIG_PATH:
800 * A key in the "trash" namespace. When requested against
801 * items in "trash:///", will return the original path to the file before it
802 * was trashed. Corresponding #GFileAttributeType is
803 * %G_FILE_ATTRIBUTE_TYPE_STRING.
805 * Since: 2.24.
807 #define G_FILE_ATTRIBUTE_TRASH_ORIG_PATH "trash::orig-path" /* string */
810 * G_FILE_ATTRIBUTE_TRASH_DELETION_DATE:
812 * A key in the "trash" namespace. When requested against
813 * items in "trash:///", will return the date and time when the file
814 * was trashed. The format of the returned string is YYYY-MM-DDThh:mm:ss.
815 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
817 * Since: 2.24.
819 #define G_FILE_ATTRIBUTE_TRASH_DELETION_DATE "trash::deletion-date" /* string */
821 GType g_file_info_get_type (void) G_GNUC_CONST;
823 GFileInfo * g_file_info_new (void);
824 GFileInfo * g_file_info_dup (GFileInfo *other);
825 void g_file_info_copy_into (GFileInfo *src_info,
826 GFileInfo *dest_info);
827 gboolean g_file_info_has_attribute (GFileInfo *info,
828 const char *attribute);
829 gboolean g_file_info_has_namespace (GFileInfo *info,
830 const char *name_space);
831 char ** g_file_info_list_attributes (GFileInfo *info,
832 const char *name_space);
833 gboolean g_file_info_get_attribute_data (GFileInfo *info,
834 const char *attribute,
835 GFileAttributeType *type,
836 gpointer *value_pp,
837 GFileAttributeStatus *status);
838 GFileAttributeType g_file_info_get_attribute_type (GFileInfo *info,
839 const char *attribute);
840 void g_file_info_remove_attribute (GFileInfo *info,
841 const char *attribute);
842 GFileAttributeStatus g_file_info_get_attribute_status (GFileInfo *info,
843 const char *attribute);
844 gboolean g_file_info_set_attribute_status (GFileInfo *info,
845 const char *attribute,
846 GFileAttributeStatus status);
847 char * g_file_info_get_attribute_as_string (GFileInfo *info,
848 const char *attribute);
849 const char * g_file_info_get_attribute_string (GFileInfo *info,
850 const char *attribute);
851 const char * g_file_info_get_attribute_byte_string (GFileInfo *info,
852 const char *attribute);
853 gboolean g_file_info_get_attribute_boolean (GFileInfo *info,
854 const char *attribute);
855 guint32 g_file_info_get_attribute_uint32 (GFileInfo *info,
856 const char *attribute);
857 gint32 g_file_info_get_attribute_int32 (GFileInfo *info,
858 const char *attribute);
859 guint64 g_file_info_get_attribute_uint64 (GFileInfo *info,
860 const char *attribute);
861 gint64 g_file_info_get_attribute_int64 (GFileInfo *info,
862 const char *attribute);
863 GObject * g_file_info_get_attribute_object (GFileInfo *info,
864 const char *attribute);
865 char ** g_file_info_get_attribute_stringv (GFileInfo *info,
866 const char *attribute);
868 void g_file_info_set_attribute (GFileInfo *info,
869 const char *attribute,
870 GFileAttributeType type,
871 gpointer value_p);
872 void g_file_info_set_attribute_string (GFileInfo *info,
873 const char *attribute,
874 const char *attr_value);
875 void g_file_info_set_attribute_byte_string (GFileInfo *info,
876 const char *attribute,
877 const char *attr_value);
878 void g_file_info_set_attribute_boolean (GFileInfo *info,
879 const char *attribute,
880 gboolean attr_value);
881 void g_file_info_set_attribute_uint32 (GFileInfo *info,
882 const char *attribute,
883 guint32 attr_value);
884 void g_file_info_set_attribute_int32 (GFileInfo *info,
885 const char *attribute,
886 gint32 attr_value);
887 void g_file_info_set_attribute_uint64 (GFileInfo *info,
888 const char *attribute,
889 guint64 attr_value);
890 void g_file_info_set_attribute_int64 (GFileInfo *info,
891 const char *attribute,
892 gint64 attr_value);
893 void g_file_info_set_attribute_object (GFileInfo *info,
894 const char *attribute,
895 GObject *attr_value);
896 void g_file_info_set_attribute_stringv (GFileInfo *info,
897 const char *attribute,
898 char **attr_value);
900 void g_file_info_clear_status (GFileInfo *info);
902 /* Helper getters: */
903 GFileType g_file_info_get_file_type (GFileInfo *info);
904 gboolean g_file_info_get_is_hidden (GFileInfo *info);
905 gboolean g_file_info_get_is_backup (GFileInfo *info);
906 gboolean g_file_info_get_is_symlink (GFileInfo *info);
907 const char * g_file_info_get_name (GFileInfo *info);
908 const char * g_file_info_get_display_name (GFileInfo *info);
909 const char * g_file_info_get_edit_name (GFileInfo *info);
910 GIcon * g_file_info_get_icon (GFileInfo *info);
911 const char * g_file_info_get_content_type (GFileInfo *info);
912 goffset g_file_info_get_size (GFileInfo *info);
913 void g_file_info_get_modification_time (GFileInfo *info,
914 GTimeVal *result);
915 const char * g_file_info_get_symlink_target (GFileInfo *info);
916 const char * g_file_info_get_etag (GFileInfo *info);
917 gint32 g_file_info_get_sort_order (GFileInfo *info);
919 void g_file_info_set_attribute_mask (GFileInfo *info,
920 GFileAttributeMatcher *mask);
921 void g_file_info_unset_attribute_mask (GFileInfo *info);
923 /* Helper setters: */
924 void g_file_info_set_file_type (GFileInfo *info,
925 GFileType type);
926 void g_file_info_set_is_hidden (GFileInfo *info,
927 gboolean is_hidden);
928 void g_file_info_set_is_symlink (GFileInfo *info,
929 gboolean is_symlink);
930 void g_file_info_set_name (GFileInfo *info,
931 const char *name);
932 void g_file_info_set_display_name (GFileInfo *info,
933 const char *display_name);
934 void g_file_info_set_edit_name (GFileInfo *info,
935 const char *edit_name);
936 void g_file_info_set_icon (GFileInfo *info,
937 GIcon *icon);
938 void g_file_info_set_content_type (GFileInfo *info,
939 const char *content_type);
940 void g_file_info_set_size (GFileInfo *info,
941 goffset size);
942 void g_file_info_set_modification_time (GFileInfo *info,
943 GTimeVal *mtime);
944 void g_file_info_set_symlink_target (GFileInfo *info,
945 const char *symlink_target);
946 void g_file_info_set_sort_order (GFileInfo *info,
947 gint32 sort_order);
949 GType g_file_attribute_matcher_get_type (void) G_GNUC_CONST;
950 GFileAttributeMatcher *g_file_attribute_matcher_new (const char *attributes);
951 GFileAttributeMatcher *g_file_attribute_matcher_ref (GFileAttributeMatcher *matcher);
952 void g_file_attribute_matcher_unref (GFileAttributeMatcher *matcher);
953 GFileAttributeMatcher *g_file_attribute_matcher_subtract (GFileAttributeMatcher *matcher,
954 GFileAttributeMatcher *subtract);
955 gboolean g_file_attribute_matcher_matches (GFileAttributeMatcher *matcher,
956 const char *attribute);
957 gboolean g_file_attribute_matcher_matches_only (GFileAttributeMatcher *matcher,
958 const char *attribute);
959 gboolean g_file_attribute_matcher_enumerate_namespace (GFileAttributeMatcher *matcher,
960 const char *ns);
961 const char * g_file_attribute_matcher_enumerate_next (GFileAttributeMatcher *matcher);
962 char * g_file_attribute_matcher_to_string (GFileAttributeMatcher *matcher);
964 G_END_DECLS
966 #endif /* __G_FILE_INFO_H__ */