diff options
Diffstat (limited to 'shell/e-shell.h')
-rw-r--r-- | shell/e-shell.h | 205 |
1 files changed, 85 insertions, 120 deletions
diff --git a/shell/e-shell.h b/shell/e-shell.h index e8451e3b5b..1d0b9ab705 100644 --- a/shell/e-shell.h +++ b/shell/e-shell.h @@ -1,4 +1,6 @@ /* + * e-shell.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 @@ -13,136 +15,99 @@ * License along with the program; if not, see <http://www.gnu.org/licenses/> * * - * Authors: - * Ettore Perazzoli <ettore@ximian.com> - * * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com) * */ -#ifndef _E_SHELL_H_ -#define _E_SHELL_H_ - -#include <bonobo-activation/bonobo-activation.h> -#include <bonobo/bonobo-object.h> - -#ifdef __cplusplus -extern "C" { -#pragma } -#endif /* __cplusplus */ - -typedef struct _EShell EShell; +/** + * SECTION: e-shell + * @short_description: the backbone of Evolution + * @include: shell/e-shell.h + **/ + +#ifndef E_SHELL_H +#define E_SHELL_H + +#include <unique/unique.h> +#include <gconf/gconf-client.h> +#include <shell/e-shell-common.h> +#include <shell/e-shell-backend.h> +#include <shell/e-shell-settings.h> + +/* Standard GObject macros */ +#define E_TYPE_SHELL \ + (e_shell_get_type ()) +#define E_SHELL(obj) \ + (G_TYPE_CHECK_INSTANCE_CAST \ + ((obj), E_TYPE_SHELL, EShell)) +#define E_SHELL_CLASS(cls) \ + (G_TYPE_CHECK_CLASS_CAST \ + ((cls), E_TYPE_SHELL, EShellClass)) +#define E_IS_SHELL(obj) \ + (G_TYPE_CHECK_INSTANCE_TYPE \ + ((obj), E_TYPE_SHELL)) +#define E_IS_SHELL_CLASS(cls) \ + (G_TYPE_CHECK_CLASS_TYPE \ + ((cls), E_TYPE_SHELL)) +#define E_SHELL_GET_CLASS(obj) \ + (G_TYPE_INSTANCE_GET_CLASS \ + ((obj), E_TYPE_SHELL, EShellClass)) + +G_BEGIN_DECLS + +typedef struct _EShell EShell; +typedef struct _EShellClass EShellClass; typedef struct _EShellPrivate EShellPrivate; -typedef struct _EShellClass EShellClass; - -#include "Evolution.h" - -#include "e-component-registry.h" -#include "e-shell-window.h" - - -#define E_TYPE_SHELL (e_shell_get_type ()) -#define E_SHELL(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), E_TYPE_SHELL, EShell)) -#define E_SHELL_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), E_TYPE_SHELL, EShellClass)) -#define E_IS_SHELL(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), E_TYPE_SHELL)) -#define E_IS_SHELL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((obj), E_TYPE_SHELL)) - - -enum _EShellLineStatus { - E_SHELL_LINE_STATUS_ONLINE, - E_SHELL_LINE_STATUS_GOING_OFFLINE, /* NB: really means changing state in either direction */ - E_SHELL_LINE_STATUS_OFFLINE, - E_SHELL_LINE_STATUS_FORCED_OFFLINE -}; -typedef enum _EShellLineStatus EShellLineStatus; - -enum _EShellStartupLineMode { - E_SHELL_STARTUP_LINE_MODE_CONFIG, - E_SHELL_STARTUP_LINE_MODE_ONLINE, - E_SHELL_STARTUP_LINE_MODE_OFFLINE -}; -typedef enum _EShellStartupLineMode EShellStartupLineMode; +/** + * EShell: + * + * Contains only private data that should be read and manipulated using the + * functions below. + **/ struct _EShell { - BonoboObject parent; - + UniqueApp parent; EShellPrivate *priv; }; struct _EShellClass { - BonoboObjectClass parent_class; - - POA_GNOME_Evolution_Shell__epv epv; - - void (* no_windows_left) (EShell *shell); - void (* line_status_changed) (EShell *shell, EShellLineStatus status); - void (* new_window_created) (EShell *shell, EShellWindow *window); -}; - - -/* ID for registering the shell in the OAF name service. */ -#define E_SHELL_OAFIID "OAFIID:GNOME_Evolution_Shell:" BASE_VERSION - -enum _EShellConstructResult { - E_SHELL_CONSTRUCT_RESULT_OK, - E_SHELL_CONSTRUCT_RESULT_INVALIDARG, - E_SHELL_CONSTRUCT_RESULT_CANNOTREGISTER, - E_SHELL_CONSTRUCT_RESULT_NOCONFIGDB, - E_SHELL_CONSTRUCT_RESULT_GENERICERROR + UniqueAppClass parent_class; }; -typedef enum _EShellConstructResult EShellConstructResult; - - -GType e_shell_get_type (void); -EShellConstructResult e_shell_construct (EShell *shell, - const char *iid, - EShellStartupLineMode startup_line_mode); -EShell *e_shell_new (EShellStartupLineMode startup_line_mode, - EShellConstructResult *construct_result_return); - -gboolean e_shell_attempt_upgrade (EShell *shell); - -EShellWindow *e_shell_create_window (EShell *shell, - const char *component_id, - EShellWindow *template_window); -gboolean e_shell_request_close_window (EShell *shell, - EShellWindow *window); - - -#if 0 -EUriSchemaRegistry *e_shell_peek_uri_schema_registry (EShell *shell); -#endif - -EComponentRegistry *e_shell_peek_component_registry (EShell *shell); - -gboolean e_shell_save_settings (EShell *shell); -void e_shell_close_all_windows (EShell *shell); - -EShellLineStatus e_shell_get_line_status (EShell *shell); -void e_shell_set_line_status (EShell *shell, - GNOME_Evolution_ShellState shell_state); - -gboolean e_shell_get_crash_recovery (EShell *shell); -void e_shell_set_crash_recovery (EShell *shell, - gboolean crash_recovery); - -void e_shell_send_receive (EShell *shell); - -void e_shell_show_settings (EShell *shell, - const char *type, - EShellWindow *shell_window); - -gboolean e_shell_can_quit (EShell *shell); -gboolean e_shell_do_quit (EShell *shell); -gboolean e_shell_quit (EShell *shell); - -const char *e_shell_construct_result_to_string (EShellConstructResult result); - -typedef gboolean (*EMainShellFunc) (EShell *shell, EShellWindow *window, gpointer user_data); -void e_shell_foreach_shell_window (EShell *shell, EMainShellFunc func, gpointer user_data); - -#ifdef __cplusplus -} -#endif /* __cplusplus */ -#endif /* _E_SHELL_H_ */ +GType e_shell_get_type (void); +EShell * e_shell_get_default (void); +GList * e_shell_get_shell_backends (EShell *shell); +const gchar * e_shell_get_canonical_name (EShell *shell, + const gchar *name); +EShellBackend * e_shell_get_backend_by_name (EShell *shell, + const gchar *name); +EShellBackend * e_shell_get_backend_by_scheme (EShell *shell, + const gchar *scheme); +EShellSettings *e_shell_get_shell_settings (EShell *shell); +GConfClient * e_shell_get_gconf_client (EShell *shell); +GtkWidget * e_shell_create_shell_window (EShell *shell, + const gchar *view_name); +guint e_shell_handle_uris (EShell *shell, + gchar **uris); +void e_shell_watch_window (EShell *shell, + GtkWindow *window); +GList * e_shell_get_watched_windows (EShell *shell); +void e_shell_send_receive (EShell *shell, + GtkWindow *parent); +gboolean e_shell_get_network_available (EShell *shell); +void e_shell_set_network_available (EShell *shell, + gboolean network_available); +gboolean e_shell_get_online (EShell *shell); +void e_shell_set_online (EShell *shell, + gboolean online); +GtkWidget * e_shell_get_preferences_window (EShell *shell); +void e_shell_event (EShell *shell, + const gchar *event_name, + gpointer event_data); +gboolean e_shell_is_busy (EShell *shell); +gboolean e_shell_do_quit (EShell *shell); +gboolean e_shell_quit (EShell *shell); + +G_END_DECLS + +#endif /* E_SHELL_H */ |