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 #ifndef __G_FILE_INFO_H__
24 #define __G_FILE_INFO_H__
26 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
27 #error "Only <gio/gio.h> can be included directly."
30 #include <gio/giotypes.h>
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))
44 * Stores information about a file system object referenced by a #GFile.
46 typedef struct _GFileInfoClass GFileInfoClass;
49 /* Common Attributes: */
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.
57 #define G_FILE_ATTRIBUTE_STANDARD_TYPE "standard::type" /* uint32 (GFileType) */
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.
65 #define G_FILE_ATTRIBUTE_STANDARD_IS_HIDDEN "standard::is-hidden" /* boolean */
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.
73 #define G_FILE_ATTRIBUTE_STANDARD_IS_BACKUP "standard::is-backup" /* boolean */
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
81 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
83 #define G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINK "standard::is-symlink" /* boolean */
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.
91 #define G_FILE_ATTRIBUTE_STANDARD_IS_VIRTUAL "standard::is-virtual" /* boolean */
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
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_SYMBOLIC_ICON:
168 * A key in the "standard" namespace for getting the symbolic icon for the file.
169 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_OBJECT.
170 * The value for this key should contain a #GIcon.
174 #define G_FILE_ATTRIBUTE_STANDARD_SYMBOLIC_ICON "standard::symbolic-icon" /* object (GIcon) */
177 * G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE:
179 * A key in the "standard" namespace for getting the content type of the file.
180 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
181 * The value for this key should contain a valid content type.
183 #define G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE "standard::content-type" /* string */
186 * G_FILE_ATTRIBUTE_STANDARD_FAST_CONTENT_TYPE:
188 * A key in the "standard" namespace for getting the fast content type.
189 * The fast content type isn't as reliable as the regular one, as it
190 * only uses the filename to guess it, but it is faster to calculate than the
191 * regular content type.
192 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
195 #define G_FILE_ATTRIBUTE_STANDARD_FAST_CONTENT_TYPE "standard::fast-content-type" /* string */
198 * G_FILE_ATTRIBUTE_STANDARD_SIZE:
200 * A key in the "standard" namespace for getting the file's size (in bytes).
201 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64.
203 #define G_FILE_ATTRIBUTE_STANDARD_SIZE "standard::size" /* uint64 */
206 * G_FILE_ATTRIBUTE_STANDARD_ALLOCATED_SIZE:
208 * A key in the "standard" namespace for getting the amount of disk space
209 * that is consumed by the file (in bytes). This will generally be larger
210 * than the file size (due to block size overhead) but can occasionally be
211 * smaller (for example, for sparse files).
212 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64.
216 #define G_FILE_ATTRIBUTE_STANDARD_ALLOCATED_SIZE "standard::allocated-size" /* uint64 */
219 * G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET:
221 * A key in the "standard" namespace for getting the symlink target, if the file
222 * is a symlink. Corresponding #GFileAttributeType is
223 * %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING.
225 #define G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET "standard::symlink-target" /* byte string */
228 * G_FILE_ATTRIBUTE_STANDARD_TARGET_URI:
230 * A key in the "standard" namespace for getting the target URI for the file, in
231 * the case of %G_FILE_TYPE_SHORTCUT or %G_FILE_TYPE_MOUNTABLE files.
232 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
234 #define G_FILE_ATTRIBUTE_STANDARD_TARGET_URI "standard::target-uri" /* string */
237 * G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER:
239 * A key in the "standard" namespace for setting the sort order of a file.
240 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_INT32.
241 * An example use would be in file managers, which would use this key
242 * to set the order files are displayed. Files with smaller sort order
243 * should be sorted first, and files without sort order as if sort order
246 #define G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER "standard::sort-order" /* int32 */
248 /* Entity tags, used to avoid missing updates on save */
251 * G_FILE_ATTRIBUTE_ETAG_VALUE:
253 * A key in the "etag" namespace for getting the value of the file's
254 * entity tag. Corresponding #GFileAttributeType is
255 * %G_FILE_ATTRIBUTE_TYPE_STRING.
257 #define G_FILE_ATTRIBUTE_ETAG_VALUE "etag::value" /* string */
259 /* File identifier, for e.g. avoiding loops when doing recursive
264 * G_FILE_ATTRIBUTE_ID_FILE:
266 * A key in the "id" namespace for getting a file identifier.
267 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
268 * An example use would be during listing files, to avoid recursive
269 * directory scanning.
271 #define G_FILE_ATTRIBUTE_ID_FILE "id::file" /* string */
274 * G_FILE_ATTRIBUTE_ID_FILESYSTEM:
276 * A key in the "id" namespace for getting the file system identifier.
277 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
278 * An example use would be during drag and drop to see if the source
279 * and target are on the same filesystem (default to move) or not (default
282 #define G_FILE_ATTRIBUTE_ID_FILESYSTEM "id::filesystem" /* string */
284 /* Calculated Access Rights for current user */
287 * G_FILE_ATTRIBUTE_ACCESS_CAN_READ:
289 * A key in the "access" namespace for getting read privileges.
290 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
291 * This attribute will be %TRUE if the user is able to read the file.
293 #define G_FILE_ATTRIBUTE_ACCESS_CAN_READ "access::can-read" /* boolean */
296 * G_FILE_ATTRIBUTE_ACCESS_CAN_WRITE:
298 * A key in the "access" namespace for getting write privileges.
299 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
300 * This attribute will be %TRUE if the user is able to write to the file.
302 #define G_FILE_ATTRIBUTE_ACCESS_CAN_WRITE "access::can-write" /* boolean */
305 * G_FILE_ATTRIBUTE_ACCESS_CAN_EXECUTE:
307 * A key in the "access" namespace for getting execution privileges.
308 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
309 * This attribute will be %TRUE if the user is able to execute the file.
311 #define G_FILE_ATTRIBUTE_ACCESS_CAN_EXECUTE "access::can-execute" /* boolean */
314 * G_FILE_ATTRIBUTE_ACCESS_CAN_DELETE:
316 * A key in the "access" namespace for checking deletion privileges.
317 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
318 * This attribute will be %TRUE if the user is able to delete the file.
320 #define G_FILE_ATTRIBUTE_ACCESS_CAN_DELETE "access::can-delete" /* boolean */
323 * G_FILE_ATTRIBUTE_ACCESS_CAN_TRASH:
325 * A key in the "access" namespace for checking trashing privileges.
326 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
327 * This attribute will be %TRUE if the user is able to move the file to
330 #define G_FILE_ATTRIBUTE_ACCESS_CAN_TRASH "access::can-trash" /* boolean */
333 * G_FILE_ATTRIBUTE_ACCESS_CAN_RENAME:
335 * A key in the "access" namespace for checking renaming privileges.
336 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
337 * This attribute will be %TRUE if the user is able to rename the file.
339 #define G_FILE_ATTRIBUTE_ACCESS_CAN_RENAME "access::can-rename" /* boolean */
341 /* TODO: Should we have special version for directories? can_enumerate, etc */
343 /* Mountable attributes */
346 * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_MOUNT:
348 * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) is mountable.
349 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
351 #define G_FILE_ATTRIBUTE_MOUNTABLE_CAN_MOUNT "mountable::can-mount" /* boolean */
354 * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_UNMOUNT:
356 * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) is unmountable.
357 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
359 #define G_FILE_ATTRIBUTE_MOUNTABLE_CAN_UNMOUNT "mountable::can-unmount" /* boolean */
362 * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_EJECT:
364 * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be ejected.
365 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
367 #define G_FILE_ATTRIBUTE_MOUNTABLE_CAN_EJECT "mountable::can-eject" /* boolean */
370 * G_FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE:
372 * A key in the "mountable" namespace for getting the unix device.
373 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
375 #define G_FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE "mountable::unix-device" /* uint32 */
378 * G_FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE_FILE:
380 * A key in the "mountable" namespace for getting the unix device file.
381 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
385 #define G_FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE_FILE "mountable::unix-device-file" /* string */
388 * G_FILE_ATTRIBUTE_MOUNTABLE_HAL_UDI:
390 * A key in the "mountable" namespace for getting the HAL UDI for the mountable
391 * file. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
393 #define G_FILE_ATTRIBUTE_MOUNTABLE_HAL_UDI "mountable::hal-udi" /* string */
396 * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_START:
398 * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be started.
399 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
403 #define G_FILE_ATTRIBUTE_MOUNTABLE_CAN_START "mountable::can-start" /* boolean */
406 * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_START_DEGRADED:
408 * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be started
410 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
414 #define G_FILE_ATTRIBUTE_MOUNTABLE_CAN_START_DEGRADED "mountable::can-start-degraded" /* boolean */
417 * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_STOP:
419 * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be stopped.
420 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
424 #define G_FILE_ATTRIBUTE_MOUNTABLE_CAN_STOP "mountable::can-stop" /* boolean */
427 * G_FILE_ATTRIBUTE_MOUNTABLE_START_STOP_TYPE:
429 * A key in the "mountable" namespace for getting the #GDriveStartStopType.
430 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
434 #define G_FILE_ATTRIBUTE_MOUNTABLE_START_STOP_TYPE "mountable::start-stop-type" /* uint32 (GDriveStartStopType) */
437 * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_POLL:
439 * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be polled.
440 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
444 #define G_FILE_ATTRIBUTE_MOUNTABLE_CAN_POLL "mountable::can-poll" /* boolean */
447 * G_FILE_ATTRIBUTE_MOUNTABLE_IS_MEDIA_CHECK_AUTOMATIC:
449 * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE)
450 * is automatically polled for media.
451 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
455 #define G_FILE_ATTRIBUTE_MOUNTABLE_IS_MEDIA_CHECK_AUTOMATIC "mountable::is-media-check-automatic" /* boolean */
457 /* Time attributes */
460 * G_FILE_ATTRIBUTE_TIME_MODIFIED:
462 * A key in the "time" namespace for getting the time the file was last
463 * modified. Corresponding #GFileAttributeType is
464 * %G_FILE_ATTRIBUTE_TYPE_UINT64, and contains the UNIX time since the
467 #define G_FILE_ATTRIBUTE_TIME_MODIFIED "time::modified" /* uint64 */
470 * G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC:
472 * A key in the "time" namespace for getting the miliseconds of the time
473 * the file was last modified. This should be used in conjunction with
474 * #G_FILE_ATTRIBUTE_TIME_MODIFIED. Corresponding #GFileAttributeType is
475 * %G_FILE_ATTRIBUTE_TYPE_UINT32.
477 #define G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC "time::modified-usec" /* uint32 */
480 * G_FILE_ATTRIBUTE_TIME_ACCESS:
482 * A key in the "time" namespace for getting the time the file was last
483 * accessed. Corresponding #GFileAttributeType is
484 * %G_FILE_ATTRIBUTE_TYPE_UINT64, and contains the UNIX time since the
485 * file was last accessed.
487 #define G_FILE_ATTRIBUTE_TIME_ACCESS "time::access" /* uint64 */
490 * G_FILE_ATTRIBUTE_TIME_ACCESS_USEC:
492 * A key in the "time" namespace for getting the microseconds of the time
493 * the file was last accessed. This should be used in conjunction with
494 * #G_FILE_ATTRIBUTE_TIME_ACCESS. Corresponding #GFileAttributeType is
495 * %G_FILE_ATTRIBUTE_TYPE_UINT32.
497 #define G_FILE_ATTRIBUTE_TIME_ACCESS_USEC "time::access-usec" /* uint32 */
500 * G_FILE_ATTRIBUTE_TIME_CHANGED:
502 * A key in the "time" namespace for getting the time the file was last
503 * changed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64,
504 * and contains the UNIX time since the file was last changed.
506 * This corresponds to the traditional UNIX ctime.
508 #define G_FILE_ATTRIBUTE_TIME_CHANGED "time::changed" /* uint64 */
511 * G_FILE_ATTRIBUTE_TIME_CHANGED_USEC:
513 * A key in the "time" namespace for getting the microseconds of the time
514 * the file was last changed. This should be used in conjunction with
515 * #G_FILE_ATTRIBUTE_TIME_CHANGED. Corresponding #GFileAttributeType is
516 * %G_FILE_ATTRIBUTE_TYPE_UINT32.
518 #define G_FILE_ATTRIBUTE_TIME_CHANGED_USEC "time::changed-usec" /* uint32 */
521 * G_FILE_ATTRIBUTE_TIME_CREATED:
523 * A key in the "time" namespace for getting the time the file was created.
524 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64,
525 * and contains the UNIX time since the file was created.
527 * This corresponds to the NTFS ctime.
529 #define G_FILE_ATTRIBUTE_TIME_CREATED "time::created" /* uint64 */
532 * G_FILE_ATTRIBUTE_TIME_CREATED_USEC:
534 * A key in the "time" namespace for getting the microseconds of the time
535 * the file was created. This should be used in conjunction with
536 * #G_FILE_ATTRIBUTE_TIME_CREATED. Corresponding #GFileAttributeType is
537 * %G_FILE_ATTRIBUTE_TYPE_UINT32.
539 #define G_FILE_ATTRIBUTE_TIME_CREATED_USEC "time::created-usec" /* uint32 */
541 /* Unix specific attributes */
544 * G_FILE_ATTRIBUTE_UNIX_DEVICE:
546 * A key in the "unix" namespace for getting the device id of the device the
547 * file is located on (see stat() documentation). This attribute is only
548 * available for UNIX file systems. Corresponding #GFileAttributeType is
549 * %G_FILE_ATTRIBUTE_TYPE_UINT32.
551 #define G_FILE_ATTRIBUTE_UNIX_DEVICE "unix::device" /* uint32 */
554 * G_FILE_ATTRIBUTE_UNIX_INODE:
556 * A key in the "unix" namespace for getting the inode of the file.
557 * This attribute is only available for UNIX file systems. Corresponding
558 * #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64.
560 #define G_FILE_ATTRIBUTE_UNIX_INODE "unix::inode" /* uint64 */
563 * G_FILE_ATTRIBUTE_UNIX_MODE:
565 * A key in the "unix" namespace for getting the mode of the file
566 * (e.g. whether the file is a regular file, symlink, etc). See lstat()
567 * documentation. This attribute is only available for UNIX file systems.
568 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
570 #define G_FILE_ATTRIBUTE_UNIX_MODE "unix::mode" /* uint32 */
573 * G_FILE_ATTRIBUTE_UNIX_NLINK:
575 * A key in the "unix" namespace for getting the number of hard links
576 * for a file. See lstat() documentation. This attribute is only available
577 * for UNIX file systems. Corresponding #GFileAttributeType is
578 * %G_FILE_ATTRIBUTE_TYPE_UINT32.
580 #define G_FILE_ATTRIBUTE_UNIX_NLINK "unix::nlink" /* uint32 */
583 * G_FILE_ATTRIBUTE_UNIX_UID:
585 * A key in the "unix" namespace for getting the user ID for the file.
586 * This attribute is only available for UNIX file systems.
587 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
589 #define G_FILE_ATTRIBUTE_UNIX_UID "unix::uid" /* uint32 */
592 * G_FILE_ATTRIBUTE_UNIX_GID:
594 * A key in the "unix" namespace for getting the group ID for the file.
595 * This attribute is only available for UNIX file systems.
596 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
598 #define G_FILE_ATTRIBUTE_UNIX_GID "unix::gid" /* uint32 */
601 * G_FILE_ATTRIBUTE_UNIX_RDEV:
603 * A key in the "unix" namespace for getting the device ID for the file
604 * (if it is a special file). See lstat() documentation. This attribute
605 * is only available for UNIX file systems. Corresponding #GFileAttributeType
606 * is %G_FILE_ATTRIBUTE_TYPE_UINT32.
608 #define G_FILE_ATTRIBUTE_UNIX_RDEV "unix::rdev" /* uint32 */
611 * G_FILE_ATTRIBUTE_UNIX_BLOCK_SIZE:
613 * A key in the "unix" namespace for getting the block size for the file
614 * system. This attribute is only available for UNIX file systems.
615 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
617 #define G_FILE_ATTRIBUTE_UNIX_BLOCK_SIZE "unix::block-size" /* uint32 */
620 * G_FILE_ATTRIBUTE_UNIX_BLOCKS:
622 * A key in the "unix" namespace for getting the number of blocks allocated
623 * for the file. This attribute is only available for UNIX file systems.
624 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64.
626 #define G_FILE_ATTRIBUTE_UNIX_BLOCKS "unix::blocks" /* uint64 */
629 * G_FILE_ATTRIBUTE_UNIX_IS_MOUNTPOINT:
631 * A key in the "unix" namespace for checking if the file represents a
632 * UNIX mount point. This attribute is %TRUE if the file is a UNIX mount
633 * point. This attribute is only available for UNIX file systems.
634 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
636 #define G_FILE_ATTRIBUTE_UNIX_IS_MOUNTPOINT "unix::is-mountpoint" /* boolean */
638 /* DOS specific attributes */
641 * G_FILE_ATTRIBUTE_DOS_IS_ARCHIVE:
643 * A key in the "dos" namespace for checking if the file's archive flag
644 * is set. This attribute is %TRUE if the archive flag is set. This attribute
645 * is only available for DOS file systems. Corresponding #GFileAttributeType
646 * is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
648 #define G_FILE_ATTRIBUTE_DOS_IS_ARCHIVE "dos::is-archive" /* boolean */
651 * G_FILE_ATTRIBUTE_DOS_IS_SYSTEM:
653 * A key in the "dos" namespace for checking if the file's backup flag
654 * is set. This attribute is %TRUE if the backup flag is set. This attribute
655 * is only available for DOS file systems. Corresponding #GFileAttributeType
656 * is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
658 #define G_FILE_ATTRIBUTE_DOS_IS_SYSTEM "dos::is-system" /* boolean */
660 /* Owner attributes */
663 * G_FILE_ATTRIBUTE_OWNER_USER:
665 * A key in the "owner" namespace for getting the user name of the
666 * file's owner. Corresponding #GFileAttributeType is
667 * %G_FILE_ATTRIBUTE_TYPE_STRING.
669 #define G_FILE_ATTRIBUTE_OWNER_USER "owner::user" /* string */
672 * G_FILE_ATTRIBUTE_OWNER_USER_REAL:
674 * A key in the "owner" namespace for getting the real name of the
675 * user that owns the file. Corresponding #GFileAttributeType is
676 * %G_FILE_ATTRIBUTE_TYPE_STRING.
678 #define G_FILE_ATTRIBUTE_OWNER_USER_REAL "owner::user-real" /* string */
681 * G_FILE_ATTRIBUTE_OWNER_GROUP:
683 * A key in the "owner" namespace for getting the file owner's group.
684 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
686 #define G_FILE_ATTRIBUTE_OWNER_GROUP "owner::group" /* string */
691 * G_FILE_ATTRIBUTE_THUMBNAIL_PATH:
693 * A key in the "thumbnail" namespace for getting the path to the thumbnail
694 * image. Corresponding #GFileAttributeType is
695 * %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING.
697 #define G_FILE_ATTRIBUTE_THUMBNAIL_PATH "thumbnail::path" /* bytestring */
699 * G_FILE_ATTRIBUTE_THUMBNAILING_FAILED:
701 * A key in the "thumbnail" namespace for checking if thumbnailing failed.
702 * This attribute is %TRUE if thumbnailing failed. Corresponding
703 * #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
705 #define G_FILE_ATTRIBUTE_THUMBNAILING_FAILED "thumbnail::failed" /* boolean */
707 * G_FILE_ATTRIBUTE_THUMBNAIL_IS_VALID:
709 * A key in the "thumbnail" namespace for checking whether the thumbnail is outdated.
710 * This attribute is %TRUE if the thumbnail is up-to-date with the file it represents,
711 * and %FALSE if the file has been modified since the thumbnail was generated.
713 * If %G_FILE_ATTRIBUTE_THUMBNAILING_FAILED is %TRUE and this attribute is %FALSE,
714 * it indicates that thumbnailing may be attempted again and may succeed.
716 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
720 #define G_FILE_ATTRIBUTE_THUMBNAIL_IS_VALID "thumbnail::is-valid" /* boolean */
725 * G_FILE_ATTRIBUTE_PREVIEW_ICON:
727 * A key in the "preview" namespace for getting a #GIcon that can be
728 * used to get preview of the file. For example, it may be a low
729 * resolution thumbnail without metadata. Corresponding
730 * #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_OBJECT. The value
731 * for this key should contain a #GIcon.
735 #define G_FILE_ATTRIBUTE_PREVIEW_ICON "preview::icon" /* object (GIcon) */
737 /* File system info (for g_file_get_filesystem_info) */
740 * G_FILE_ATTRIBUTE_FILESYSTEM_SIZE:
742 * A key in the "filesystem" namespace for getting the total size (in bytes) of the file system,
743 * used in g_file_query_filesystem_info(). Corresponding #GFileAttributeType
744 * is %G_FILE_ATTRIBUTE_TYPE_UINT64.
746 #define G_FILE_ATTRIBUTE_FILESYSTEM_SIZE "filesystem::size" /* uint64 */
749 * G_FILE_ATTRIBUTE_FILESYSTEM_FREE:
751 * A key in the "filesystem" namespace for getting the number of bytes of free space left on the
752 * file system. Corresponding #GFileAttributeType is
753 * %G_FILE_ATTRIBUTE_TYPE_UINT64.
755 #define G_FILE_ATTRIBUTE_FILESYSTEM_FREE "filesystem::free" /* uint64 */
758 * G_FILE_ATTRIBUTE_FILESYSTEM_USED:
760 * A key in the "filesystem" namespace for getting the number of bytes of used on the
761 * file system. Corresponding #GFileAttributeType is
762 * %G_FILE_ATTRIBUTE_TYPE_UINT64.
766 #define G_FILE_ATTRIBUTE_FILESYSTEM_USED "filesystem::used" /* uint64 */
769 * G_FILE_ATTRIBUTE_FILESYSTEM_TYPE:
771 * A key in the "filesystem" namespace for getting the file system's type.
772 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
774 #define G_FILE_ATTRIBUTE_FILESYSTEM_TYPE "filesystem::type" /* string */
777 * G_FILE_ATTRIBUTE_FILESYSTEM_READONLY:
779 * A key in the "filesystem" namespace for checking if the file system
780 * is read only. Is set to %TRUE if the file system is read only.
781 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
783 #define G_FILE_ATTRIBUTE_FILESYSTEM_READONLY "filesystem::readonly" /* boolean */
786 * G_FILE_ATTRIBUTE_FILESYSTEM_USE_PREVIEW:
788 * A key in the "filesystem" namespace for hinting a file manager
789 * application whether it should preview (e.g. thumbnail) files on the
790 * file system. The value for this key contain a
791 * #GFilesystemPreviewType.
793 #define G_FILE_ATTRIBUTE_FILESYSTEM_USE_PREVIEW "filesystem::use-preview" /* uint32 (GFilesystemPreviewType) */
796 * G_FILE_ATTRIBUTE_GVFS_BACKEND:
798 * A key in the "gvfs" namespace that gets the name of the current
799 * GVFS backend in use. Corresponding #GFileAttributeType is
800 * %G_FILE_ATTRIBUTE_TYPE_STRING.
802 #define G_FILE_ATTRIBUTE_GVFS_BACKEND "gvfs::backend" /* string */
805 * G_FILE_ATTRIBUTE_SELINUX_CONTEXT:
807 * A key in the "selinux" namespace for getting the file's SELinux
808 * context. Corresponding #GFileAttributeType is
809 * %G_FILE_ATTRIBUTE_TYPE_STRING. Note that this attribute is only
810 * available if GLib has been built with SELinux support.
812 #define G_FILE_ATTRIBUTE_SELINUX_CONTEXT "selinux::context" /* string */
815 * G_FILE_ATTRIBUTE_TRASH_ITEM_COUNT:
817 * A key in the "trash" namespace. When requested against
818 * "trash:///" returns the number of (toplevel) items in the trash folder.
819 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
821 #define G_FILE_ATTRIBUTE_TRASH_ITEM_COUNT "trash::item-count" /* uint32 */
824 * G_FILE_ATTRIBUTE_TRASH_ORIG_PATH:
826 * A key in the "trash" namespace. When requested against
827 * items in "trash:///", will return the original path to the file before it
828 * was trashed. Corresponding #GFileAttributeType is
829 * %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING.
833 #define G_FILE_ATTRIBUTE_TRASH_ORIG_PATH "trash::orig-path" /* byte string */
836 * G_FILE_ATTRIBUTE_TRASH_DELETION_DATE:
838 * A key in the "trash" namespace. When requested against
839 * items in "trash:///", will return the date and time when the file
840 * was trashed. The format of the returned string is YYYY-MM-DDThh:mm:ss.
841 * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
845 #define G_FILE_ATTRIBUTE_TRASH_DELETION_DATE "trash::deletion-date" /* string */
847 GLIB_AVAILABLE_IN_ALL
848 GType g_file_info_get_type (void) G_GNUC_CONST;
850 GLIB_AVAILABLE_IN_ALL
851 GFileInfo * g_file_info_new (void);
852 GLIB_AVAILABLE_IN_ALL
853 GFileInfo * g_file_info_dup (GFileInfo *other);
854 GLIB_AVAILABLE_IN_ALL
855 void g_file_info_copy_into (GFileInfo *src_info,
856 GFileInfo *dest_info);
857 GLIB_AVAILABLE_IN_ALL
858 gboolean g_file_info_has_attribute (GFileInfo *info,
859 const char *attribute);
860 GLIB_AVAILABLE_IN_ALL
861 gboolean g_file_info_has_namespace (GFileInfo *info,
862 const char *name_space);
863 GLIB_AVAILABLE_IN_ALL
864 char ** g_file_info_list_attributes (GFileInfo *info,
865 const char *name_space);
866 GLIB_AVAILABLE_IN_ALL
867 gboolean g_file_info_get_attribute_data (GFileInfo *info,
868 const char *attribute,
869 GFileAttributeType *type,
871 GFileAttributeStatus *status);
872 GLIB_AVAILABLE_IN_ALL
873 GFileAttributeType g_file_info_get_attribute_type (GFileInfo *info,
874 const char *attribute);
875 GLIB_AVAILABLE_IN_ALL
876 void g_file_info_remove_attribute (GFileInfo *info,
877 const char *attribute);
878 GLIB_AVAILABLE_IN_ALL
879 GFileAttributeStatus g_file_info_get_attribute_status (GFileInfo *info,
880 const char *attribute);
881 GLIB_AVAILABLE_IN_ALL
882 gboolean g_file_info_set_attribute_status (GFileInfo *info,
883 const char *attribute,
884 GFileAttributeStatus status);
885 GLIB_AVAILABLE_IN_ALL
886 char * g_file_info_get_attribute_as_string (GFileInfo *info,
887 const char *attribute);
888 GLIB_AVAILABLE_IN_ALL
889 const char * g_file_info_get_attribute_string (GFileInfo *info,
890 const char *attribute);
891 GLIB_AVAILABLE_IN_ALL
892 const char * g_file_info_get_attribute_byte_string (GFileInfo *info,
893 const char *attribute);
894 GLIB_AVAILABLE_IN_ALL
895 gboolean g_file_info_get_attribute_boolean (GFileInfo *info,
896 const char *attribute);
897 GLIB_AVAILABLE_IN_ALL
898 guint32 g_file_info_get_attribute_uint32 (GFileInfo *info,
899 const char *attribute);
900 GLIB_AVAILABLE_IN_ALL
901 gint32 g_file_info_get_attribute_int32 (GFileInfo *info,
902 const char *attribute);
903 GLIB_AVAILABLE_IN_ALL
904 guint64 g_file_info_get_attribute_uint64 (GFileInfo *info,
905 const char *attribute);
906 GLIB_AVAILABLE_IN_ALL
907 gint64 g_file_info_get_attribute_int64 (GFileInfo *info,
908 const char *attribute);
909 GLIB_AVAILABLE_IN_ALL
910 GObject * g_file_info_get_attribute_object (GFileInfo *info,
911 const char *attribute);
912 GLIB_AVAILABLE_IN_ALL
913 char ** g_file_info_get_attribute_stringv (GFileInfo *info,
914 const char *attribute);
916 GLIB_AVAILABLE_IN_ALL
917 void g_file_info_set_attribute (GFileInfo *info,
918 const char *attribute,
919 GFileAttributeType type,
921 GLIB_AVAILABLE_IN_ALL
922 void g_file_info_set_attribute_string (GFileInfo *info,
923 const char *attribute,
924 const char *attr_value);
925 GLIB_AVAILABLE_IN_ALL
926 void g_file_info_set_attribute_byte_string (GFileInfo *info,
927 const char *attribute,
928 const char *attr_value);
929 GLIB_AVAILABLE_IN_ALL
930 void g_file_info_set_attribute_boolean (GFileInfo *info,
931 const char *attribute,
932 gboolean attr_value);
933 GLIB_AVAILABLE_IN_ALL
934 void g_file_info_set_attribute_uint32 (GFileInfo *info,
935 const char *attribute,
937 GLIB_AVAILABLE_IN_ALL
938 void g_file_info_set_attribute_int32 (GFileInfo *info,
939 const char *attribute,
941 GLIB_AVAILABLE_IN_ALL
942 void g_file_info_set_attribute_uint64 (GFileInfo *info,
943 const char *attribute,
945 GLIB_AVAILABLE_IN_ALL
946 void g_file_info_set_attribute_int64 (GFileInfo *info,
947 const char *attribute,
949 GLIB_AVAILABLE_IN_ALL
950 void g_file_info_set_attribute_object (GFileInfo *info,
951 const char *attribute,
952 GObject *attr_value);
953 GLIB_AVAILABLE_IN_ALL
954 void g_file_info_set_attribute_stringv (GFileInfo *info,
955 const char *attribute,
958 GLIB_AVAILABLE_IN_ALL
959 void g_file_info_clear_status (GFileInfo *info);
961 /* Helper getters: */
962 GLIB_AVAILABLE_IN_2_36
963 GDateTime * g_file_info_get_deletion_date (GFileInfo *info);
964 GLIB_AVAILABLE_IN_ALL
965 GFileType g_file_info_get_file_type (GFileInfo *info);
966 GLIB_AVAILABLE_IN_ALL
967 gboolean g_file_info_get_is_hidden (GFileInfo *info);
968 GLIB_AVAILABLE_IN_ALL
969 gboolean g_file_info_get_is_backup (GFileInfo *info);
970 GLIB_AVAILABLE_IN_ALL
971 gboolean g_file_info_get_is_symlink (GFileInfo *info);
972 GLIB_AVAILABLE_IN_ALL
973 const char * g_file_info_get_name (GFileInfo *info);
974 GLIB_AVAILABLE_IN_ALL
975 const char * g_file_info_get_display_name (GFileInfo *info);
976 GLIB_AVAILABLE_IN_ALL
977 const char * g_file_info_get_edit_name (GFileInfo *info);
978 GLIB_AVAILABLE_IN_ALL
979 GIcon * g_file_info_get_icon (GFileInfo *info);
980 GLIB_AVAILABLE_IN_ALL
981 GIcon * g_file_info_get_symbolic_icon (GFileInfo *info);
982 GLIB_AVAILABLE_IN_ALL
983 const char * g_file_info_get_content_type (GFileInfo *info);
984 GLIB_AVAILABLE_IN_ALL
985 goffset g_file_info_get_size (GFileInfo *info);
986 GLIB_AVAILABLE_IN_ALL
987 void g_file_info_get_modification_time (GFileInfo *info,
989 GLIB_AVAILABLE_IN_ALL
990 const char * g_file_info_get_symlink_target (GFileInfo *info);
991 GLIB_AVAILABLE_IN_ALL
992 const char * g_file_info_get_etag (GFileInfo *info);
993 GLIB_AVAILABLE_IN_ALL
994 gint32 g_file_info_get_sort_order (GFileInfo *info);
996 GLIB_AVAILABLE_IN_ALL
997 void g_file_info_set_attribute_mask (GFileInfo *info,
998 GFileAttributeMatcher *mask);
999 GLIB_AVAILABLE_IN_ALL
1000 void g_file_info_unset_attribute_mask (GFileInfo *info);
1002 /* Helper setters: */
1003 GLIB_AVAILABLE_IN_ALL
1004 void g_file_info_set_file_type (GFileInfo *info,
1006 GLIB_AVAILABLE_IN_ALL
1007 void g_file_info_set_is_hidden (GFileInfo *info,
1008 gboolean is_hidden);
1009 GLIB_AVAILABLE_IN_ALL
1010 void g_file_info_set_is_symlink (GFileInfo *info,
1011 gboolean is_symlink);
1012 GLIB_AVAILABLE_IN_ALL
1013 void g_file_info_set_name (GFileInfo *info,
1015 GLIB_AVAILABLE_IN_ALL
1016 void g_file_info_set_display_name (GFileInfo *info,
1017 const char *display_name);
1018 GLIB_AVAILABLE_IN_ALL
1019 void g_file_info_set_edit_name (GFileInfo *info,
1020 const char *edit_name);
1021 GLIB_AVAILABLE_IN_ALL
1022 void g_file_info_set_icon (GFileInfo *info,
1024 GLIB_AVAILABLE_IN_ALL
1025 void g_file_info_set_symbolic_icon (GFileInfo *info,
1027 GLIB_AVAILABLE_IN_ALL
1028 void g_file_info_set_content_type (GFileInfo *info,
1029 const char *content_type);
1030 GLIB_AVAILABLE_IN_ALL
1031 void g_file_info_set_size (GFileInfo *info,
1033 GLIB_AVAILABLE_IN_ALL
1034 void g_file_info_set_modification_time (GFileInfo *info,
1036 GLIB_AVAILABLE_IN_ALL
1037 void g_file_info_set_symlink_target (GFileInfo *info,
1038 const char *symlink_target);
1039 GLIB_AVAILABLE_IN_ALL
1040 void g_file_info_set_sort_order (GFileInfo *info,
1043 #define G_TYPE_FILE_ATTRIBUTE_MATCHER (g_file_attribute_matcher_get_type ())
1044 GLIB_AVAILABLE_IN_ALL
1045 GType g_file_attribute_matcher_get_type (void) G_GNUC_CONST;
1047 GLIB_AVAILABLE_IN_ALL
1048 GFileAttributeMatcher *g_file_attribute_matcher_new (const char *attributes);
1049 GLIB_AVAILABLE_IN_ALL
1050 GFileAttributeMatcher *g_file_attribute_matcher_ref (GFileAttributeMatcher *matcher);
1051 GLIB_AVAILABLE_IN_ALL
1052 void g_file_attribute_matcher_unref (GFileAttributeMatcher *matcher);
1053 GLIB_AVAILABLE_IN_ALL
1054 GFileAttributeMatcher *g_file_attribute_matcher_subtract (GFileAttributeMatcher *matcher,
1055 GFileAttributeMatcher *subtract);
1056 GLIB_AVAILABLE_IN_ALL
1057 gboolean g_file_attribute_matcher_matches (GFileAttributeMatcher *matcher,
1058 const char *attribute);
1059 GLIB_AVAILABLE_IN_ALL
1060 gboolean g_file_attribute_matcher_matches_only (GFileAttributeMatcher *matcher,
1061 const char *attribute);
1062 GLIB_AVAILABLE_IN_ALL
1063 gboolean g_file_attribute_matcher_enumerate_namespace (GFileAttributeMatcher *matcher,
1065 GLIB_AVAILABLE_IN_ALL
1066 const char * g_file_attribute_matcher_enumerate_next (GFileAttributeMatcher *matcher);
1067 GLIB_AVAILABLE_IN_2_32
1068 char * g_file_attribute_matcher_to_string (GFileAttributeMatcher *matcher);
1072 #endif /* __G_FILE_INFO_H__ */