aboutsummaryrefslogtreecommitdiffstats
path: root/embed/ephy-embed-single.c
blob: f24fef1c6783d2b91147c15ce98a5d9f58192502 (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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 /*
 *  Copyright © 2000-2003 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

#include "config.h"

#include "ephy-embed-single.h"
#include "ephy-embed-type-builtins.h"
#include "ephy-marshal.h"
#include "ephy-signal-accumulator.h"

static void ephy_embed_single_iface_init (gpointer g_class);

GType
ephy_embed_single_get_type (void)
{
    static GType type = 0;

    if (G_UNLIKELY (type == 0))
    {
        const GTypeInfo our_info =
        {
            sizeof (EphyEmbedSingleIface),
            ephy_embed_single_iface_init,
            NULL,
        };

        type = g_type_register_static (G_TYPE_INTERFACE,
                           "EphyEmbedSingle",
                           &our_info,
                           (GTypeFlags) 0);
    }

    return type;
}

static void
ephy_embed_single_iface_init (gpointer g_iface)
{
    static gboolean initialised = FALSE;

    if (initialised == FALSE)
    {
/**
 * EphyEmbedSingle::new-window:
 * @single:
 * @parent_embed: the #EphyEmbed requesting the new window, or %NULL
 * @mask: a #EphyEmbedChrome
 *
 * The ::new_window signal is emitted when a new window needs to be opened.
 * For example, when a JavaScript popup window was opened.
 *
 * Return a new #EphyEmbed.
 **/
    g_signal_new ("new-window",
              EPHY_TYPE_EMBED_SINGLE,
              G_SIGNAL_RUN_FIRST | G_SIGNAL_RUN_LAST,
              G_STRUCT_OFFSET (EphyEmbedSingleIface, new_window),
              ephy_signal_accumulator_object, ephy_embed_get_type,
              ephy_marshal_OBJECT__OBJECT_FLAGS,
              GTK_TYPE_WIDGET,
              2,
              GTK_TYPE_WIDGET,
              EPHY_TYPE_EMBED_CHROME);

/**
 * EphyEmbedSingle::handle_content:
 * @single:
 * @mime_type: the MIME type of the content
 * @address: the URL to the content
 *
 * The ::handle_content signal is emitted when encountering content of a mime
 * type Epiphany is unable to handle itself.
 *
 * If a connected callback returns %TRUE, the signal will stop propagating. For
 * example, this could be used by a download manager to prevent other
 * ::handle_content listeners from being called.
 **/
    g_signal_new ("handle_content",
              EPHY_TYPE_EMBED_SINGLE,
              G_SIGNAL_RUN_LAST,
              G_STRUCT_OFFSET (EphyEmbedSingleIface, handle_content),
              g_signal_accumulator_true_handled, NULL,
              ephy_marshal_BOOLEAN__STRING_STRING,
              G_TYPE_BOOLEAN,
              2,
              G_TYPE_STRING,
              G_TYPE_STRING);

/**
 * EphyEmbedSingle::add-sidebar:
 * @single:
 * @url: The url of the sidebar to be added
 * @title: The title of the sidebar to be added
 *
 * The ::add-sidebar signal is emitted when the user clicks a javascript link that
 * requests adding a url to the sidebar.
 **/
    g_signal_new ("add-sidebar",
              EPHY_TYPE_EMBED_SINGLE,
              G_SIGNAL_RUN_LAST,
              G_STRUCT_OFFSET (EphyEmbedSingleIface, add_sidebar),
              g_signal_accumulator_true_handled, NULL,
              ephy_marshal_BOOLEAN__STRING_STRING,
              G_TYPE_BOOLEAN,
              2,
              G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE,
              G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE);

/**
 * EphyEmbedSingle::add-search-engine
 * @single:
 * @url: The url of the search engine definition file
 * @icon_url: The url of the icon to use for this engine
 * @title: The title of the search engine to be added
 *
 * The ::add-search-engine signal is emitted when the user clicks a javascript link that
 * requests adding a search engine to the sidebar.
 **/
    g_signal_new ("add-search-engine",
              EPHY_TYPE_EMBED_SINGLE,
              G_SIGNAL_RUN_LAST,
              G_STRUCT_OFFSET (EphyEmbedSingleIface, add_search_engine),
              g_signal_accumulator_true_handled, NULL,
              ephy_marshal_BOOLEAN__STRING_STRING_STRING,
              G_TYPE_BOOLEAN,
              3,
              G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE,
              G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE,
              G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE);

/**
 * EphyEmbedSingle::network-status:
 * 
 * Whether the network is on-line.
 */
    g_object_interface_install_property
        (g_iface,
         g_param_spec_boolean ("network-status",
                       "network-status",
                       "network-status",
                       FALSE,
                       G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB));

    initialised = TRUE;
    }
}

