aboutsummaryrefslogtreecommitdiffstats
path: root/embed/ephy-embed-shell.h
blob: e7d789d57c6fdd1c1395e7d3df2ea691517b8463 (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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
/*
 *  Copyright (C) 2000, 2001, 2002 Marco Pesenti Gritti
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2, or (at your option)
 *  any later version.
 *
 *  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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef EPHY_EMBED_SHELL_H
#define EPHY_EMBED_SHELL_H

#include "ephy-embed.h"
#include "ephy-favicon-cache.h"
#include "ephy-history.h"
#include "downloader-view.h"

#include <glib-object.h>
#include <glib.h>

G_BEGIN_DECLS

typedef struct EphyEmbedShellClass EphyEmbedShellClass;

#define EPHY_EMBED_SHELL_TYPE             (ephy_embed_shell_get_type ())
#define EPHY_EMBED_SHELL_IMPL             (ephy_embed_shell_get_impl ())
#define EPHY_EMBED_SHELL(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), EPHY_EMBED_SHELL_TYPE, EphyEmbedShell))
#define EPHY_EMBED_SHELL_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), EPHY_EMBED_SHELL_TYPE, EphyEmbedShellClass))
#define IS_EPHY_EMBED_SHELL(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), EPHY_EMBED_SHELL_TYPE))
#define IS_EPHY_EMBED_SHELL_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), EPHY_EMBED_SHELL_TYPE))
#define EPHY_EMBED_SHELL_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), EPHY_EMBED_SHELL_TYPE, EphyEmbedShellClass))

typedef struct EphyEmbedShell EphyEmbedShell;
typedef struct EphyEmbedShellPrivate EphyEmbedShellPrivate;

extern EphyEmbedShell *embed_shell;

/**
 * FilePickerMode: What mode FilePicker should run in
 */

typedef enum
{
        modeOpen = 0,
        modeSave = 1,
        modeGetFolder =2
} FilePickerMode;

typedef struct
{
        /* description of the file format */
        gchar *description;
        /* tipical sufixes, NULL terminated */
        gchar **extensions;
} FileFormat;

/**
 * Cookie: the type of cookies
 */
typedef struct
{
    gchar *domain;
        gchar *name;
        gchar *value;
        gchar *path;
        gchar *secure;
        gchar *expire;
} CookieInfo;

/**
 * Password: a password manager entry
 */
typedef struct
{
        gchar *host;
        gchar *username;
} PasswordInfo;

typedef struct
{
    const char *name;
    const char *title;
} CharsetInfo;

/**
 * PasswordType: To distinguish actual passwords from blocked password sites
 */
typedef enum
{
        PASSWORD_PASSWORD,
        PASSWORD_REJECT
} PasswordType;

typedef enum
{
    COOKIES_PERMISSION,
    IMAGES_PERMISSION
} PermissionType;

typedef enum
{
    DISK_CACHE = 2,
    MEMORY_CACHE = 1
} CacheType;

typedef enum
{
    CACHE_CLEAR_CAP = 1 << 0,
    OFFLINE_CAP = 1 << 1,
    PROXY_AUTOCONF_CAP = 1 << 2,
    JAVA_CONSOLE_CAP = 1 << 3,
    JS_CONSOLE_CAP = 1 << 4,
    CHARSETS_CAP = 1 << 5,
    COOKIES_CAP = 1 << 7,
    PASSWORDS_CAP = 1 << 8,
    FILEPICKER_CAP = 1 << 9
} EmbedShellCapabilities;

struct EphyEmbedShell
{
    GObject parent;
        EphyEmbedShellPrivate *priv;
};

struct EphyEmbedShellClass
{
        GObjectClass parent_class;

    void        (* new_window)          (EphyEmbedShell *shell,
                             EphyEmbed **new_embed,
                         EmbedChromeMask chromemask);

    void        (* command)             (EphyEmbedShell *shell,
                         char *command,
                         char *param);

    /* Methods */

    void        (* get_capabilities)    (EphyEmbedShell *shell,
                         EmbedShellCapabilities *caps);
    EphyHistory   * (* get_global_history)  (EphyEmbedShell *shell);
    DownloaderView* (* get_downloader_view) (EphyEmbedShell *shell);
    gresult         (* clear_cache)         (EphyEmbedShell *shell,
                         CacheType type);
    gresult         (* set_offline_mode)    (EphyEmbedShell *shell,
                         gboolean offline);
    gresult         (* load_proxy_autoconf) (EphyEmbedShell *shell,
                             const char* url);
    gresult         (* show_java_console)   (EphyEmbedShell *shell);
    gresult         (* show_js_console)     (EphyEmbedShell *shell);
    gresult     (* get_charset_groups)  (EphyEmbedShell *shell,
                         GList **groups);
    gresult         (* get_charset_titles)  (EphyEmbedShell *shell,
                         const char *group,
                         GList **charsets);
    gresult     (* get_font_list)   (EphyEmbedShell *shell,
                         const char *langGroup,
                         const char *fontType,
                         GList **fontList,
                         char **default_font);
    gresult         (* list_cookies)        (EphyEmbedShell *shell,
                         GList **cokies);
    gresult         (* remove_cookies)      (EphyEmbedShell *shell,
                         GList *cookies);
    gresult         (* list_passwords)      (EphyEmbedShell *shell,
                         PasswordType type,
                         GList **passwords);
    gresult         (* remove_passwords)    (EphyEmbedShell *shell,
                         GList *passwords,
                         PasswordType type);
    gresult         (* show_file_picker)    (EphyEmbedShell *shell,
                         GtkWidget *parentWidget,
                         const char* title,
                         const char* directory,
                         const char* file,
                         FilePickerMode mode,
                         char **ret_fullpath,
                         gboolean *ret_save_content,
                         FileFormat *file_formats,
                         gint *ret_file_format);
};

GType             ephy_embed_shell_get_type            (void);

GType             ephy_embed_shell_get_impl            (void);

EphyEmbedShell   *ephy_embed_shell_new                 (const char *type);

EphyFaviconCache *ephy_embed_shell_get_favicon_cache   (EphyEmbedShell *ges);

void              ephy_embed_shell_add_embed           (EphyEmbedShell *ges,
                            EphyEmbed *embed);

void              ephy_embed_shell_remove_embed        (EphyEmbedShell *ges,
                            EphyEmbed *embed);

EphyEmbed        *ephy_embed_shell_get_active_embed    (EphyEmbedShell *ges);

GList            *ephy_embed_shell_get_embeds          (EphyEmbedShell *ges);

void              ephy_embed_shell_get_capabilities    (EphyEmbedShell *shell,
                            EmbedShellCapabilities *caps);

EphyHistory      *ephy_embed_shell_get_global_history  (EphyEmbedShell *shell);

DownloaderView   *ephy_embed_shell_get_downloader_view (EphyEmbedShell *shell);

gresult           ephy_embed_shell_clear_cache         (EphyEmbedShell *shell,
                            CacheType type);

gresult           ephy_embed_shell_set_offline_mode    (EphyEmbedShell *shell,
                            gboolean offline);

gresult           ephy_embed_shell_load_proxy_autoconf (EphyEmbedShell *shell,
                            const char* url);

/* Charsets */
gresult       ephy_embed_shell_get_charset_groups  (EphyEmbedShell *shell,
                            GList **groups);

gresult           ephy_embed_shell_get_charset_titles  (EphyEmbedShell *shell,
                            const char *group,
                            GList **charsets);

gresult           ephy_embed_shell_get_font_list       (EphyEmbedShell *shell,
                            const char *langGroup,
                            const char *fontType,
                            GList **fontList,
                            char **default_font);

/* Cookies */
gresult           ephy_embed_shell_list_cookies        (EphyEmbedShell *shell,
                            GList **cookies);

gresult           ephy_embed_shell_remove_cookies      (EphyEmbedShell *shell,
                            GList *cookies);

gresult       ephy_embed_shell_free_cookies        (EphyEmbedShell *shell,
                            GList *cookies);

/* Passwords */
gresult           ephy_embed_shell_list_passwords      (EphyEmbedShell *shell,
                            PasswordType type,
                            GList **passwords);

gresult       ephy_embed_shell_free_passwords      (EphyEmbedShell *shell,
                            GList *passwords);

gresult           ephy_embed_shell_remove_passwords    (EphyEmbedShell *shell,
                            GList *passwords,
                            PasswordType type);

gresult           ephy_embed_shell_show_file_picker    (EphyEmbedShell *shell,
                            GtkWidget *parentWidget,
                            const char *title,
                            const char *directory,
                            const char *file,
                            FilePickerMode mode,
                            char **ret_fullpath,
                            gboolean *ret_save_content,
                            FileFormat *file_formats,
                            int *ret_file_format);

G_END_DECLS

#endif