gio/gfileattribute.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   4  *
   5  * SPDX-License-Identifier: LGPL-2.1-or-later
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General
  18  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #ifndef __G_FILE_ATTRIBUTE_H__
  24 #define __G_FILE_ATTRIBUTE_H__
  25
  26 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  27 #error "Only <gio/gio.h> can be included directly."
  28 #endif
  29
  30 #include <gio/giotypes.h>
  31
  32 G_BEGIN_DECLS
  33
  34 /**
  35  * GFileAttributeInfo:
  36  * @name: the name of the attribute.
  37  * @type: the #GFileAttributeType type of the attribute.
  38  * @flags: a set of #GFileAttributeInfoFlags.
  39  *
  40  * Information about a specific attribute.
  41  **/
  42 struct _GFileAttributeInfo
  43 {
  44   char                    *name;
  45   GFileAttributeType       type;
  46   GFileAttributeInfoFlags  flags;
  47 };
  48
  49 /**
  50  * GFileAttributeInfoList:
  51  * @infos: an array of #GFileAttributeInfos.
  52  * @n_infos: the number of values in the array.
  53  *
  54  * Acts as a lightweight registry for possible valid file attributes.
  55  * The registry stores Key-Value pair formats as #GFileAttributeInfos.
  56  **/
  57 struct _GFileAttributeInfoList
  58 {
  59   GFileAttributeInfo *infos;
  60   int                 n_infos;
  61 };
  62
  63 #define G_TYPE_FILE_ATTRIBUTE_INFO_LIST (g_file_attribute_info_list_get_type ())
  64 GIO_AVAILABLE_IN_ALL
  65 GType g_file_attribute_info_list_get_type (void);
  66
  67 GIO_AVAILABLE_IN_ALL
  68 GFileAttributeInfoList *  g_file_attribute_info_list_new    (void);
  69 GIO_AVAILABLE_IN_ALL
  70 GFileAttributeInfoList *  g_file_attribute_info_list_ref    (GFileAttributeInfoList *list);
  71 GIO_AVAILABLE_IN_ALL
  72 void                      g_file_attribute_info_list_unref  (GFileAttributeInfoList *list);
  73 GIO_AVAILABLE_IN_ALL
  74 GFileAttributeInfoList *  g_file_attribute_info_list_dup    (GFileAttributeInfoList *list);
  75 GIO_AVAILABLE_IN_ALL
  76 const GFileAttributeInfo *g_file_attribute_info_list_lookup (GFileAttributeInfoList *list,
  77                                                              const char             *name);
  78 GIO_AVAILABLE_IN_ALL
  79 void                      g_file_attribute_info_list_add    (GFileAttributeInfoList *list,
  80                                                              const char             *name,
  81                                                              GFileAttributeType      type,
  82                                                              GFileAttributeInfoFlags flags);
  83
  84 G_END_DECLS
  85
  86 #endif /* __G_FILE_INFO_H__ */