diff options
author | Matthew Barnes <mbarnes@redhat.com> | 2012-12-10 21:09:59 +0800 |
---|---|---|
committer | Matthew Barnes <mbarnes@redhat.com> | 2012-12-13 03:33:43 +0800 |
commit | d09d8de870b6697c8a8b262e7e077b871a69b315 (patch) | |
tree | 3b718882e7a0bb0a996daf2967a033d91714c9b5 /e-util/e-source-config.h | |
parent | b61331ed03ac1c7a9b8614e25510040b9c60ae02 (diff) | |
download | gsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.tar gsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.tar.gz gsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.tar.bz2 gsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.tar.lz gsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.tar.xz gsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.tar.zst gsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.zip |
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.
Diffstat (limited to 'e-util/e-source-config.h')
-rw-r--r-- | e-util/e-source-config.h | 120 |
1 files changed, 120 insertions, 0 deletions
diff --git a/e-util/e-source-config.h b/e-util/e-source-config.h new file mode 100644 index 0000000000..3868c0309b --- /dev/null +++ b/e-util/e-source-config.h @@ -0,0 +1,120 @@ +/* + * e-source-config.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 + +#ifndef E_SOURCE_CONFIG_H +#define E_SOURCE_CONFIG_H + +#include <gtk/gtk.h> +#include <libedataserver/libedataserver.h> + +/* Standard GObject macros */ +#define E_TYPE_SOURCE_CONFIG \ + (e_source_config_get_type ()) +#define E_SOURCE_CONFIG(obj) \ + (G_TYPE_CHECK_INSTANCE_CAST \ + ((obj), E_TYPE_SOURCE_CONFIG, ESourceConfig)) +#define E_SOURCE_CONFIG_CLASS(cls) \ + (G_TYPE_CHECK_CLASS_CAST \ + ((cls), E_TYPE_SOURCE_CONFIG, ESourceConfigClass)) +#define E_IS_SOURCE_CONFIG(obj) \ + (G_TYPE_CHECK_INSTANCE_TYPE \ + ((obj), E_TYPE_SOURCE_CONFIG)) +#define E_IS_SOURCE_CONFIG_CLASS(cls) \ + (G_TYPE_CHECK_CLASS_TYPE \ + ((cls), E_TYPE_SOURCE_CONFIG)) +#define E_SOURCE_CONFIG_GET_CLASS(obj) \ + (G_TYPE_INSTANCE_GET_CLASS \ + ((obj), E_TYPE_SOURCE_CONFIG, ESourceConfigClass)) + +G_BEGIN_DECLS + +typedef struct _ESourceConfig ESourceConfig; +typedef struct _ESourceConfigClass ESourceConfigClass; +typedef struct _ESourceConfigPrivate ESourceConfigPrivate; + +struct _ESourceConfig { + GtkBox parent; + ESourceConfigPrivate *priv; +}; + +struct _ESourceConfigClass { + GtkBoxClass parent_class; + + /* Methods */ + const gchar * (*get_backend_extension_name) + (ESourceConfig *config); + GList * (*list_eligible_collections) + (ESourceConfig *config); + + /* Signals */ + void (*init_candidate) (ESourceConfig *config, + ESource *scratch_source); + gboolean (*check_complete) (ESourceConfig *config, + ESource *scratch_source); + void (*commit_changes) (ESourceConfig *config, + ESource *scratch_source); + void (*resize_window) (ESourceConfig *config); +}; + +GType e_source_config_get_type (void) G_GNUC_CONST; +GtkWidget * e_source_config_new (ESourceRegistry *registry, + ESource *original_source); +void e_source_config_insert_widget (ESourceConfig *config, + ESource *scratch_source, + const gchar *caption, + GtkWidget *widget); +GtkWidget * e_source_config_get_page (ESourceConfig *config, + ESource *scratch_source); +const gchar * e_source_config_get_backend_extension_name + (ESourceConfig *config); +GList * e_source_config_list_eligible_collections + (ESourceConfig *config); +gboolean e_source_config_check_complete (ESourceConfig *config); +ESource * e_source_config_get_original_source + (ESourceConfig *config); +ESource * e_source_config_get_collection_source + (ESourceConfig *config); +ESourceRegistry * + e_source_config_get_registry (ESourceConfig *config); +void e_source_config_resize_window (ESourceConfig *config); +void e_source_config_commit (ESourceConfig *config, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); +gboolean e_source_config_commit_finish (ESourceConfig *config, + GAsyncResult *result, + GError **error); + +/* Convenience functions for common settings. */ +void e_source_config_add_refresh_interval + (ESourceConfig *config, + ESource *scratch_source); +void e_source_config_add_secure_connection + (ESourceConfig *config, + ESource *scratch_source); +void e_source_config_add_secure_connection_for_webdav + (ESourceConfig *config, + ESource *scratch_source); +void e_source_config_add_user_entry (ESourceConfig *config, + ESource *scratch_source); + +#endif /* E_SOURCE_CONFIG_H */ |