summaryrefslogtreecommitdiff
path: root/libnautilus-private/nautilus-preferences.h
blob: ba23fdcbfd3046fabdca2508a7b6187dd3464b1e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */

/* nautilus-prefs.h - Preference peek/poke/notify object interface.

   Copyright (C) 1999, 2000 Eazel, Inc.

   The Gnome Library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public License as
   published by the Free Software Foundation; either version 2 of the
   License, or (at your option) any later version.

   The Gnome 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with the Gnome Library; see the file COPYING.LIB.  If not,
   write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.

   Authors: Ramiro Estrugo <ramiro@eazel.com>
*/

#ifndef NAUTILUS_PREFERENCES_H
#define NAUTILUS_PREFERENCES_H

#include <gtk/gtkobject.h>
#include <libgnome/gnome-defs.h>

BEGIN_GNOME_DECLS

#define NAUTILUS_TYPE_PREFERENCES            (nautilus_preferences_get_type ())
#define NAUTILUS_PREFERENCES(obj)            (GTK_CHECK_CAST ((obj), NAUTILUS_TYPE_PREFERENCES, NautilusPreferences))
#define NAUTILUS_PREFERENCES_CLASS(klass)    (GTK_CHECK_CLASS_CAST ((klass), NAUTILUS_TYPE_PREFERENCES, NautilusPreferencesClass))
#define NAUTILUS_IS_PREFERENCES(obj)         (GTK_CHECK_TYPE ((obj), NAUTILUS_TYPE_PREFERENCES))
#define NAUTILUS_IS_PREFERENCES_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), NAUTILUS_TYPE_PREFERENCES))

typedef struct NautilusPreferences	    NautilusPreferences;
typedef struct NautilusPreferencesClass     NautilusPreferencesClass;
typedef struct NautilusPreferencesDetails   NautilusPreferencesDetails;

struct NautilusPreferences
{
	GtkObject			object;
	NautilusPreferencesDetails	*details;
};

/*
 * NautilusPreferencesType:
 *
 * The types of supported preferences.
 */
typedef enum
{
	NAUTILUS_PREFERENCE_BOOLEAN,
	NAUTILUS_PREFERENCE_ENUM,
	NAUTILUS_PREFERENCE_STRING
} NautilusPreferencesType;

/*
 * A callback which you can register to to be notified when a particular
 * preference changes.
 */
typedef void (*NautilusPreferencesCallback) (NautilusPreferences    *preferences,
					     const char             *name, 
					     NautilusPreferencesType type,
					     gconstpointer           value,
					     gpointer                user_data);

struct NautilusPreferencesClass
{
	GtkObjectClass object_class;
};

typedef struct
{
	char			*name;
	char			*description;
	NautilusPreferencesType	 type;
	gconstpointer		 default_value;
	gpointer		 data;
} NautilusPreferencesInfo;

typedef struct
{
	const char * const *enum_names;
	const char * const *enum_descriptions;
	const int	   *enum_values;
	guint		    num_entries;
} NautilusPreferencesEnumData;

GtkType                        nautilus_preferences_get_type               (void);
GtkObject *                    nautilus_preferences_new                    (const char                    *domain);
void                           nautilus_preferences_register_from_info     (NautilusPreferences           *preferences,
									    const NautilusPreferencesInfo *pref_info);
void                           nautilus_preferences_register_from_values   (NautilusPreferences           *preferences,
									    char                          *name,
									    char                          *description,
									    NautilusPreferencesType        type,
									    gconstpointer                  default_value,
									    gpointer                       data);
const NautilusPreferencesInfo *nautilus_preferences_get_info               (NautilusPreferences           *preferences,
									    const char                    *name);
gboolean                       nautilus_preferences_add_callback           (NautilusPreferences           *preferences,
									    const char                    *name,
									    NautilusPreferencesCallback    callback,
									    gpointer                       user_data);
gboolean                       nautilus_preferences_remove_callback        (NautilusPreferences           *preferences,
									    const char                    *name,
									    NautilusPreferencesCallback    callback,
									    gpointer                       user_data);
void                           nautilus_preferences_set_boolean            (NautilusPreferences           *preferences,
									    const char                    *name,
									    gboolean                       value);
gboolean                       nautilus_preferences_get_boolean            (NautilusPreferences           *preferences,
									    const char                    *name);
void                           nautilus_preferences_set_enum               (NautilusPreferences           *preferences,
									    const char                    *name,
									    int                            value);
int                            nautilus_preferences_get_enum               (NautilusPreferences           *preferences,
									    const char                    *name);
void                           nautilus_preferences_set_string             (NautilusPreferences           *preferences,
									    const char                    *name,
									    const char                    *value);
char *                         nautilus_preferences_get_string             (NautilusPreferences           *preferences,
									    const char                    *name);
NautilusPreferences *          nautilus_preferences_get_global_preferences (void);


BEGIN_GNOME_DECLS

#endif /* NAUTILUS_PREFERENCES_H */