/**
 * ephy_embed_single_init:
 * @single: the #EphyEmbedSingle
 * 
 * Performs startup initialisations. Must be called before calling
 * any other methods.
 **/
gboolean
ephy_embed_single_init (EphyEmbedSingle *single)
{
    EphyEmbedSingleIface *iface = EPHY_EMBED_SINGLE_GET_IFACE (single);
    return iface->init (single);
}

/**
 * ephy_embed_single_clear_cache:
 * @single: the #EphyEmbedSingle
 * 
 * Clears the Mozilla cache (temporarily saved web pages).
 **/
void
ephy_embed_single_clear_cache (EphyEmbedSingle *single)
{
    EphyEmbedSingleIface *iface = EPHY_EMBED_SINGLE_GET_IFACE (single);
    iface->clear_cache (single);
}

/**
 * ephy_embed_single_clear_auth_cache:
 * @single: the #EphyEmbedSingle
 * 
 * Clears the Mozilla HTTP authentication cache.
 *
 * This does not clear regular website passwords; it only clears the HTTP
 * authentication cache. Websites which use HTTP authentication require the
 * browser to send a password along with every HTTP request; the browser will
 * ask the user for the password once and then cache the password for subsequent
 * HTTP requests. This function will clear the HTTP authentication cache,
 * meaning the user will have to re-enter a username and password the next time
 * Epiphany requests a web page secured with HTTP authentication.
 **/
void
ephy_embed_single_clear_auth_cache (EphyEmbedSingle *single)
{
    EphyEmbedSingleIface *iface = EPHY_EMBED_SINGLE_GET_IFACE (single);
    iface->clear_auth_cache (single);
}

/**
 * ephy_embed_single_get_nework_status:
 * @single: the #EphyEmbedSingle
 * @offline: %TRUE if the network is on-line
 * 
 * Sets the state of the network connection.
 **/
void
ephy_embed_single_set_network_status (EphyEmbedSingle *single,
                      gboolean status)
{
    EphyEmbedSingleIface *iface = EPHY_EMBED_SINGLE_GET_IFACE (single);
    iface->set_network_status (single, status);
}

/**
 * ephy_embed_single_get_network_status:
 * @single: the #EphyEmbedSingle
 * 
 * Gets the state of the network connection.
 * 
 * Returns: %TRUE iff the network is on-line.
 **/
gboolean
ephy_embed_single_get_network_status (EphyEmbedSingle *single)
{
    EphyEmbedSingleIface *iface = EPHY_EMBED_SINGLE_GET_IFACE (single);
    return iface->get_network_status (single);
}

/**
 * ephy_embed_single_get_font_list:
 * @single: the #EphyEmbedSingle
 * @lang_group: a mozilla font language group name, or %NULL
 * 
 * Returns the list of fonts matching @lang_group, or all fonts if @lang_group
 * is %NULL.
 *
 * The available @lang_group arguments are listed in Epiphany's Fonts and Colors
 * preferences.
 * 
 * Return value: a list of font names
 **/
GList *
ephy_embed_single_get_font_list (EphyEmbedSingle *single,
                 const char *lang_group)
{
    EphyEmbedSingleIface *iface = EPHY_EMBED_SINGLE_GET_IFACE (single);
    return iface->get_font_list (single, lang_group);
}

/**
 * ephy_embed_single_open_window:
 * @single: the #EphyEmbedSingle
 * @parent: the requested window's parent #EphyEmbed
 * @address: the URL to load
 * @name: a name for the window
 * @features: a Javascript features string
 *
 * Opens a new window, as if it were opened in @parent using the Javascript
 * method and arguments: <code>window.open(&quot;@address&quot;,
 * &quot;_blank&quot;, &quot;@features&quot;);</code>.
 * 
 * Returns: the new embed. This is either a #EphyEmbed, or, when @features specified
 * "chrome", a #GtkMozEmbed.
 *
 * NOTE: Use ephy_shell_new_tab() unless this handling of the @features string is
 * required.
 */
GtkWidget *
ephy_embed_single_open_window (EphyEmbedSingle *single,
                   EphyEmbed *parent,
                   const char *address,
                   const char *name,
                   const char *features)
{
    EphyEmbedSingleIface *iface = EPHY_EMBED_SINGLE_GET_IFACE (single);
    return iface->open_window (single, parent, address, name, features);
}