glib/gio/gfileinfo.h
Alexander Larsson 3781343738 gio/ docs/reference/gio Merged gio-standalone into glib.
2007-11-26  Alexander Larsson  <alexl@redhat.com>

        * Makefile.am:
        * configure.in:
        * gio-2.0-uninstalled.pc.in:
        * gio-2.0.pc.in: 
        * gio-unix-2.0-uninstalled.pc.in:
        * gio-unix-2.0.pc.in:
	* gio/
	* docs/reference/gio
	Merged gio-standalone into glib.
	
        * glib/glibintl.h:
        * glib/gutils.c:
	Export glib_gettext so that gio can use it
	Add P_ (using same domain for now)
	Add I_ as g_intern_static_string


svn path=/trunk/; revision=5941
2007-11-26 16:13:05 +00:00

281 lines
14 KiB
C

/* GIO - GLib Input, Output and Streaming Library
*
* Copyright (C) 2006-2007 Red Hat, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307, USA.
*
* Author: Alexander Larsson <alexl@redhat.com>
*/
#ifndef __G_FILE_INFO_H__
#define __G_FILE_INFO_H__
#include <glib-object.h>
#include <gio/gfileattribute.h>
#include <gio/gicon.h>
G_BEGIN_DECLS
#define G_TYPE_FILE_INFO (g_file_info_get_type ())
#define G_FILE_INFO(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_INFO, GFileInfo))
#define G_FILE_INFO_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_INFO, GFileInfoClass))
#define G_IS_FILE_INFO(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_INFO))
#define G_IS_FILE_INFO_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_INFO))
#define G_FILE_INFO_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_INFO, GFileInfoClass))
typedef struct _GFileInfo GFileInfo;
typedef struct _GFileInfoClass GFileInfoClass;
typedef struct _GFileAttributeMatcher GFileAttributeMatcher;
typedef enum {
G_FILE_TYPE_UNKNOWN = 0,
G_FILE_TYPE_REGULAR,
G_FILE_TYPE_DIRECTORY,
G_FILE_TYPE_SYMBOLIC_LINK,
G_FILE_TYPE_SPECIAL, /* socket, fifo, blockdev, chardev */
G_FILE_TYPE_SHORTCUT,
G_FILE_TYPE_MOUNTABLE
} GFileType;
/* Common Attributes: */
#define G_FILE_ATTRIBUTE_STD_TYPE "std:type" /* uint32 (GFileType) */
#define G_FILE_ATTRIBUTE_STD_IS_HIDDEN "std:is_hidden" /* boolean */
#define G_FILE_ATTRIBUTE_STD_IS_BACKUP "std:is_backup" /* boolean */
#define G_FILE_ATTRIBUTE_STD_IS_SYMLINK "std:is_symlink" /* boolean */
#define G_FILE_ATTRIBUTE_STD_IS_VIRTUAL "std:is_virtual" /* boolean */
#define G_FILE_ATTRIBUTE_STD_NAME "std:name" /* byte string */
#define G_FILE_ATTRIBUTE_STD_DISPLAY_NAME "std:display_name" /* string */
#define G_FILE_ATTRIBUTE_STD_EDIT_NAME "std:edit_name" /* string */
#define G_FILE_ATTRIBUTE_STD_COPY_NAME "std:copy_name" /* string */
#define G_FILE_ATTRIBUTE_STD_ICON "std:icon" /* object (GIcon) */
#define G_FILE_ATTRIBUTE_STD_CONTENT_TYPE "std:content_type" /* string */
#define G_FILE_ATTRIBUTE_STD_FAST_CONTENT_TYPE "std:fast_content_type" /* string */
#define G_FILE_ATTRIBUTE_STD_SIZE "std:size" /* uint64 */
#define G_FILE_ATTRIBUTE_STD_SYMLINK_TARGET "std:symlink_target" /* byte string */
#define G_FILE_ATTRIBUTE_STD_TARGET_URI "std:target_uri" /* string */
#define G_FILE_ATTRIBUTE_STD_SORT_ORDER "std:sort_order" /* int32 */
/* Entity tags, used to avoid missing updates on save */
#define G_FILE_ATTRIBUTE_ETAG_VALUE "etag:value" /* string */
/* File identifier, for e.g. avoiding loops when doing recursive directory scanning */
#define G_FILE_ATTRIBUTE_ID_FILE "id:file" /* string */
#define G_FILE_ATTRIBUTE_ID_FS "id:fs" /* string */
/* Calculated Access Rights for current user */
#define G_FILE_ATTRIBUTE_ACCESS_CAN_READ "access:can_read" /* boolean */
#define G_FILE_ATTRIBUTE_ACCESS_CAN_WRITE "access:can_write" /* boolean */
#define G_FILE_ATTRIBUTE_ACCESS_CAN_EXECUTE "access:can_execute" /* boolean */
#define G_FILE_ATTRIBUTE_ACCESS_CAN_DELETE "access:can_delete" /* boolean */
#define G_FILE_ATTRIBUTE_ACCESS_CAN_TRASH "access:can_trash" /* boolean */
#define G_FILE_ATTRIBUTE_ACCESS_CAN_RENAME "access:can_rename" /* boolean */
/* TODO: Should we have special version for directories? can_enumerate, etc */
/* Mountable attributes */
#define G_FILE_ATTRIBUTE_MOUNTABLE_CAN_MOUNT "mountable:can_mount" /* boolean */
#define G_FILE_ATTRIBUTE_MOUNTABLE_CAN_UNMOUNT "mountable:can_unmount" /* boolean */
#define G_FILE_ATTRIBUTE_MOUNTABLE_CAN_EJECT "mountable:can_eject" /* boolean */
#define G_FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE "mountable:unix_device" /* uint32 */
#define G_FILE_ATTRIBUTE_MOUNTABLE_HAL_UDI "mountable:hal_udi" /* string */
/* Time attributes */
/* The last time the file content or an attribute was modified */
#define G_FILE_ATTRIBUTE_TIME_MODIFIED "time:modified" /* uint64 */
#define G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC "time:modified_usec" /* uint32 */
/* The last time the file was read */
#define G_FILE_ATTRIBUTE_TIME_ACCESS "time:access" /* uint64 */
#define G_FILE_ATTRIBUTE_TIME_ACCESS_USEC "time:access_usec" /* uint32 */
/* The last time a file attribute was changed (e.g. unix ctime) */
#define G_FILE_ATTRIBUTE_TIME_CHANGED "time:changed" /* uint64 */
#define G_FILE_ATTRIBUTE_TIME_CHANGED_USEC "time:changed_usec" /* uint32 */
/* When the file was originally created (e.g. ntfs ctime) */
#define G_FILE_ATTRIBUTE_TIME_CREATED "time:created" /* uint64 */
#define G_FILE_ATTRIBUTE_TIME_CREATED_USEC "time:created_usec" /* uint32 */
/* Unix specific attributes */
#define G_FILE_ATTRIBUTE_UNIX_DEVICE "unix:device" /* uint32 */
#define G_FILE_ATTRIBUTE_UNIX_INODE "unix:inode" /* uint64 */
#define G_FILE_ATTRIBUTE_UNIX_MODE "unix:mode" /* uint32 */
#define G_FILE_ATTRIBUTE_UNIX_NLINK "unix:nlink" /* uint32 */
#define G_FILE_ATTRIBUTE_UNIX_UID "unix:uid" /* uint32 */
#define G_FILE_ATTRIBUTE_UNIX_GID "unix:gid" /* uint32 */
#define G_FILE_ATTRIBUTE_UNIX_RDEV "unix:rdev" /* uint32 */
#define G_FILE_ATTRIBUTE_UNIX_BLOCK_SIZE "unix:block_size" /* uint32 */
#define G_FILE_ATTRIBUTE_UNIX_BLOCKS "unix:blocks" /* uint64 */
#define G_FILE_ATTRIBUTE_UNIX_IS_MOUNTPOINT "unix:is_mountpoint" /* boolean */
/* DOS specific attributes */
#define G_FILE_ATTRIBUTE_DOS_IS_ARCHIVE "dos:is_archive" /* boolean */
#define G_FILE_ATTRIBUTE_DOS_IS_SYSTEM "dos:is_system" /* boolean */
/* Owner attributes */
#define G_FILE_ATTRIBUTE_OWNER_USER "owner:user" /* string */
#define G_FILE_ATTRIBUTE_OWNER_USER_REAL "owner:user_real" /* string */
#define G_FILE_ATTRIBUTE_OWNER_GROUP "owner:group" /* string */
/* Thumbnails */
#define G_FILE_ATTRIBUTE_THUMBNAIL_PATH "thumbnail:path" /* bytestring */
#define G_FILE_ATTRIBUTE_THUMBNAILING_FAILED "thumbnail:failed" /* bytestring */
/* File system info (for g_file_get_filesystem_info) */
#define G_FILE_ATTRIBUTE_FS_SIZE "fs:size" /* uint64 */
#define G_FILE_ATTRIBUTE_FS_FREE "fs:free" /* uint64 */
#define G_FILE_ATTRIBUTE_FS_TYPE "fs:type" /* string */
#define G_FILE_ATTRIBUTE_FS_READONLY "fs:readonly" /* boolean */
#define G_FILE_ATTRIBUTE_GVFS_BACKEND "gvfs:backend" /* string */
GType g_file_info_get_type (void) G_GNUC_CONST;
GFileInfo * g_file_info_new (void);
GFileInfo * g_file_info_dup (GFileInfo *other);
void g_file_info_copy_into (GFileInfo *src_info,
GFileInfo *dest_info);
gboolean g_file_info_has_attribute (GFileInfo *info,
const char *attribute);
char ** g_file_info_list_attributes (GFileInfo *info,
const char *name_space);
GFileAttributeType g_file_info_get_attribute_type (GFileInfo *info,
const char *attribute);
void g_file_info_remove_attribute (GFileInfo *info,
const char *attribute);
GFileAttributeValue * g_file_info_get_attribute (GFileInfo *info,
const char *attribute);
const char * g_file_info_get_attribute_string (GFileInfo *info,
const char *attribute);
const char * g_file_info_get_attribute_byte_string (GFileInfo *info,
const char *attribute);
gboolean g_file_info_get_attribute_boolean (GFileInfo *info,
const char *attribute);
guint32 g_file_info_get_attribute_uint32 (GFileInfo *info,
const char *attribute);
gint32 g_file_info_get_attribute_int32 (GFileInfo *info,
const char *attribute);
guint64 g_file_info_get_attribute_uint64 (GFileInfo *info,
const char *attribute);
gint64 g_file_info_get_attribute_int64 (GFileInfo *info,
const char *attribute);
GObject * g_file_info_get_attribute_object (GFileInfo *info,
const char *attribute);
void g_file_info_set_attribute (GFileInfo *info,
const char *attribute,
const GFileAttributeValue *attr_value);
void g_file_info_set_attribute_string (GFileInfo *info,
const char *attribute,
const char *attr_value);
void g_file_info_set_attribute_byte_string (GFileInfo *info,
const char *attribute,
const char *attr_value);
void g_file_info_set_attribute_boolean (GFileInfo *info,
const char *attribute,
gboolean attr_value);
void g_file_info_set_attribute_uint32 (GFileInfo *info,
const char *attribute,
guint32 attr_value);
void g_file_info_set_attribute_int32 (GFileInfo *info,
const char *attribute,
gint32 attr_value);
void g_file_info_set_attribute_uint64 (GFileInfo *info,
const char *attribute,
guint64 attr_value);
void g_file_info_set_attribute_int64 (GFileInfo *info,
const char *attribute,
gint64 attr_value);
void g_file_info_set_attribute_object (GFileInfo *info,
const char *attribute,
GObject *attr_value);
void g_file_info_clear_status (GFileInfo *info);
/* Helper getters: */
GFileType g_file_info_get_file_type (GFileInfo *info);
gboolean g_file_info_get_is_hidden (GFileInfo *info);
gboolean g_file_info_get_is_backup (GFileInfo *info);
gboolean g_file_info_get_is_symlink (GFileInfo *info);
const char * g_file_info_get_name (GFileInfo *info);
const char * g_file_info_get_display_name (GFileInfo *info);
const char * g_file_info_get_edit_name (GFileInfo *info);
GIcon * g_file_info_get_icon (GFileInfo *info);
const char * g_file_info_get_content_type (GFileInfo *info);
goffset g_file_info_get_size (GFileInfo *info);
void g_file_info_get_modification_time (GFileInfo *info,
GTimeVal *result);
const char * g_file_info_get_symlink_target (GFileInfo *info);
const char * g_file_info_get_etag (GFileInfo *info);
gint32 g_file_info_get_sort_order (GFileInfo *info);
void g_file_info_set_attribute_mask (GFileInfo *info,
GFileAttributeMatcher *mask);
void g_file_info_unset_attribute_mask (GFileInfo *info);
/* Helper setters: */
void g_file_info_set_file_type (GFileInfo *info,
GFileType type);
void g_file_info_set_is_hidden (GFileInfo *info,
gboolean is_hidden);
void g_file_info_set_is_symlink (GFileInfo *info,
gboolean is_symlink);
void g_file_info_set_name (GFileInfo *info,
const char *name);
void g_file_info_set_display_name (GFileInfo *info,
const char *display_name);
void g_file_info_set_edit_name (GFileInfo *info,
const char *edit_name);
void g_file_info_set_icon (GFileInfo *info,
GIcon *icon);
void g_file_info_set_content_type (GFileInfo *info,
const char *content_type);
void g_file_info_set_size (GFileInfo *info,
goffset size);
void g_file_info_set_modification_time (GFileInfo *info,
GTimeVal *mtime);
void g_file_info_set_symlink_target (GFileInfo *info,
const char *symlink_target);
void g_file_info_set_sort_order (GFileInfo *info,
gint32 sort_order);
/* Helper functions for attributes: */
/* TODO: Move this to glib when merging */
char *g_format_file_size_for_display (goffset size);
GFileAttributeMatcher *g_file_attribute_matcher_new (const char *attributes);
GFileAttributeMatcher *g_file_attribute_matcher_ref (GFileAttributeMatcher *matcher);
void g_file_attribute_matcher_unref (GFileAttributeMatcher *matcher);
gboolean g_file_attribute_matcher_matches (GFileAttributeMatcher *matcher,
const char *attribute);
gboolean g_file_attribute_matcher_matches_only (GFileAttributeMatcher *matcher,
const char *attribute);
gboolean g_file_attribute_matcher_enumerate_namespace (GFileAttributeMatcher *matcher,
const char *ns);
const char * g_file_attribute_matcher_enumerate_next (GFileAttributeMatcher *matcher);
G_END_DECLS
#endif /* __G_FILE_INFO_H__ */