calendar/gui/e-alarm-list.h

   1 /*
   2  *
   3  * EAlarmList - list of calendar alarms with GtkTreeModel interface.
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) version 3.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with the program; if not, see <http://www.gnu.org/licenses/>
  17  *
  18  *
  19  * Authors:
  20  *              Hans Petter Jansson  <hpj@ximian.com>
  21  *
  22  * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
  23  *
  24  */
  25
  26 #ifndef E_ALARM_LIST_H
  27 #define E_ALARM_LIST_H
  28
  29 #include <gtk/gtk.h>
  30 #include <libecal/e-cal-component.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define E_TYPE_ALARM_LIST            (e_alarm_list_get_type ())
  35 #define E_ALARM_LIST(obj)                (G_TYPE_CHECK_INSTANCE_CAST ((obj), E_TYPE_ALARM_LIST, EAlarmList))
  36 #define E_ALARM_LIST_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), E_TYPE_ALARM_LIST, EAlarmListClass))
  37 #define E_IS_ALARM_LIST(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), E_TYPE_ALARM_LIST))
  38 #define E_IS_ALARM_LIST_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), E_TYPE_ALARM_LIST))
  39 #define E_ALARM_LIST_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), E_TYPE_ALARM_LIST, EAlarmListClass))
  40
  41 typedef struct _EAlarmList       EAlarmList;
  42 typedef struct _EAlarmListClass  EAlarmListClass;
  43
  44 typedef enum
  45 {
  46         E_ALARM_LIST_COLUMN_DESCRIPTION,
  47
  48         E_ALARM_LIST_NUM_COLUMNS
  49 }
  50 EAlarmListColumnType;
  51
  52 struct _EAlarmList
  53 {
  54         GObject  parent;
  55
  56         /* Private */
  57
  58         gint     stamp;
  59         GList   *list;
  60
  61         guint    columns_dirty : 1;
  62 };
  63
  64 struct _EAlarmListClass
  65 {
  66         GObjectClass parent_class;
  67 };
  68
  69 GType                    e_alarm_list_get_type  (void);
  70 EAlarmList              *e_alarm_list_new       (void);
  71
  72 const ECalComponentAlarm *e_alarm_list_get_alarm (EAlarmList *alarm_list, GtkTreeIter *iter);
  73 void                     e_alarm_list_set_alarm (EAlarmList *alarm_list, GtkTreeIter *iter,
  74                                                  const ECalComponentAlarm *datetime);
  75 void                     e_alarm_list_append    (EAlarmList *alarm_list, GtkTreeIter *iter,
  76                                                  const ECalComponentAlarm *datetime);
  77 void                     e_alarm_list_remove    (EAlarmList *alarm_list, GtkTreeIter *iter);
  78 void                     e_alarm_list_clear     (EAlarmList *alarm_list);
  79
  80 G_END_DECLS
  81
  82 #endif  /* E_ALARM_LIST_H */