gio/gfileinfo.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 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
  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.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  24 #error "Only <gio/gio.h> can be included directly."
  25 #endif
  26
  27 #ifndef __G_FILE_INFO_H__
  28 #define __G_FILE_INFO_H__
  29
  30 #include <gio/giotypes.h>
  31
  32 G_BEGIN_DECLS
  33
  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))
  40
  41 /**
  42  * GFileInfo:
  43  *
  44  * Stores information about a file system object referenced by a #GFile.
  45  **/
  46 typedef struct _GFileInfoClass   GFileInfoClass;
  47
  48
  49 /* Common Attributes:  */
  50 /**
  51  * G_FILE_ATTRIBUTE_STANDARD_TYPE:
  52  *
  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) */
  58
  59 /**
  60  * G_FILE_ATTRIBUTE_STANDARD_IS_HIDDEN:
  61  *
  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 */
  66
  67 /**
  68  * G_FILE_ATTRIBUTE_STANDARD_IS_BACKUP:
  69  *
  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 */
  74
  75 /**
  76  * G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINK:
  77  *
  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 */
  84
  85 /**
  86  * G_FILE_ATTRIBUTE_STANDARD_IS_VIRTUAL:
  87  *
  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 */
  92
  93 /**
  94  * G_FILE_ATTRIBUTE_STANDARD_NAME:
  95  *
  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.
 102  **/
 103 #define G_FILE_ATTRIBUTE_STANDARD_NAME "standard::name"                     /* byte string */
 104
 105 /**
 106  * G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME:
 107  *
 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.
 112  **/
 113 #define G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME "standard::display-name"     /* string */
 114
 115 /**
 116  * G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME:
 117  *
 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).
 123  *
 124  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
 125  **/
 126 #define G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME "standard::edit-name"           /* string */
 127
 128 /**
 129  * G_FILE_ATTRIBUTE_STANDARD_COPY_NAME:
 130  *
 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.
 137  *
 138  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
 139  **/
 140 #define G_FILE_ATTRIBUTE_STANDARD_COPY_NAME "standard::copy-name"           /* string */
 141
 142 /**
 143  * G_FILE_ATTRIBUTE_STANDARD_DESCRIPTION:
 144  *
 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.
 151  *
 152  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
 153  **/
 154 #define G_FILE_ATTRIBUTE_STANDARD_DESCRIPTION "standard::description"        /* string */
 155
 156 /**
 157  * G_FILE_ATTRIBUTE_STANDARD_ICON:
 158  *
 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.
 162  **/
 163 #define G_FILE_ATTRIBUTE_STANDARD_ICON "standard::icon"                     /* object (GIcon) */
 164
 165 /**
 166  * G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE:
 167  *
 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.
 171  **/
 172 #define G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE "standard::content-type"     /* string */
 173
 174 /**
 175  * G_FILE_ATTRIBUTE_STANDARD_FAST_CONTENT_TYPE:
 176  *
 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.
 182  *
 183  **/
 184 #define G_FILE_ATTRIBUTE_STANDARD_FAST_CONTENT_TYPE "standard::fast-content-type" /* string */
 185
 186 /**
 187  * G_FILE_ATTRIBUTE_STANDARD_SIZE:
 188  *
 189  * A key in the "standard" namespace for getting the file's size (in bytes).
 190  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64.
 191  **/
 192 #define G_FILE_ATTRIBUTE_STANDARD_SIZE "standard::size"                     /* uint64 */
 193
 194 /**
 195  * G_FILE_ATTRIBUTE_ALLOCATED_SIZE:
 196  *
 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  *
 202  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64.
 203  **/
 204 #define G_FILE_ATTRIBUTE_STANDARD_ALLOCATED_SIZE "standard::allocated-size" /* uint64 */
 205
 206 /**
 207  * G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET:
 208  *
 209  * A key in the "standard" namespace for getting the symlink target, if the file
 210  * is a symlink. Corresponding #GFileAttributeType is
 211  * %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING.
 212  **/
 213 #define G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET "standard::symlink-target" /* byte string */
 214
 215 /**
 216  * G_FILE_ATTRIBUTE_STANDARD_TARGET_URI:
 217  *
 218  * A key in the "standard" namespace for getting the target URI for the file, in
 219  * the case of %G_FILE_TYPE_SHORTCUT or %G_FILE_TYPE_MOUNTABLE files.
 220  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
 221  **/
 222 #define G_FILE_ATTRIBUTE_STANDARD_TARGET_URI "standard::target-uri"         /* string */
 223
 224 /**
 225  * G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER:
 226  *
 227  * A key in the "standard" namespace for setting the sort order of a file.
 228  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_INT32.
 229  * An example use would be in file managers, which would use this key
 230  * to set the order files are displayed. Files with smaller sort order
 231  * should be sorted first, and files without sort order as if sort order
 232  * was zero.
 233  **/
 234 #define G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER "standard::sort-order"         /* int32  */
 235
 236 /* Entity tags, used to avoid missing updates on save */
 237
 238 /**
 239  * G_FILE_ATTRIBUTE_ETAG_VALUE:
 240  *
 241  * A key in the "etag" namespace for getting the value of the file's
 242  * entity tag. Corresponding #GFileAttributeType is
 243  * %G_FILE_ATTRIBUTE_TYPE_STRING.
 244  **/
 245 #define G_FILE_ATTRIBUTE_ETAG_VALUE "etag::value"                 /* string */
 246
 247 /* File identifier, for e.g. avoiding loops when doing recursive
 248  * directory scanning
 249  */
 250
 251 /**
 252  * G_FILE_ATTRIBUTE_ID_FILE:
 253  *
 254  * A key in the "id" namespace for getting a file identifier.
 255  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
 256  * An example use would be during listing files, to avoid recursive
 257  * directory scanning.
 258  **/
 259 #define G_FILE_ATTRIBUTE_ID_FILE "id::file"                     /* string */
 260
 261 /**
 262  * G_FILE_ATTRIBUTE_ID_FILESYSTEM:
 263  *
 264  * A key in the "id" namespace for getting the file system identifier.
 265  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
 266  * An example use would be during drag and drop to see if the source
 267  * and target are on the same filesystem (default to move) or not (default
 268  * to copy).
 269  **/
 270 #define G_FILE_ATTRIBUTE_ID_FILESYSTEM "id::filesystem"         /* string */
 271
 272 /* Calculated Access Rights for current user */
 273
 274 /**
 275  * G_FILE_ATTRIBUTE_ACCESS_CAN_READ:
 276  *
 277  * A key in the "access" namespace for getting read privileges.
 278  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
 279  * This attribute will be %TRUE if the user is able to read the file.
 280  **/
 281 #define G_FILE_ATTRIBUTE_ACCESS_CAN_READ "access::can-read"       /* boolean */
 282
 283 /**
 284  * G_FILE_ATTRIBUTE_ACCESS_CAN_WRITE:
 285  *
 286  * A key in the "access" namespace for getting write privileges.
 287  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
 288  * This attribute will be %TRUE if the user is able to write to the file.
 289  **/
 290 #define G_FILE_ATTRIBUTE_ACCESS_CAN_WRITE "access::can-write"     /* boolean */
 291
 292 /**
 293  * G_FILE_ATTRIBUTE_ACCESS_CAN_EXECUTE:
 294  *
 295  * A key in the "access" namespace for getting execution privileges.
 296  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
 297  * This attribute will be %TRUE if the user is able to execute the file.
 298  **/
 299 #define G_FILE_ATTRIBUTE_ACCESS_CAN_EXECUTE "access::can-execute" /* boolean */
 300
 301 /**
 302  * G_FILE_ATTRIBUTE_ACCESS_CAN_DELETE:
 303  *
 304  * A key in the "access" namespace for checking deletion privileges.
 305  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
 306  * This attribute will be %TRUE if the user is able to delete the file.
 307  **/
 308 #define G_FILE_ATTRIBUTE_ACCESS_CAN_DELETE "access::can-delete"   /* boolean */
 309
 310 /**
 311  * G_FILE_ATTRIBUTE_ACCESS_CAN_TRASH:
 312  *
 313  * A key in the "access" namespace for checking trashing privileges.
 314  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
 315  * This attribute will be %TRUE if the user is able to move the file to
 316  * the trash.
 317  **/
 318 #define G_FILE_ATTRIBUTE_ACCESS_CAN_TRASH "access::can-trash"     /* boolean */
 319
 320 /**
 321  * G_FILE_ATTRIBUTE_ACCESS_CAN_RENAME:
 322  *
 323  * A key in the "access" namespace for checking renaming privileges.
 324  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
 325  * This attribute will be %TRUE if the user is able to rename the file.
 326  **/
 327 #define G_FILE_ATTRIBUTE_ACCESS_CAN_RENAME "access::can-rename"   /* boolean */
 328
 329 /* TODO: Should we have special version for directories? can_enumerate, etc */
 330
 331 /* Mountable attributes */
 332
 333 /**
 334  * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_MOUNT:
 335  *
 336  * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) is mountable.
 337  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
 338  **/
 339 #define G_FILE_ATTRIBUTE_MOUNTABLE_CAN_MOUNT "mountable::can-mount"     /* boolean */
 340
 341 /**
 342  * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_UNMOUNT:
 343  *
 344  * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE)  is unmountable.
 345  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
 346  **/
 347 #define G_FILE_ATTRIBUTE_MOUNTABLE_CAN_UNMOUNT "mountable::can-unmount" /* boolean */
 348
 349 /**
 350  * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_EJECT:
 351  *
 352  * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be ejected.
 353  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
 354  **/
 355 #define G_FILE_ATTRIBUTE_MOUNTABLE_CAN_EJECT "mountable::can-eject"     /* boolean */
 356
 357 /**
 358  * G_FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE:
 359  *
 360  * A key in the "mountable" namespace for getting the unix device.
 361  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
 362  **/
 363 #define G_FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE "mountable::unix-device" /* uint32 */
 364
 365 /**
 366  * G_FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE_FILE:
 367  *
 368  * A key in the "mountable" namespace for getting the unix device file.
 369  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
 370  *
 371  * Since: 2.22.
 372  **/
 373 #define G_FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE_FILE "mountable::unix-device-file" /* string */
 374
 375 /**
 376  * G_FILE_ATTRIBUTE_MOUNTABLE_HAL_UDI:
 377  *
 378  * A key in the "mountable" namespace for getting the HAL UDI for the mountable
 379  * file. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
 380  **/
 381 #define G_FILE_ATTRIBUTE_MOUNTABLE_HAL_UDI "mountable::hal-udi"         /* string */
 382
 383 /**
 384  * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_START:
 385  *
 386  * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be started.
 387  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
 388  *
 389  * Since: 2.22
 390  */
 391 #define G_FILE_ATTRIBUTE_MOUNTABLE_CAN_START "mountable::can-start"     /* boolean */
 392
 393 /**
 394  * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_START_DEGRADED:
 395  *
 396  * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be started
 397  * degraded.
 398  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
 399  *
 400  * Since: 2.22
 401  */
 402 #define G_FILE_ATTRIBUTE_MOUNTABLE_CAN_START_DEGRADED "mountable::can-start-degraded"     /* boolean */
 403
 404 /**
 405  * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_STOP:
 406  *
 407  * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be stopped.
 408  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
 409  *
 410  * Since: 2.22
 411  */
 412 #define G_FILE_ATTRIBUTE_MOUNTABLE_CAN_STOP "mountable::can-stop"      /* boolean */
 413
 414 /**
 415  * G_FILE_ATTRIBUTE_MOUNTABLE_START_STOP_TYPE:
 416  *
 417  * A key in the "mountable" namespace for getting the #GDriveStartStopType.
 418  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
 419  *
 420  * Since: 2.22
 421  */
 422 #define G_FILE_ATTRIBUTE_MOUNTABLE_START_STOP_TYPE "mountable::start-stop-type" /* uint32 (GDriveStartStopType) */
 423
 424 /**
 425  * G_FILE_ATTRIBUTE_MOUNTABLE_CAN_POLL:
 426  *
 427  * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be polled.
 428  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
 429  *
 430  * Since: 2.22
 431  */
 432 #define G_FILE_ATTRIBUTE_MOUNTABLE_CAN_POLL "mountable::can-poll"      /* boolean */
 433
 434 /**
 435  * G_FILE_ATTRIBUTE_MOUNTABLE_IS_MEDIA_CHECK_AUTOMATIC:
 436  *
 437  * A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE)
 438  * is automatically polled for media.
 439  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
 440  *
 441  * Since: 2.22
 442  */
 443 #define G_FILE_ATTRIBUTE_MOUNTABLE_IS_MEDIA_CHECK_AUTOMATIC "mountable::is-media-check-automatic"      /* boolean */
 444
 445 /* Time attributes */
 446
 447 /**
 448  * G_FILE_ATTRIBUTE_TIME_MODIFIED:
 449  *
 450  * A key in the "time" namespace for getting the time the file was last
 451  * modified. Corresponding #GFileAttributeType is
 452  * %G_FILE_ATTRIBUTE_TYPE_UINT64, and contains the UNIX time since the
 453  * file was modified.
 454  **/
 455 #define G_FILE_ATTRIBUTE_TIME_MODIFIED "time::modified"           /* uint64 */
 456
 457 /**
 458  * G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC:
 459  *
 460  * A key in the "time" namespace for getting the miliseconds of the time
 461  * the file was last modified. This should be used in conjunction with
 462  * #G_FILE_ATTRIBUTE_TIME_MODIFIED. Corresponding #GFileAttributeType is
 463  * %G_FILE_ATTRIBUTE_TYPE_UINT32.
 464  **/
 465 #define G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC "time::modified-usec" /* uint32 */
 466
 467 /**
 468  * G_FILE_ATTRIBUTE_TIME_ACCESS:
 469  *
 470  * A key in the "time" namespace for getting the time the file was last
 471  * accessed. Corresponding #GFileAttributeType is
 472  * %G_FILE_ATTRIBUTE_TYPE_UINT64, and contains the UNIX time since the
 473  * file was last accessed.
 474  **/
 475 #define G_FILE_ATTRIBUTE_TIME_ACCESS "time::access"               /* uint64 */
 476
 477 /**
 478  * G_FILE_ATTRIBUTE_TIME_ACCESS_USEC:
 479  *
 480  * A key in the "time" namespace for getting the microseconds of the time
 481  * the file was last accessed. This should be used in conjunction with
 482  * #G_FILE_ATTRIBUTE_TIME_ACCESS. Corresponding #GFileAttributeType is
 483  * %G_FILE_ATTRIBUTE_TYPE_UINT32.
 484  **/
 485 #define G_FILE_ATTRIBUTE_TIME_ACCESS_USEC "time::access-usec"     /* uint32 */
 486
 487 /**
 488  * G_FILE_ATTRIBUTE_TIME_CHANGED:
 489  *
 490  * A key in the "time" namespace for getting the time the file was last
 491  * changed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64,
 492  * and contains the UNIX time since the file was last changed.
 493  *
 494  * This corresponds to the traditional UNIX ctime.
 495  **/
 496 #define G_FILE_ATTRIBUTE_TIME_CHANGED "time::changed"             /* uint64 */
 497
 498 /**
 499  * G_FILE_ATTRIBUTE_TIME_CHANGED_USEC:
 500  *
 501  * A key in the "time" namespace for getting the microseconds of the time
 502  * the file was last changed. This should be used in conjunction with
 503  * #G_FILE_ATTRIBUTE_TIME_CHANGED. Corresponding #GFileAttributeType is
 504  * %G_FILE_ATTRIBUTE_TYPE_UINT32.
 505  **/
 506 #define G_FILE_ATTRIBUTE_TIME_CHANGED_USEC "time::changed-usec"   /* uint32 */
 507
 508 /**
 509  * G_FILE_ATTRIBUTE_TIME_CREATED:
 510  *
 511  * A key in the "time" namespace for getting the time the file was created.
 512  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64,
 513  * and contains the UNIX time since the file was created.
 514  *
 515  * This corresponds to the NTFS ctime.
 516  **/
 517 #define G_FILE_ATTRIBUTE_TIME_CREATED "time::created"             /* uint64 */
 518
 519 /**
 520  * G_FILE_ATTRIBUTE_TIME_CREATED_USEC:
 521  *
 522  * A key in the "time" namespace for getting the microseconds of the time
 523  * the file was created. This should be used in conjunction with
 524  * #G_FILE_ATTRIBUTE_TIME_CREATED. Corresponding #GFileAttributeType is
 525  * %G_FILE_ATTRIBUTE_TYPE_UINT32.
 526  **/
 527 #define G_FILE_ATTRIBUTE_TIME_CREATED_USEC "time::created-usec"   /* uint32 */
 528
 529 /* Unix specific attributes */
 530
 531 /**
 532  * G_FILE_ATTRIBUTE_UNIX_DEVICE:
 533  *
 534  * A key in the "unix" namespace for getting the device id of the device the
 535  * file is located on (see stat() documentation). This attribute is only
 536  * available for UNIX file systems. Corresponding #GFileAttributeType is
 537  * %G_FILE_ATTRIBUTE_TYPE_UINT32.
 538  **/
 539 #define G_FILE_ATTRIBUTE_UNIX_DEVICE "unix::device"               /* uint32 */
 540
 541 /**
 542  * G_FILE_ATTRIBUTE_UNIX_INODE:
 543  *
 544  * A key in the "unix" namespace for getting the inode of the file.
 545  * This attribute is only available for UNIX file systems. Corresponding
 546  * #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64.
 547  **/
 548 #define G_FILE_ATTRIBUTE_UNIX_INODE "unix::inode"                 /* uint64 */
 549
 550 /**
 551  * G_FILE_ATTRIBUTE_UNIX_MODE:
 552  *
 553  * A key in the "unix" namespace for getting the mode of the file
 554  * (e.g. whether the file is a regular file, symlink, etc). See lstat()
 555  * documentation. This attribute is only available for UNIX file systems.
 556  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
 557  **/
 558 #define G_FILE_ATTRIBUTE_UNIX_MODE "unix::mode"                   /* uint32 */
 559
 560 /**
 561  * G_FILE_ATTRIBUTE_UNIX_NLINK:
 562  *
 563  * A key in the "unix" namespace for getting the number of hard links
 564  * for a file. See lstat() documentation. This attribute is only available
 565  * for UNIX file systems. Corresponding #GFileAttributeType is
 566  * %G_FILE_ATTRIBUTE_TYPE_UINT32.
 567  **/
 568 #define G_FILE_ATTRIBUTE_UNIX_NLINK "unix::nlink"                 /* uint32 */
 569
 570 /**
 571  * G_FILE_ATTRIBUTE_UNIX_UID:
 572  *
 573  * A key in the "unix" namespace for getting the user ID for the file.
 574  * This attribute is only available for UNIX file systems.
 575  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
 576  **/
 577 #define G_FILE_ATTRIBUTE_UNIX_UID "unix::uid"                     /* uint32 */
 578
 579 /**
 580  * G_FILE_ATTRIBUTE_UNIX_GID:
 581  *
 582  * A key in the "unix" namespace for getting the group ID for the file.
 583  * This attribute is only available for UNIX file systems.
 584  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
 585  **/
 586 #define G_FILE_ATTRIBUTE_UNIX_GID "unix::gid"                     /* uint32 */
 587
 588 /**
 589  * G_FILE_ATTRIBUTE_UNIX_RDEV:
 590  *
 591  * A key in the "unix" namespace for getting the device ID for the file
 592  * (if it is a special file). See lstat() documentation. This attribute
 593  * is only available for UNIX file systems. Corresponding #GFileAttributeType
 594  * is %G_FILE_ATTRIBUTE_TYPE_UINT32.
 595  **/
 596 #define G_FILE_ATTRIBUTE_UNIX_RDEV "unix::rdev"                   /* uint32 */
 597
 598 /**
 599  * G_FILE_ATTRIBUTE_UNIX_BLOCK_SIZE:
 600  *
 601  * A key in the "unix" namespace for getting the block size for the file
 602  * system. This attribute is only available for UNIX file systems.
 603  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
 604  **/
 605 #define G_FILE_ATTRIBUTE_UNIX_BLOCK_SIZE "unix::block-size"       /* uint32 */
 606
 607 /**
 608  * G_FILE_ATTRIBUTE_UNIX_BLOCKS:
 609  *
 610  * A key in the "unix" namespace for getting the number of blocks allocated
 611  * for the file. This attribute is only available for UNIX file systems.
 612  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64.
 613  **/
 614 #define G_FILE_ATTRIBUTE_UNIX_BLOCKS "unix::blocks"               /* uint64 */
 615
 616 /**
 617  * G_FILE_ATTRIBUTE_UNIX_IS_MOUNTPOINT:
 618  *
 619  * A key in the "unix" namespace for checking if the file represents a
 620  * UNIX mount point. This attribute is %TRUE if the file is a UNIX mount
 621  * point. This attribute is only available for UNIX file systems.
 622  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
 623  **/
 624 #define G_FILE_ATTRIBUTE_UNIX_IS_MOUNTPOINT "unix::is-mountpoint" /* boolean */
 625
 626 /* DOS specific attributes */
 627
 628 /**
 629  * G_FILE_ATTRIBUTE_DOS_IS_ARCHIVE:
 630  *
 631  * A key in the "dos" namespace for checking if the file's archive flag
 632  * is set. This attribute is %TRUE if the archive flag is set. This attribute
 633  * is only available for DOS file systems. Corresponding #GFileAttributeType
 634  * is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
 635  **/
 636 #define G_FILE_ATTRIBUTE_DOS_IS_ARCHIVE "dos::is-archive"         /* boolean */
 637
 638 /**
 639  * G_FILE_ATTRIBUTE_DOS_IS_SYSTEM:
 640  *
 641  * A key in the "dos" namespace for checking if the file's backup flag
 642  * is set. This attribute is %TRUE if the backup flag is set. This attribute
 643  * is only available for DOS file systems. Corresponding #GFileAttributeType
 644  * is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
 645  **/
 646 #define G_FILE_ATTRIBUTE_DOS_IS_SYSTEM "dos::is-system"           /* boolean */
 647
 648 /* Owner attributes */
 649
 650 /**
 651  * G_FILE_ATTRIBUTE_OWNER_USER:
 652  *
 653  * A key in the "owner" namespace for getting the user name of the
 654  * file's owner. Corresponding #GFileAttributeType is
 655  * %G_FILE_ATTRIBUTE_TYPE_STRING.
 656  **/
 657 #define G_FILE_ATTRIBUTE_OWNER_USER "owner::user"                 /* string */
 658
 659 /**
 660  * G_FILE_ATTRIBUTE_OWNER_USER_REAL:
 661  *
 662  * A key in the "owner" namespace for getting the real name of the
 663  * user that owns the file. Corresponding #GFileAttributeType is
 664  * %G_FILE_ATTRIBUTE_TYPE_STRING.
 665  **/
 666 #define G_FILE_ATTRIBUTE_OWNER_USER_REAL "owner::user-real"       /* string */
 667
 668 /**
 669  * G_FILE_ATTRIBUTE_OWNER_GROUP:
 670  *
 671  * A key in the "owner" namespace for getting the file owner's group.
 672  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
 673  **/
 674 #define G_FILE_ATTRIBUTE_OWNER_GROUP "owner::group"               /* string */
 675
 676 /* Thumbnails */
 677
 678 /**
 679  * G_FILE_ATTRIBUTE_THUMBNAIL_PATH:
 680  *
 681  * A key in the "thumbnail" namespace for getting the path to the thumbnail
 682  * image. Corresponding #GFileAttributeType is
 683  * %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING.
 684  **/
 685 #define G_FILE_ATTRIBUTE_THUMBNAIL_PATH "thumbnail::path"         /* bytestring */
 686 /**
 687  * G_FILE_ATTRIBUTE_THUMBNAILING_FAILED:
 688  *
 689  * A key in the "thumbnail" namespace for checking if thumbnailing failed.
 690  * This attribute is %TRUE if thumbnailing failed. Corresponding
 691  * #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
 692  **/
 693 #define G_FILE_ATTRIBUTE_THUMBNAILING_FAILED "thumbnail::failed"         /* boolean */
 694
 695 /* Preview */
 696
 697 /**
 698  * G_FILE_ATTRIBUTE_PREVIEW_ICON:
 699  *
 700  * A key in the "preview" namespace for getting a #GIcon that can be
 701  * used to get preview of the file. For example, it may be a low
 702  * resolution thumbnail without metadata. Corresponding
 703  * #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_OBJECT.  The value
 704  * for this key should contain a #GIcon.
 705  *
 706  * Since: 2.20
 707  **/
 708 #define G_FILE_ATTRIBUTE_PREVIEW_ICON "preview::icon"         /* object (GIcon) */
 709
 710 /* File system info (for g_file_get_filesystem_info) */
 711
 712 /**
 713  * G_FILE_ATTRIBUTE_FILESYSTEM_SIZE:
 714  *
 715  * A key in the "filesystem" namespace for getting the total size (in bytes) of the file system,
 716  * used in g_file_query_filesystem_info(). Corresponding #GFileAttributeType
 717  * is %G_FILE_ATTRIBUTE_TYPE_UINT64.
 718  **/
 719 #define G_FILE_ATTRIBUTE_FILESYSTEM_SIZE "filesystem::size"                       /* uint64 */
 720
 721 /**
 722  * G_FILE_ATTRIBUTE_FILESYSTEM_FREE:
 723  *
 724  * A key in the "filesystem" namespace for getting the number of bytes of free space left on the
 725  * file system. Corresponding #GFileAttributeType is
 726  * %G_FILE_ATTRIBUTE_TYPE_UINT64.
 727  **/
 728 #define G_FILE_ATTRIBUTE_FILESYSTEM_FREE "filesystem::free"                       /* uint64 */
 729
 730 /**
 731  * G_FILE_ATTRIBUTE_FILESYSTEM_TYPE:
 732  *
 733  * A key in the "filesystem" namespace for getting the file system's type.
 734  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING.
 735  **/
 736 #define G_FILE_ATTRIBUTE_FILESYSTEM_TYPE "filesystem::type"                       /* string */
 737
 738 /**
 739  * G_FILE_ATTRIBUTE_FILESYSTEM_READONLY:
 740  *
 741  * A key in the "filesystem" namespace for checking if the file system
 742  * is read only. Is set to %TRUE if the file system is read only.
 743  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
 744  **/
 745 #define G_FILE_ATTRIBUTE_FILESYSTEM_READONLY "filesystem::readonly"               /* boolean */
 746
 747 /**
 748  * G_FILE_ATTRIBUTE_FILESYSTEM_USE_PREVIEW:
 749  *
 750  * A key in the "filesystem" namespace for hinting a file manager
 751  * application whether it should preview (e.g. thumbnail) files on the
 752  * file system. The value for this key contain a
 753  * #GFilesystemPreviewType.
 754  **/
 755 #define G_FILE_ATTRIBUTE_FILESYSTEM_USE_PREVIEW "filesystem::use-preview"        /* uint32 (GFilesystemPreviewType) */
 756
 757 /**
 758  * G_FILE_ATTRIBUTE_GVFS_BACKEND:
 759  *
 760  * A key in the "gvfs" namespace that gets the name of the current
 761  * GVFS backend in use. Corresponding #GFileAttributeType is
 762  * %G_FILE_ATTRIBUTE_TYPE_STRING.
 763  **/
 764 #define G_FILE_ATTRIBUTE_GVFS_BACKEND "gvfs::backend"             /* string */
 765
 766 /**
 767  * G_FILE_ATTRIBUTE_SELINUX_CONTEXT:
 768  *
 769  * A key in the "selinux" namespace for getting the file's SELinux
 770  * context. Corresponding #GFileAttributeType is
 771  * %G_FILE_ATTRIBUTE_TYPE_STRING. Note that this attribute is only
 772  * available if GLib has been built with SELinux support.
 773  **/
 774 #define G_FILE_ATTRIBUTE_SELINUX_CONTEXT "selinux::context"       /* string */
 775
 776 /**
 777  * G_FILE_ATTRIBUTE_TRASH_ITEM_COUNT:
 778  *
 779  * A key in the "trash" namespace.  When requested against
 780  * "trash:///" returns the number of (toplevel) items in the trash folder.
 781  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
 782  **/
 783 #define G_FILE_ATTRIBUTE_TRASH_ITEM_COUNT "trash::item-count"     /* uint32 */
 784
 785 GType              g_file_info_get_type                  (void) G_GNUC_CONST;
 786
 787 GFileInfo *        g_file_info_new                       (void);
 788 GFileInfo *        g_file_info_dup                       (GFileInfo  *other);
 789 void               g_file_info_copy_into                 (GFileInfo  *src_info,
 790                                                           GFileInfo  *dest_info);
 791 gboolean           g_file_info_has_attribute             (GFileInfo  *info,
 792                                                           const char *attribute);
 793 gboolean           g_file_info_has_namespace             (GFileInfo  *info,
 794                                                           const char *name_space);
 795 char **            g_file_info_list_attributes           (GFileInfo  *info,
 796                                                           const char *name_space);
 797 gboolean           g_file_info_get_attribute_data        (GFileInfo  *info,
 798                                                           const char *attribute,
 799                                                           GFileAttributeType *type,
 800                                                           gpointer   *value_pp,
 801                                                           GFileAttributeStatus *status);
 802 GFileAttributeType g_file_info_get_attribute_type        (GFileInfo  *info,
 803                                                           const char *attribute);
 804 void               g_file_info_remove_attribute          (GFileInfo  *info,
 805                                                           const char *attribute);
 806 GFileAttributeStatus g_file_info_get_attribute_status    (GFileInfo  *info,
 807                                                           const char *attribute);
 808 gboolean           g_file_info_set_attribute_status      (GFileInfo  *info,
 809                                                           const char *attribute,
 810                                                           GFileAttributeStatus status);
 811 char *             g_file_info_get_attribute_as_string   (GFileInfo  *info,
 812                                                           const char *attribute);
 813 const char *       g_file_info_get_attribute_string      (GFileInfo  *info,
 814                                                           const char *attribute);
 815 const char *       g_file_info_get_attribute_byte_string (GFileInfo  *info,
 816                                                           const char *attribute);
 817 gboolean           g_file_info_get_attribute_boolean     (GFileInfo  *info,
 818                                                           const char *attribute);
 819 guint32            g_file_info_get_attribute_uint32      (GFileInfo  *info,
 820                                                           const char *attribute);
 821 gint32             g_file_info_get_attribute_int32       (GFileInfo  *info,
 822                                                           const char *attribute);
 823 guint64            g_file_info_get_attribute_uint64      (GFileInfo  *info,
 824                                                           const char *attribute);
 825 gint64             g_file_info_get_attribute_int64       (GFileInfo  *info,
 826                                                           const char *attribute);
 827 GObject *          g_file_info_get_attribute_object      (GFileInfo  *info,
 828                                                           const char *attribute);
 829 char **            g_file_info_get_attribute_stringv     (GFileInfo  *info,
 830                                                           const char *attribute);
 831
 832 void               g_file_info_set_attribute             (GFileInfo  *info,
 833                                                           const char *attribute,
 834                                                           GFileAttributeType type,
 835                                                           gpointer    value_p);
 836 void               g_file_info_set_attribute_string      (GFileInfo  *info,
 837                                                           const char *attribute,
 838                                                           const char *attr_value);
 839 void               g_file_info_set_attribute_byte_string (GFileInfo  *info,
 840                                                           const char *attribute,
 841                                                           const char *attr_value);
 842 void               g_file_info_set_attribute_boolean     (GFileInfo  *info,
 843                                                           const char *attribute,
 844                                                           gboolean    attr_value);
 845 void               g_file_info_set_attribute_uint32      (GFileInfo  *info,
 846                                                           const char *attribute,
 847                                                           guint32     attr_value);
 848 void               g_file_info_set_attribute_int32       (GFileInfo  *info,
 849                                                           const char *attribute,
 850                                                           gint32      attr_value);
 851 void               g_file_info_set_attribute_uint64      (GFileInfo  *info,
 852                                                           const char *attribute,
 853                                                           guint64     attr_value);
 854 void               g_file_info_set_attribute_int64       (GFileInfo  *info,
 855                                                           const char *attribute,
 856                                                           gint64      attr_value);
 857 void               g_file_info_set_attribute_object      (GFileInfo  *info,
 858                                                           const char *attribute,
 859                                                           GObject    *attr_value);
 860 void               g_file_info_set_attribute_stringv     (GFileInfo  *info,
 861                                                           const char *attribute,
 862                                                           char      **attr_value);
 863
 864 void               g_file_info_clear_status              (GFileInfo  *info);
 865
 866 /* Helper getters: */
 867 GFileType         g_file_info_get_file_type          (GFileInfo         *info);
 868 gboolean          g_file_info_get_is_hidden          (GFileInfo         *info);
 869 gboolean          g_file_info_get_is_backup          (GFileInfo         *info);
 870 gboolean          g_file_info_get_is_symlink         (GFileInfo         *info);
 871 const char *      g_file_info_get_name               (GFileInfo         *info);
 872 const char *      g_file_info_get_display_name       (GFileInfo         *info);
 873 const char *      g_file_info_get_edit_name          (GFileInfo         *info);
 874 GIcon *           g_file_info_get_icon               (GFileInfo         *info);
 875 const char *      g_file_info_get_content_type       (GFileInfo         *info);
 876 goffset           g_file_info_get_size               (GFileInfo         *info);
 877 void              g_file_info_get_modification_time  (GFileInfo         *info,
 878                                                       GTimeVal          *result);
 879 const char *      g_file_info_get_symlink_target     (GFileInfo         *info);
 880 const char *      g_file_info_get_etag               (GFileInfo         *info);
 881 gint32            g_file_info_get_sort_order         (GFileInfo         *info);
 882
 883 void              g_file_info_set_attribute_mask     (GFileInfo         *info,
 884                                                       GFileAttributeMatcher *mask);
 885 void              g_file_info_unset_attribute_mask   (GFileInfo         *info);
 886
 887 /* Helper setters: */
 888 void              g_file_info_set_file_type          (GFileInfo         *info,
 889                                                       GFileType          type);
 890 void              g_file_info_set_is_hidden          (GFileInfo         *info,
 891                                                       gboolean           is_hidden);
 892 void              g_file_info_set_is_symlink         (GFileInfo         *info,
 893                                                       gboolean           is_symlink);
 894 void              g_file_info_set_name               (GFileInfo         *info,
 895                                                       const char        *name);
 896 void              g_file_info_set_display_name       (GFileInfo         *info,
 897                                                       const char        *display_name);
 898 void              g_file_info_set_edit_name          (GFileInfo         *info,
 899                                                       const char        *edit_name);
 900 void              g_file_info_set_icon               (GFileInfo         *info,
 901                                                       GIcon             *icon);
 902 void              g_file_info_set_content_type       (GFileInfo         *info,
 903                                                       const char        *content_type);
 904 void              g_file_info_set_size               (GFileInfo         *info,
 905                                                       goffset            size);
 906 void              g_file_info_set_modification_time  (GFileInfo         *info,
 907                                                       GTimeVal          *mtime);
 908 void              g_file_info_set_symlink_target     (GFileInfo         *info,
 909                                                       const char        *symlink_target);
 910 void              g_file_info_set_sort_order         (GFileInfo         *info,
 911                                                       gint32             sort_order);
 912
 913 GFileAttributeMatcher *g_file_attribute_matcher_new            (const char            *attributes);
 914 GFileAttributeMatcher *g_file_attribute_matcher_ref            (GFileAttributeMatcher *matcher);
 915 void                   g_file_attribute_matcher_unref          (GFileAttributeMatcher *matcher);
 916 gboolean               g_file_attribute_matcher_matches        (GFileAttributeMatcher *matcher,
 917                                                                 const char            *attribute);
 918 gboolean               g_file_attribute_matcher_matches_only   (GFileAttributeMatcher *matcher,
 919                                                                 const char            *attribute);
 920 gboolean               g_file_attribute_matcher_enumerate_namespace (GFileAttributeMatcher *matcher,
 921                                                                      const char            *ns);
 922 const char *           g_file_attribute_matcher_enumerate_next (GFileAttributeMatcher *matcher);
 923
 924 G_END_DECLS
 925
 926 #endif /* __G_FILE_INFO_H__ */