e-util/e-source-util.h

   1 /*
   2  * e-source-util.h
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU Lesser General Public License as published by
   6  * the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  10  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  11  * for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public License
  14  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  15  *
  16  */
  17
  18 #if !defined (__E_UTIL_H_INSIDE__) && !defined (LIBEUTIL_COMPILATION)
  19 #error "Only <e-util/e-util.h> should be included directly."
  20 #endif
  21
  22 /* These functions combine asynchronous ESource and ESourceRegistry methods
  23  * with Evolution's EActivity and EAlert facilities to offer an easy-to-use,
  24  * "fire-and-forget" API for ESource operations.  Use these in situations
  25  * where it's sufficient to just display an error message if the operation
  26  * fails, and you don't need to operate on the result. */
  27
  28 #ifndef E_SOURCE_UTIL_H
  29 #define E_SOURCE_UTIL_H
  30
  31 #include <libedataserver/libedataserver.h>
  32
  33 #include <e-util/e-activity.h>
  34 #include <e-util/e-alert-sink.h>
  35
  36 G_BEGIN_DECLS
  37
  38 EActivity *     e_source_util_remove            (ESource *source,
  39                                                  EAlertSink *alert_sink);
  40 EActivity *     e_source_util_write             (ESource *source,
  41                                                  EAlertSink *alert_sink);
  42 EActivity *     e_source_util_remote_delete     (ESource *source,
  43                                                  EAlertSink *alert_sink);
  44
  45 G_END_DECLS
  46
  47 #endif /* E_SOURCE_UTIL_H */