Files
evolution/e-util/e-source-util.h
Matthew Barnes d09d8de870 Consolidate base utility libraries into libeutil.
Evolution consists of entirely too many small utility libraries, which
increases linking and loading time, places a burden on higher layers of
the application (e.g. modules) which has to remember to link to all the
small in-tree utility libraries, and makes it difficult to generate API
documentation for these utility libraries in one Gtk-Doc module.

Merge the following utility libraries under the umbrella of libeutil,
and enforce a single-include policy on libeutil so we can reorganize
the files as desired without disrupting its pseudo-public API.

   libemail-utils/libemail-utils.la
   libevolution-utils/libevolution-utils.la
   filter/libfilter.la
   widgets/e-timezone-dialog/libetimezonedialog.la
   widgets/menus/libmenus.la
   widgets/misc/libemiscwidgets.la
   widgets/table/libetable.la
   widgets/text/libetext.la

This also merges libedataserverui from the Evolution-Data-Server module,
since Evolution is its only consumer nowadays, and I'd like to make some
improvements to those APIs without concern for backward-compatibility.

And finally, start a Gtk-Doc module for libeutil.  It's going to be a
project just getting all the symbols _listed_ much less _documented_.
But the skeletal structure is in place and I'm off to a good start.
2012-12-12 14:33:43 -05:00

49 lines
1.6 KiB
C

/*
* e-source-util.h
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) version 3.
*
* 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with the program; if not, see <http://www.gnu.org/licenses/>
*
*/
#if !defined (__E_UTIL_H_INSIDE__) && !defined (LIBEUTIL_COMPILATION)
#error "Only <e-util/e-util.h> should be included directly."
#endif
/* These functions combine asynchronous ESource and ESourceRegistry methods
* with Evolution's EActivity and EAlert facilities to offer an easy-to-use,
* "fire-and-forget" API for ESource operations. Use these in situations
* where it's sufficient to just display an error message if the operation
* fails, and you don't need to operate on the result. */
#ifndef E_SOURCE_UTIL_H
#define E_SOURCE_UTIL_H
#include <libedataserver/libedataserver.h>
#include <e-util/e-activity.h>
#include <e-util/e-alert-sink.h>
G_BEGIN_DECLS
EActivity * e_source_util_remove (ESource *source,
EAlertSink *alert_sink);
EActivity * e_source_util_write (ESource *source,
EAlertSink *alert_sink);
EActivity * e_source_util_remote_delete (ESource *source,
EAlertSink *alert_sink);
G_END_DECLS
#endif /* E_SOURCE_UTIL_H */