/* This is -*- C -*- */
/* vim: set sw=2: */
/* $Id: guppi-attribute-bag.h,v 1.7 2002/01/08 23:19:19 trow Exp $ */

/*
 * guppi-attribute-bag.h
 *
 * Copyright (C) 2001 The Free Software Foundation
 *
 * Developed by Jon Trowbridge <trow@gnu.org>
 *
 * 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 of the
 * License, 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 _INC_GUPPI_ATTRIBUTE_BAG_H
#define _INC_GUPPI_ATTRIBUTE_BAG_H

#include <gtk/gtkobject.h>
#include  "guppi-defs.h"

#include "guppi-attribute-flavor.h"

BEGIN_GUPPI_DECLS;

struct _GuppiAttributeBagPrivate;
typedef struct _GuppiAttributeBagPrivate GuppiAttributeBagPrivate;

typedef struct _GuppiAttributeBag GuppiAttributeBag;
typedef struct _GuppiAttributeBagClass GuppiAttributeBagClass;

typedef void (*GuppiAttributeBagFn) (GuppiAttributeBag *, const gchar *name, gpointer closure);


struct _GuppiAttributeBag {
  GtkObject parent;

  GuppiAttributeBagPrivate *priv;
};

struct _GuppiAttributeBagClass {
  GtkObjectClass parent_class;

  void (*added) (GuppiAttributeBag *, const gchar *name);
  void (*changed) (GuppiAttributeBag *, const gchar *name);
};

#define GUPPI_TYPE_ATTRIBUTE_BAG (guppi_attribute_bag_get_type ())
#define GUPPI_ATTRIBUTE_BAG(obj) (GTK_CHECK_CAST((obj),GUPPI_TYPE_ATTRIBUTE_BAG,GuppiAttributeBag))
#define GUPPI_ATTRIBUTE_BAG0(obj) ((obj) ? (GUPPI_ATTRIBUTE_BAG(obj)) : NULL)
#define GUPPI_ATTRIBUTE_BAG_CLASS(klass) (GTK_CHECK_CLASS_CAST((klass),GUPPI_TYPE_ATTRIBUTE_BAG,GuppiAttributeBagClass))
#define GUPPI_IS_ATTRIBUTE_BAG(obj) (GTK_CHECK_TYPE((obj), GUPPI_TYPE_ATTRIBUTE_BAG))
#define GUPPI_IS_ATTRIBUTE_BAG0(obj) (((obj) == NULL) || (GUPPI_IS_ATTRIBUTE_BAG(obj)))
#define GUPPI_IS_ATTRIBUTE_BAG_CLASS(klass) (GTK_CHECK_CLASS_TYPE((klass), GUPPI_TYPE_ATTRIBUTE_BAG))

GtkType guppi_attribute_bag_get_type (void);

GuppiAttributeBag *guppi_attribute_bag_new (void);
GuppiAttributeBag *guppi_attribute_bag_copy (GuppiAttributeBag *);

void guppi_attribute_bag_add (GuppiAttributeBag *bag,
			      GuppiAttributeFlavor flavor,
			      const gchar *name,
			      const gchar *description);

void guppi_attribute_bag_add_with_default (GuppiAttributeBag *bag,
					   GuppiAttributeFlavor flavor,
					   const gchar *name,
					   const gchar *description,
					   ...);

gboolean guppi_attribute_bag_contains (GuppiAttributeBag *bag, const gchar *name);
GuppiAttributeFlavor guppi_attribute_bag_get_flavor (GuppiAttributeBag *bag, const gchar *name);

void guppi_attribute_bag_foreach (GuppiAttributeBag *bag, GuppiAttributeBagFn fn, gpointer closure);

gboolean guppi_attribute_bag_get1  (GuppiAttributeBag *bag, const gchar *key, gpointer dest);
gboolean guppi_attribute_bag_vset1  (GuppiAttributeBag *bag, const gchar *key, va_list *varargs);

gboolean guppi_attribute_bag_vget (GuppiAttributeBag *bag, va_list varargs);
gboolean guppi_attribute_bag_vset (GuppiAttributeBag *bag, va_list *varargs);
gboolean guppi_attribute_bag_get  (GuppiAttributeBag *bag, ...);
gboolean guppi_attribute_bag_set  (GuppiAttributeBag *bag, ...);


void guppi_attribute_bag_restore_default (GuppiAttributeBag *bag, const gchar *name);
void guppi_attribute_bag_restore_all_defaults (GuppiAttributeBag *bag);

void guppi_attribute_bag_dump (GuppiAttributeBag *bag);

xmlNodePtr guppi_attribute_bag_export_xml (GuppiAttributeBag *bag, GuppiXMLDocument *doc);
gboolean   guppi_attribute_bag_import_xml (GuppiAttributeBag *bag, GuppiXMLDocument *doc, xmlNodePtr node);
void       guppi_attribute_bag_spew_xml   (GuppiAttributeBag *bag);

			      

END_GUPPI_DECLS;

#endif /* _INC_GUPPI_ATTRIBUTE_BAG_H */

/* $Id: guppi-attribute-bag.h,v 1.7 2002/01/08 23:19:19 trow Exp $ */