aboutsummaryrefslogtreecommitdiffstats
path: root/shell/e-shell.h
blob: f1d76b9ea614940f307dc306b635798918a349f2 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/*
 * 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;

/**
 * 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);
    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);
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);
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);
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 */