calendar/libecal/e-cal-view.h

   1 /* Evolution calendar - Live view client object
   2  *
   3  * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
   4  *
   5  * Author: Federico Mena-Quintero <federico@ximian.com>
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of version 2 of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  */
  20
  21 #if !defined (__LIBECAL_H_INSIDE__) && !defined (LIBECAL_COMPILATION)
  22 #error "Only <libecal/libecal.h> should be included directly."
  23 #endif
  24
  25 #ifndef EDS_DISABLE_DEPRECATED
  26
  27 #ifndef E_CAL_VIEW_H
  28 #define E_CAL_VIEW_H
  29
  30 #include <glib-object.h>
  31 #include <libecal/e-cal-types.h>
  32
  33 /* Standard GObject macros */
  34 #define E_TYPE_CAL_VIEW \
  35         (e_cal_view_get_type ())
  36 #define E_CAL_VIEW(obj) \
  37         (G_TYPE_CHECK_INSTANCE_CAST \
  38         ((obj), E_TYPE_CAL_VIEW, ECalView))
  39 #define E_CAL_VIEW_CLASS(cls) \
  40         (G_TYPE_CHECK_CLASS_CAST \
  41         ((cls), E_TYPE_CAL_VIEW, ECalViewClass))
  42 #define E_IS_CAL_VIEW(obj) \
  43         (G_TYPE_CHECK_INSTANCE_TYPE \
  44         ((obj), E_TYPE_CAL_VIEW))
  45 #define E_IS_CAL_VIEW_CLASS(cls) \
  46         (G_TYPE_CHECK_CLASS_TYPE \
  47         ((cls), E_TYPE_CAL_VIEW))
  48 #define E_CAL_VIEW_GET_CLASS(obj) \
  49         (G_TYPE_INSTANCE_GET_CLASS \
  50         ((obj), E_TYPE_CAL_VIEW, ECalViewClass))
  51
  52 G_BEGIN_DECLS
  53
  54 typedef struct _ECalView ECalView;
  55 typedef struct _ECalViewClass ECalViewClass;
  56 typedef struct _ECalViewPrivate ECalViewPrivate;
  57
  58 struct _ECal;
  59
  60 struct _ECalView {
  61         GObject object;
  62         ECalViewPrivate *priv;
  63 };
  64
  65 struct _ECalViewClass {
  66         GObjectClass parent_class;
  67
  68         /* Signals */
  69         void    (*objects_added)                (ECalView *cal_view,
  70                                                  GList *objects);
  71         void    (*objects_modified)             (ECalView *cal_view,
  72                                                  GList *objects);
  73         void    (*objects_removed)              (ECalView *cal_view,
  74                                                  GList *uids);
  75         void    (*view_progress)                (ECalView *cal_view,
  76                                                  gchar *message,
  77                                                  gint percent);
  78         void    (*view_done)                    (ECalView *cal_view,
  79                                                  ECalendarStatus status);
  80         void    (*view_complete)                (ECalView *cal_view,
  81                                                  ECalendarStatus status,
  82                                                  const gchar *error_msg);
  83 };
  84
  85 GType           e_cal_view_get_type             (void);
  86 struct _ECal *  e_cal_view_get_client           (ECalView *cal_view);
  87 void            e_cal_view_start                (ECalView *cal_view);
  88 void            e_cal_view_stop                 (ECalView *cal_view);
  89
  90 G_END_DECLS
  91
  92 #endif /* E_CAL_VIEW_H */
  93
  94 #endif /* EDS_DISABLE_DEPRECATED */