libedataserver/e-iterator.c

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  * Authors:
   4  *   Christopher James Lahey <clahey@umich.edu>
   5  *
   6  * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
   7  */
   8
   9 #include <config.h>
  10
  11 #include "e-iterator.h"
  12
  13 enum {
  14         INVALIDATE,
  15         LAST_SIGNAL
  16 };
  17
  18 static guint e_iterator_signals[LAST_SIGNAL] = { 0, };
  19
  20 G_DEFINE_TYPE (EIterator, e_iterator, G_TYPE_OBJECT)
  21
  22 static void
  23 e_iterator_class_init (EIteratorClass *class)
  24 {
  25         GObjectClass *object_class;
  26
  27         object_class = G_OBJECT_CLASS (class);
  28
  29         e_iterator_signals[INVALIDATE] = g_signal_new (
  30                 "invalidate",
  31                 G_OBJECT_CLASS_TYPE (object_class),
  32                 G_SIGNAL_RUN_LAST,
  33                 G_STRUCT_OFFSET (EIteratorClass, invalidate),
  34                 NULL, NULL,
  35                 g_cclosure_marshal_VOID__VOID,
  36                 G_TYPE_NONE, 0);
  37 }
  38
  39 /**
  40  * e_iterator_init:
  41  */
  42 static void
  43 e_iterator_init (EIterator *card)
  44 {
  45 }
  46
  47 /*
  48  * Virtual functions:
  49  *
  50  */
  51
  52 /**
  53  * e_iterator_get:
  54  *
  55  * Returns: (transfer none): the iterator.
  56  */
  57 gconstpointer
  58 e_iterator_get (EIterator *iterator)
  59 {
  60         if (E_ITERATOR_GET_CLASS (iterator)->get)
  61                 return E_ITERATOR_GET_CLASS (iterator)->get (iterator);
  62         else
  63                 return NULL;
  64 }
  65
  66 void
  67 e_iterator_reset (EIterator *iterator)
  68 {
  69         if (E_ITERATOR_GET_CLASS (iterator)->reset)
  70                 E_ITERATOR_GET_CLASS (iterator)->reset (iterator);
  71 }
  72
  73 void
  74 e_iterator_last (EIterator *iterator)
  75 {
  76         if (E_ITERATOR_GET_CLASS (iterator)->last)
  77                 E_ITERATOR_GET_CLASS (iterator)->last (iterator);
  78 }
  79
  80 gboolean
  81 e_iterator_next (EIterator *iterator)
  82 {
  83         if (E_ITERATOR_GET_CLASS (iterator)->next)
  84                 return E_ITERATOR_GET_CLASS (iterator)->next (iterator);
  85         else
  86                 return FALSE;
  87 }
  88
  89 gboolean
  90 e_iterator_prev (EIterator *iterator)
  91 {
  92         if (E_ITERATOR_GET_CLASS (iterator)->prev)
  93                 return E_ITERATOR_GET_CLASS (iterator)->prev (iterator);
  94         else
  95                 return FALSE;
  96 }
  97
  98 void
  99 e_iterator_delete (EIterator *iterator)
 100 {
 101         if (E_ITERATOR_GET_CLASS (iterator)->remove)
 102                 E_ITERATOR_GET_CLASS (iterator)->remove (iterator);
 103 }
 104
 105 void
 106 e_iterator_insert (EIterator *iterator,
 107                    gconstpointer object,
 108                    gboolean before)
 109 {
 110         if (E_ITERATOR_GET_CLASS (iterator)->insert)
 111                 E_ITERATOR_GET_CLASS (iterator)->insert (iterator, object, before);
 112 }
 113
 114 void
 115 e_iterator_set (EIterator *iterator,
 116                 gconstpointer object)
 117 {
 118         if (E_ITERATOR_GET_CLASS (iterator)->set)
 119                 E_ITERATOR_GET_CLASS (iterator)->set (iterator, object);
 120 }
 121
 122 gboolean
 123 e_iterator_is_valid (EIterator *iterator)
 124 {
 125         if (!iterator)
 126                 return FALSE;
 127
 128         if (E_ITERATOR_GET_CLASS (iterator)->is_valid)
 129                 return E_ITERATOR_GET_CLASS (iterator)->is_valid (iterator);
 130         else
 131                 return FALSE;
 132 }
 133
 134 void
 135 e_iterator_invalidate (EIterator *iterator)
 136 {
 137         g_return_if_fail (iterator != NULL);
 138         g_return_if_fail (E_IS_ITERATOR (iterator));
 139
 140         g_signal_emit (iterator, e_iterator_signals[INVALIDATE], 0);
 141 }