gnc-recurrence.h

/* gnc-recurrence.h:
 *
 *  GncRecurrence is a minimal GUI for specifying a Recurrence.
 *
 *  You see, small is _nice_.  :)
 *
 */

/* Copyright (C) 2005, Chris Shoemaker <[email protected]>  *
 *
 * 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, contact:
 *
 * Free Software Foundation           Voice:  +1-617-542-5942
 * 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652
 * Boston, MA  02111-1301,  USA       [email protected]
 */

#ifndef GNC_RECURRENCE_H
#define GNC_RECURRENCE_H

#include <glib.h>
#include "Recurrence.h"

#define GNC_TYPE_RECURRENCE       (gnc_recurrence_get_type())
#define GNC_RECURRENCE(obj)       G_TYPE_CHECK_INSTANCE_CAST  \
   (obj, GNC_TYPE_RECURRENCE, GncRecurrence)
#define GNC_RECURRENCE_CLASS(klass) G_TYPE_CHECK_CLASS_CAST \
   (klass, GNC_TYPE_RECURRENCE, GncRecurrence)
#define GNC_IS_RECURRENCE(obj)     G_TYPE_CHECK_INSTANCE_TYPE \
   (obj, GNC_TYPE_RECURRENCE)

typedef struct _GncRecurrence GncRecurrence;
typedef struct _GncRecurrenceComp GncRecurrenceComp;

GType gnc_recurrence_get_type(void);
GtkWidget * gnc_recurrence_new(void);

void gnc_recurrence_set(GncRecurrence *gr, const Recurrence *r);

/* The returned Recurrence is internally owned and is only valid as
   long as the GncRecurrence is around. */
const Recurrence * gnc_recurrence_get(GncRecurrence *gr);

/* "composite" recurrences */
void gnc_recurrence_comp_set_list(GncRecurrenceComp *grc, const GList *r);

/* The GList is newly-allocated, but the Recurrences are internally
   owned. */
GList * gnc_recurrence_comp_get_list(GncRecurrenceComp *grc);

/* This works, but is not used.  Kind of experimental... */
GtkWidget * gnc_recurrence_comp_new(void);
GType gnc_recurrence_comp_get_type(void);

#endif