src/api/na-data-types.h

   1 /*
   2  * Nautilus-Actions
   3  * A Nautilus extension which offers configurable context menu actions.
   4  *
   5  * Copyright (C) 2005 The GNOME Foundation
   6  * Copyright (C) 2006, 2007, 2008 Frederic Ruaudel and others (see AUTHORS)
   7  * Copyright (C) 2009, 2010, 2011 Pierre Wieser and others (see AUTHORS)
   8  *
   9  * This Program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License as
  11  * published by the Free Software Foundation; either version 2 of
  12  * the License, or (at your option) any later version.
  13  *
  14  * This Program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public
  20  * License along with this Library; see the file COPYING.  If not,
  21  * write to the Free Software Foundation, Inc., 59 Temple Place,
  22  * Suite 330, Boston, MA 02111-1307, USA.
  23  *
  24  * Authors:
  25  *   Frederic Ruaudel <grumz@grumz.net>
  26  *   Rodrigo Moya <rodrigo@gnome-db.org>
  27  *   Pierre Wieser <pwieser@trychlos.org>
  28  *   ... and many others (see AUTHORS)
  29  */
  30
  31 #ifndef __NAUTILUS_ACTIONS_API_NA_DATA_TYPES_H__
  32 #define __NAUTILUS_ACTIONS_API_NA_DATA_TYPES_H__
  33
  34 /**
  35  * SECTION: data-type
  36  * @title: NADataType
  37  * @short_description: The Data Factory Type Definitions
  38  * @include: nautilus-actions/na-data-types.h
  39  */
  40
  41 #include <glib.h>
  42
  43 G_BEGIN_DECLS
  44
  45 /**
  46  * NADataType:
  47  * @NA_DATA_TYPE_BOOLEAN:       a boolean
  48  *                              can be initialized with "true" or "false" (case insensitive)
  49  * @NA_DATA_TYPE_POINTER:       a ( void * ) pointer
  50  * @NA_DATA_TYPE_STRING:        an ASCII string
  51  * @NA_DATA_TYPE_STRING_LIST:   a list of ASCII strings
  52  * @NA_DATA_TYPE_LOCALE_STRING: a localized UTF-8 string
  53  * @NA_DATA_TYPE_UINT:          an unsigned integer
  54  * @NA_DATA_TYPE_UINT_LIST:     a list of unsigned integers
  55  *
  56  * Each elementary data which would take advantage of #NABoxed facilities
  57  * should be typed at instanciation time.
  58  *
  59  * #NAIFactoryProvider implementations should provide a primitive for reading
  60  * (resp. writing) a value for each of these elementary data types.
  61  *
  62  * <note>
  63  *   <para>
  64  * Please note that this enumeration may be compiled in by the extensions.
  65  * They must so remain fixed, unless you are prepared to see strange effects
  66  * (e.g. an extension has been compiled with %NA_DATA_TYPE_STRING = 2, while you
  67  * have inserted another element, making it to 3 !) - or you know what
  68  * you are doing...
  69  *   </para>
  70  *   <para>
  71  *     So, only add new items at the end of the enum. You have been warned!
  72  *   </para>
  73  * </note>
  74  *
  75  * Since: 2.30
  76  */
  77 typedef enum {
  78         NA_DATA_TYPE_BOOLEAN = 1,
  79         NA_DATA_TYPE_POINTER,
  80         NA_DATA_TYPE_STRING,
  81         NA_DATA_TYPE_STRING_LIST,
  82         NA_DATA_TYPE_LOCALE_STRING,
  83         NA_DATA_TYPE_UINT,
  84         NA_DATA_TYPE_UINT_LIST,
  85         /*< private >*/
  86         /* count of defined types */
  87         NA_DATA_TYPE_N
  88 }
  89         NADataType;
  90
  91 const gchar *na_data_types_get_gconf_dump_key( guint type );
  92
  93 G_END_DECLS
  94
  95 #endif /* __NAUTILUS_ACTIONS_API_NA_DATA_TYPES_H__ */