summaryrefslogtreecommitdiff
path: root/libnautilus-private/nautilus-preferences.h
blob: 2c4de5c7a780662de4c00637d9730a74fd1f4603 (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
134
135
136
137
138
139
140
141
142
/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */

/* nautilus-preferences.c - Preference peek/poke/notify interface.

   Copyright (C) 1999, 2000, 2001 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>
#include <eel/eel-string-list.h>

BEGIN_GNOME_DECLS

/*
 * A callback which you can register to to be notified when a particular
 * preference changes.
 */
typedef void (*NautilusPreferencesCallback) (gpointer callback_data);

/* User level */

/* Note that there's a function to get the number of user levels, but there's
 * a lot of code elsewhere that assumes three levels. Publicizing the numbers
 * of these levels lets that other code be coherent and less error-prone.
 */
#define NAUTILUS_USER_LEVEL_NOVICE		0
#define NAUTILUS_USER_LEVEL_INTERMEDIATE	1
#define NAUTILUS_USER_LEVEL_ADVANCED		2

char *         nautilus_preferences_get_user_level_name_for_display (int                           user_level);
char *         nautilus_preferences_get_user_level_name_for_storage (int                           user_level);
int            nautilus_preferences_get_user_level                  (void);
void           nautilus_preferences_set_user_level                  (int                           user_level);
int            nautilus_preferences_user_level_clamp                (int                           user_level);
gboolean       nautilus_preferences_user_level_is_valid             (int                           user_level);

/* Preferences getters and setters */
gboolean       nautilus_preferences_get_boolean                     (const char                   *name);
void           nautilus_preferences_set_boolean                     (const char                   *name,
								     gboolean                      boolean_value);
int            nautilus_preferences_get_integer                     (const char                   *name);
void           nautilus_preferences_set_integer                     (const char                   *name,
								     int                           int_value);
char *         nautilus_preferences_get                             (const char                   *name);
void           nautilus_preferences_set                             (const char                   *name,
								     const char                   *string_value);
EelStringList *nautilus_preferences_get_string_list                 (const char                   *name);
void           nautilus_preferences_set_string_list                 (const char                   *name,
								     const EelStringList          *string_list_value);

/* Default values getters and setters */
gboolean       nautilus_preferences_default_get_boolean             (const char                   *name,
								     int                           user_level);
void           nautilus_preferences_default_set_boolean             (const char                   *name,
								     int                           user_level,
								     gboolean                      boolean_value);
int            nautilus_preferences_default_get_integer             (const char                   *name,
								     int                           user_level);
void           nautilus_preferences_default_set_integer             (const char                   *name,
								     int                           user_level,
								     int                           int_value);
char *         nautilus_preferences_default_get_string              (const char                   *name,
								     int                           user_level);
void           nautilus_preferences_default_set_string              (const char                   *name,
								     int                           user_level,
								     const char                   *string_value);
EelStringList *nautilus_preferences_default_get_string_list         (const char                   *name,
								     int                           user_level);
void           nautilus_preferences_default_set_string_list         (const char                   *name,
								     int                           user_level,
								     const EelStringList          *string_list_value);
/* Callbacks */
void           nautilus_preferences_add_callback                    (const char                   *name,
								     NautilusPreferencesCallback   callback,
								     gpointer                      callback_data);
void           nautilus_preferences_add_callback_while_alive        (const char                   *name,
								     NautilusPreferencesCallback   callback,
								     gpointer                      callback_data,
								     GtkObject                    *alive_object);
void           nautilus_preferences_remove_callback                 (const char                   *name,
								     NautilusPreferencesCallback   callback,
								     gpointer                      callback_data);

/* Variables that are automatically updated (lightweight "callbacks") */
void           nautilus_preferences_add_auto_string                 (const char                   *name,
								     const char                  **storage);
void           nautilus_preferences_add_auto_string_list            (const char                   *name,
								     const EelStringList         **storage);
void           nautilus_preferences_add_auto_integer                (const char                   *name,
								     int                          *storage);
void           nautilus_preferences_add_auto_boolean                (const char                   *name,
								     gboolean                     *storage);
void           nautilus_preferences_remove_auto_string              (const char                   *name,
								     const char                  **storage);
void           nautilus_preferences_remove_auto_string_list         (const char                   *name,
								     const EelStringList         **storage);
void           nautilus_preferences_remove_auto_integer             (const char                   *name,
								     int                          *storage);
void           nautilus_preferences_remove_auto_boolean             (const char                   *name,
								     int                          *storage);

/* Preferences attributes */
int            nautilus_preferences_get_visible_user_level          (const char                   *name);
void           nautilus_preferences_set_visible_user_level          (const char                   *name,
								     int                           visible_user_level);
gboolean       nautilus_preferences_get_is_invisible                (const char                   *name);
void           nautilus_preferences_set_is_invisible                (const char                   *name,
								     gboolean                      invisible);
char *         nautilus_preferences_get_description                 (const char                   *name);
void           nautilus_preferences_set_description                 (const char                   *name,
								     const char                   *description);
char *         nautilus_preferences_get_enumeration_id              (const char                   *name);
void           nautilus_preferences_set_enumeration_id              (const char                   *name,
								     const char                   *enumeration_id);
gboolean       nautilus_preferences_monitor_directory               (const char                   *directory);
gboolean       nautilus_preferences_visible_in_current_user_level   (const char                   *name);
gboolean       nautilus_preferences_is_visible                      (const char                   *name);
void           nautilus_preferences_initialize                      (const char                   *storage_path);

END_GNOME_DECLS

#endif /* NAUTILUS_PREFERENCES_H */