summaryrefslogtreecommitdiff
path: root/libnautilus-private/nautilus-preferences-item.h
blob: 497aaec0f7bb00c004a03f85be96292979d72ae1 (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
/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */

/* nautilus-preferences-item.h - Interface for an individual prefs item.

   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_ITEM_H
#define NAUTILUS_PREFERENCES_ITEM_H

#include <gtk/gtkvbox.h>
#include <libnautilus-extensions/nautilus-preferences.h>
#include <eel/eel-enumeration.h>

BEGIN_GNOME_DECLS

#define NAUTILUS_TYPE_PREFERENCES_ITEM            (nautilus_preferences_item_get_type ())
#define NAUTILUS_PREFERENCES_ITEM(obj)            (GTK_CHECK_CAST ((obj), NAUTILUS_TYPE_PREFERENCES_ITEM, NautilusPreferencesItem))
#define NAUTILUS_PREFERENCES_ITEM_CLASS(klass)    (GTK_CHECK_CLASS_CAST ((klass), NAUTILUS_TYPE_PREFERENCES_ITEM, NautilusPreferencesItemClass))
#define NAUTILUS_IS_PREFERENCES_ITEM(obj)         (GTK_CHECK_TYPE ((obj), NAUTILUS_TYPE_PREFERENCES_ITEM))
#define NAUTILUS_IS_PREFERENCES_ITEM_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), NAUTILUS_TYPE_PREFERENCES_ITEM))

typedef struct NautilusPreferencesItem		 NautilusPreferencesItem;
typedef struct NautilusPreferencesItemClass      NautilusPreferencesItemClass;
typedef struct NautilusPreferencesItemDetails    NautilusPreferencesItemDetails;

struct NautilusPreferencesItem
{
	/* Super Class */
	GtkVBox vbox;

	/* Private stuff */
	NautilusPreferencesItemDetails *details;
};

struct NautilusPreferencesItemClass
{
	GtkVBoxClass vbox_class;
};

/*
 * NautilusPreferencesItemType:
 *
 * The types of supported preferences that also have a corresponding ui in the 
 * preferences dialog.  Note that this is different than NautilusPreferencesType
 * because it is possible to have a prefernce that is not exposed in the ui.
 */
typedef enum
{
	NAUTILUS_PREFERENCE_ITEM_BOOLEAN,
	NAUTILUS_PREFERENCE_ITEM_EDITABLE_INTEGER,
	NAUTILUS_PREFERENCE_ITEM_EDITABLE_STRING,
	NAUTILUS_PREFERENCE_ITEM_ENUMERATION_HORIZONTAL_RADIO,
	NAUTILUS_PREFERENCE_ITEM_ENUMERATION_LIST_HORIZONTAL,
	NAUTILUS_PREFERENCE_ITEM_ENUMERATION_LIST_VERTICAL,
	NAUTILUS_PREFERENCE_ITEM_ENUMERATION_MENU,
	NAUTILUS_PREFERENCE_ITEM_ENUMERATION_VERTICAL_RADIO,
	NAUTILUS_PREFERENCE_ITEM_FONT,
	NAUTILUS_PREFERENCE_ITEM_PADDING,
	NAUTILUS_PREFERENCE_ITEM_SMOOTH_FONT
} NautilusPreferencesItemType;

typedef enum
{
	NAUTILUS_PREFERENCE_ITEM_SHOW,
	NAUTILUS_PREFERENCE_ITEM_HIDE
} NautilusPreferencesItemControlAction;

GtkType    nautilus_preferences_item_get_type                               (void);
GtkWidget* nautilus_preferences_item_new                                    (const char                           *preference_name,
									     NautilusPreferencesItemType           item_type);
char *     nautilus_preferences_item_get_name                               (const NautilusPreferencesItem        *preferences_item);
void       nautilus_preferences_item_set_control_preference                 (NautilusPreferencesItem              *preferences_item,
									     const char                           *control_preference_name);
void       nautilus_preferences_item_set_control_action                     (NautilusPreferencesItem              *preferences_item,
									     NautilusPreferencesItemControlAction  control_action);
gboolean   nautilus_preferences_item_child_is_caption                       (const NautilusPreferencesItem        *preferences_item);
int        nautilus_preferences_item_get_child_width                        (const NautilusPreferencesItem        *item);
void       nautilus_preferences_item_set_caption_extra_spacing              (NautilusPreferencesItem              *item,
									     int                                   extra_spacing);
void       nautilus_preferences_item_update_showing                         (NautilusPreferencesItem              *item);
gboolean   nautilus_preferences_item_is_showing                             (const NautilusPreferencesItem        *item);
void       nautilus_preferences_item_enumeration_list_set_unique_exceptions (NautilusPreferencesItem              *item,
									     const char                           *exceptions,
									     const char                           *exceptions_delimeter);

END_GNOME_DECLS

#endif /* NAUTILUS_PREFERENCES_ITEM_H */