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-2008 Frederic Ruaudel and others (see AUTHORS)
7  * Copyright (C) 2009-2014 Pierre Wieser and others (see AUTHORS)
8  *
9  * Nautilus-Actions 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  * Nautilus-Actions 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 GNU
17  * General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with Nautilus-Actions; see the file COPYING. If not, see
21  * <http://www.gnu.org/licenses/>.
22  *
23  * Authors:
24  *   Frederic Ruaudel <grumz@grumz.net>
25  *   Rodrigo Moya <rodrigo@gnome-db.org>
26  *   Pierre Wieser <pwieser@trychlos.org>
27  *   ... and many others (see AUTHORS)
28  */
29 
30 #ifndef __NAUTILUS_ACTIONS_API_NA_DATA_TYPES_H__
31 #define __NAUTILUS_ACTIONS_API_NA_DATA_TYPES_H__
32 
33 /**
34  * SECTION: data-type
35  * @title: NADataType
36  * @short_description: The Data Factory Type Definitions
37  * @include: nautilus-actions/na-data-types.h
38  */
39 
40 #include <glib.h>
41 
42 G_BEGIN_DECLS
43 
44 /**
45  * NADataType:
46  * @NA_DATA_TYPE_BOOLEAN:       a boolean
47  *                              can be initialized with "true" or "false" (case insensitive)
48  * @NA_DATA_TYPE_POINTER:       a ( void * ) pointer
49  * @NA_DATA_TYPE_STRING:        an ASCII string
50  * @NA_DATA_TYPE_STRING_LIST:   a list of ASCII strings
51  * @NA_DATA_TYPE_LOCALE_STRING: a localized UTF-8 string
52  * @NA_DATA_TYPE_UINT:          an unsigned integer
53  * @NA_DATA_TYPE_UINT_LIST:     a list of unsigned integers
54  *
55  * Each elementary data which would take advantage of #NABoxed facilities
56  * should be typed at instanciation time.
57  *
58  * #NAIFactoryProvider implementations should provide a primitive for reading
59  * (resp. writing) a value for each of these elementary data types.
60  *
61  * <note>
62  *   <para>
63  * Please note that this enumeration may be compiled in by the extensions.
64  * They must so remain fixed, unless you are prepared to see strange effects
65  * (e.g. an extension has been compiled with %NA_DATA_TYPE_STRING = 2, while you
66  * have inserted another element, making it to 3 !) - or you know what
67  * you are doing...
68  *   </para>
69  *   <para>
70  *     So, only add new items at the end of the enum. You have been warned!
71  *   </para>
72  * </note>
73  *
74  * Since: 2.30
75  */
76 typedef enum {
77 	NA_DATA_TYPE_BOOLEAN = 1,
78 	NA_DATA_TYPE_POINTER,
79 	NA_DATA_TYPE_STRING,
80 	NA_DATA_TYPE_STRING_LIST,
81 	NA_DATA_TYPE_LOCALE_STRING,
82 	NA_DATA_TYPE_UINT,
83 	NA_DATA_TYPE_UINT_LIST,
84 	/*< private >*/
85 	/* count of defined types */
86 	NA_DATA_TYPE_N
87 }
88 	NADataType;
89 
90 const gchar *na_data_types_get_gconf_dump_key( guint type );
91 
92 G_END_DECLS
93 
94 #endif /* __NAUTILUS_ACTIONS_API_NA_DATA_TYPES_H__ */
95