/*
* 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
* 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/>
*
*
* Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
*
*/
#ifndef E_SHELL_H
#define E_SHELL_H
#include <unique/unique.h>
#include <gconf/gconf-client.h>
#include <e-util/e-activity.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;
/**
* EShellQuitReason:
*
* @E_SHELL_QUIT_ACTION:
* @E_SHELL_WINDOW_ACTION_QUIT was activated.
* @E_SHELL_QUIT_LAST_WINDOW:
* The last watched window has been destroyed.
* @E_SHELL_QUIT_OPTION:
* The program was invoked with --quit. Extensions will never
* see this value because they are not loaded when --quit is given.
* @E_SHELL_QUIT_REMOTE_REQUEST:
* Another Evolution process requested we quit.
* @E_SHELL_QUIT_SESSION_REQUEST:
* The desktop session requested we quit.
*
* These values are passed in the #EShell::quit-requested signal to
* indicate why the shell is requesting to shut down.
**/
typedef enum {
E_SHELL_QUIT_ACTION,
E_SHELL_QUIT_LAST_WINDOW,
E_SHELL_QUIT_OPTION,
E_SHELL_QUIT_REMOTE_REQUEST,
E_SHELL_QUIT_SESSION_REQUEST
} EShellQuitReason;
/**
* EShell:
*
* Contains only private data that should be read and manipulated using the
* functions below.
**/
struct _EShell {
UniqueApp parent;
EShellPrivate *priv;
};
struct _EShellClass {
UniqueAppClass parent_class;
gboolean (*handle_uri) (EShell *shell,
const gchar *uri);
void (*prepare_for_offline) (EShell *shell,
EActivity *activity);
void (*prepare_for_online) (EShell *shell,
EActivity *activity);
void (*prepare_for_quit) (EShell *shell,
EActivity *activity);
void (*quit_requested) (EShell *shell,
EShellQuitReason reason);
void (*send_receive) (EShell *shell,
GtkWindow *parent);
void (*window_created) (EShell *shell,
GtkWindow *window);
void (*window_destroyed) (EShell *shell);
};
GType e_shell_get_type (void);
EShell * e_shell_get_default (void);
void e_shell_load_modules (EShell *shell);
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,
gboolean do_import);
void e_shell_watch_window (EShell *shell,
GtkWindow *window);
GList * e_shell_get_watched_windows (EShell *shell);
GtkWindow * e_shell_get_active_window (EShell *shell);
void e_shell_send_receive (EShell *shell,
GtkWindow *parent);
gboolean e_shell_get_meego_mode (EShell *shell);
gboolean e_shell_get_express_mode (EShell *shell);
gboolean e_shell_get_small_screen_mode (EShell *shell);
const gchar * e_shell_get_module_directory (EShell *shell);
gboolean e_shell_get_network_available (EShell *shell);
void e_shell_set_network_available (EShell *shell,
gboolean network_available);
void e_shell_lock_network_available (EShell *shell);
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_quit (EShell *shell,
EShellQuitReason reason);
void e_shell_cancel_quit (EShell *shell);
void e_shell_adapt_window_size (EShell *shell,
GtkWindow *window);
void e_shell_set_startup_view (EShell *shell,
const gchar *view);
const gchar * e_shell_get_startup_view (EShell *shell);
G_END_DECLS
#endif /* E_SHELL_H */
