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-alert.h | |
parent | b61331ed03ac1c7a9b8614e25510040b9c60ae02 (diff) | |
download | gsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.tar.gz 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-alert.h')
-rw-r--r-- | e-util/e-alert.h | 119 |
1 files changed, 119 insertions, 0 deletions
diff --git a/e-util/e-alert.h b/e-util/e-alert.h new file mode 100644 index 0000000000..f62e612235 --- /dev/null +++ b/e-util/e-alert.h @@ -0,0 +1,119 @@ +/* + * 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/> + * + * + * Authors: + * Michael Zucchi <notzed@ximian.com> + * Jonathon Jongsma <jonathon.jongsma@collabora.co.uk> + * + * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com) + * Copyright (C) 2009 Intel Corporation + * + */ + +#ifndef E_ALERT_H +#define E_ALERT_H + +#include <stdarg.h> +#include <gtk/gtk.h> + +/* Standard GObject macros */ +#define E_TYPE_ALERT \ + (e_alert_get_type ()) +#define E_ALERT(obj) \ + (G_TYPE_CHECK_INSTANCE_CAST \ + ((obj), E_TYPE_ALERT, EAlert)) +#define E_ALERT_CLASS(cls) \ + (G_TYPE_CHECK_CLASS_CAST \ + ((cls), E_TYPE_ALERT, EAlertClass)) +#define E_IS_ALERT(obj) \ + (G_TYPE_CHECK_INSTANCE_TYPE \ + ((obj), E_TYPE_ALERT)) +#define E_IS_ALERT_CLASS(cls) \ + (G_TYPE_CHECK_CLASS_TYPE \ + ((cls), E_TYPE_ALERT)) +#define E_ALERT_GET_CLASS(obj) \ + (G_TYPE_INSTANCE_GET_CLASS \ + ((obj), E_TYPE_ALERT, EAlertClass)) + +/* takes filename, returns OK if yes */ +#define E_ALERT_ASK_FILE_EXISTS_OVERWRITE \ + "system:ask-save-file-exists-overwrite" +/* takes filename, reason */ +#define E_ALERT_NO_SAVE_FILE "system:no-save-file" +/* takes filename, reason */ +#define E_ALERT_NO_LOAD_FILE "system:no-save-file" + +G_BEGIN_DECLS + +struct _EAlertSink; + +typedef struct _EAlert EAlert; +typedef struct _EAlertClass EAlertClass; +typedef struct _EAlertPrivate EAlertPrivate; + +struct _EAlert { + GObject parent; + EAlertPrivate *priv; +}; + +struct _EAlertClass { + GObjectClass parent_class; + + /* Signals */ + void (*response) (EAlert *alert, + gint response_id); +}; + +GType e_alert_get_type (void); +EAlert * e_alert_new (const gchar *tag, + ...) G_GNUC_NULL_TERMINATED; +EAlert * e_alert_new_valist (const gchar *tag, + va_list va); +EAlert * e_alert_new_array (const gchar *tag, + GPtrArray *args); +gint e_alert_get_default_response (EAlert *alert); +void e_alert_set_default_response (EAlert *alert, + gint response_id); +GtkMessageType e_alert_get_message_type (EAlert *alert); +void e_alert_set_message_type (EAlert *alert, + GtkMessageType message_type); +const gchar * e_alert_get_primary_text (EAlert *alert); +void e_alert_set_primary_text (EAlert *alert, + const gchar *primary_text); +const gchar * e_alert_get_secondary_text (EAlert *alert); +void e_alert_set_secondary_text (EAlert *alert, + const gchar *secondary_text); +const gchar * e_alert_get_stock_id (EAlert *alert); +void e_alert_add_action (EAlert *alert, + GtkAction *action, + gint response_id); +GList * e_alert_peek_actions (EAlert *alert); +GtkWidget * e_alert_create_image (EAlert *alert, + GtkIconSize size); +void e_alert_response (EAlert *alert, + gint response_id); +void e_alert_start_timer (EAlert *alert, + guint seconds); + +void e_alert_submit (struct _EAlertSink *alert_sink, + const gchar *tag, + ...) G_GNUC_NULL_TERMINATED; +void e_alert_submit_valist (struct _EAlertSink *alert_sink, + const gchar *tag, + va_list va); + +G_END_DECLS + +#endif /* E_ALERT_H */ |