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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
/*
* e-shell-module.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)
*
*/
/**
* SECTION: e-shell-module
* @short_description: dynamically loaded capabilities
* @include: shell/e-shell-module.h
**/
#ifndef E_SHELL_MODULE_H
#define E_SHELL_MODULE_H
#include <shell/e-shell-common.h>
#include <widgets/misc/e-activity.h>
/* Standard GObject macros */
#define E_TYPE_SHELL_MODULE \
(e_shell_module_get_type ())
#define E_SHELL_MODULE(obj) \
(G_TYPE_CHECK_INSTANCE_CAST \
((obj), E_TYPE_SHELL_MODULE, EShellModule))
#define E_SHELL_MODULE_CLASS(cls) \
(G_TYPE_CHECK_CLASS_CAST \
((cls), E_TYPE_SHELL_MODULE, EShellModuleClass))
#define E_IS_SHELL_MODULE(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE \
((obj), E_TYPE_SHELL_MODULE))
#define E_IS_SHELL_MODULE_CLASS(cls) \
(G_TYPE_CHECK_CLASS_TYPE \
((cls), E_TYPE_SHELL_MODULE))
#define E_SHELL_MODULE_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS \
((obj), E_TYPE_SHELL_MODULE, EShellModuleClass))
G_BEGIN_DECLS
/* Avoid including <e-shell.h>, because it includes us! */
struct _EShell;
typedef struct _EShellModule EShellModule;
typedef struct _EShellModuleInfo EShellModuleInfo;
typedef struct _EShellModuleClass EShellModuleClass;
typedef struct _EShellModulePrivate EShellModulePrivate;
/**
* EShellModuleInfo:
* @name: The name of the module. Also becomes the name of
* the corresponding #EShellView subclass that the
* module will register.
* @aliases: Colon-separated list of aliases that can be used
* when referring to a module by name.
* @schemes: Colon-separated list of URI schemes. The #EShell
* will forward command-line URIs to the appropriate
* module based on this list.
* @sort_order: Used to determine the order of modules listed in
* the main menu and in the switcher. See
* e_shell_module_compare().
* @start: Callback for notifying the module to begin loading data
* and running background tasks. This is called just before
* the first instantiation of the corresponding #EShellView
* subclass. It allows the module to delay initialization
* steps that consume significant resources until they are
* actually needed.
* @is_busy: Callback for querying whether the module has
* operations in progress that cannot be cancelled
* or finished immediately. Returning %TRUE prevents
* the application from shutting down.
* @shutdown: Callback for notifying the module to begin
* shutting down. Returning %FALSE indicates there
* are still unfinished operations and the #EShell
* should check back shortly.
* @migrate: Callback for notifying the module to migrate data and
* settings from the given version. Returns %TRUE if the
* migration was successful or if no action was necessary.
* Returns %FALSE and sets a #GError if the migration failed.
*
* Provides basic information about an #EShellModule instance. Shell
* modules should pass this structure to e_shell_module_set_info() in
* their "e_shell_module_init" functions.
**/
struct _EShellModuleInfo {
const gchar *name;
const gchar *aliases;
const gchar *schemes;
gint sort_order;
void (*start) (EShellModule *shell_module);
gboolean (*is_busy) (EShellModule *shell_module);
gboolean (*shutdown) (EShellModule *shell_module);
gboolean (*migrate) (EShellModule *shell_module,
gint major,
gint minor,
gint micro,
GError **error);
};
/**
* EShellModule:
*
* Contains only private data that should be read and manipulated using the
* functions below.
**/
struct _EShellModule {
GTypeModule parent;
EShellModulePrivate *priv;
};
struct _EShellModuleClass {
GTypeModuleClass parent_class;
};
GType e_shell_module_get_type (void);
EShellModule * e_shell_module_new (struct _EShell *shell,
const gchar *filename);
gint e_shell_module_compare (EShellModule *shell_module_a,
EShellModule *shell_module_b);
const gchar * e_shell_module_get_config_dir (EShellModule *shell_module);
const gchar * e_shell_module_get_data_dir (EShellModule *shell_module);
const gchar * e_shell_module_get_filename (EShellModule *shell_module);
struct _EShell *e_shell_module_get_shell (EShellModule *shell_module);
GType e_shell_module_get_shell_view_type
(EShellModule *shell_module);
void e_shell_module_add_activity (EShellModule *shell_module,
EActivity *activity);
void e_shell_module_start (EShellModule *shell_module);
gboolean e_shell_module_is_busy (EShellModule *shell_module);
gboolean e_shell_module_shutdown (EShellModule *shell_module);
gboolean e_shell_module_migrate (EShellModule *shell_module,
gint major,
gint minor,
gint micro,
GError **error);
void e_shell_module_set_info (EShellModule *shell_module,
const EShellModuleInfo *info,
GType shell_view_type);
G_END_DECLS
#endif /* E_SHELL_MODULE_H */
|
