gnome-control-center/capplets/sound/preferences.h

/* -*- mode: c; style: linux -*- */

/* preferences.h
 * Copyright (C) 2000 Helix Code, Inc.
 *
 * Written by Bradford Hovinen <hovinen@helixcode.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 */

#ifndef __PREFERENCES_H
#define __PREFERENCES_H

#include <gtk/gtk.h>

#include <tree.h>

#define CATEGORY(obj)      ((Category *) (obj))

typedef struct _Category Category;

struct _Category
{
	gchar    *description;
	gchar    *file;
	GTree    *events;
};

#define SOUND_EVENT(obj)      ((SoundEvent *) (obj))

typedef struct _SoundEvent SoundEvent;

struct _SoundEvent 
{
	Category *category;
	gchar    *name;
	gchar    *file;
	gchar    *description;
};

#define PREFERENCES(obj)          GTK_CHECK_CAST (obj, preferences_get_type (), Preferences)
#define PREFERENCES_CLASS(klass)  GTK_CHECK_CLASS_CAST (klass, preferences_get_type (), PreferencesClass)
#define IS_PREFERENCES(obj)       GTK_CHECK_TYPE (obj, preferences_get_type ())

typedef struct _Preferences Preferences;
typedef struct _PreferencesClass PreferencesClass;

typedef int (*CategoryCallback) (Preferences *, gchar *, gpointer data);
typedef int (*EventCallback) (Preferences *, SoundEvent *, gpointer data);

struct _Preferences 
{
	GtkObject         object;

	gint              frozen;
	guint             timeout_id;

	gboolean          enable_esd;
	gboolean          enable_sound_events;

	/* private */

	/* Each node is a linked list of SoundEvents in the category */
	GTree            *categories;
	GTree            *cat_byfile;
};

struct _PreferencesClass
{
	GtkObjectClass klass;
};

GType        preferences_get_type   (void);

GtkObject   *preferences_new        (void);
GtkObject   *preferences_clone      (Preferences *prefs);
void         preferences_destroy    (GtkObject *object);

void         preferences_load       (Preferences *prefs);
void         preferences_save       (Preferences *prefs);
void         preferences_changed    (Preferences *prefs);
void         preferences_apply_now  (Preferences *prefs);

void         preferences_freeze     (Preferences *prefs);
void         preferences_thaw       (Preferences *prefs);

Preferences *preferences_read_xml   (xmlDocPtr xml_doc);
xmlDocPtr    preferences_write_xml  (Preferences *prefs);

void         preferences_foreach_category (Preferences *prefs,
					   CategoryCallback cb,
					   gpointer data);
void         preferences_foreach_event (Preferences *prefs,
					gchar *category,
					EventCallback cb,
					gpointer data);

#endif /* __PREFERENCES_H */