embed/ephy-embed-single.c

   1  /*
   2  *  Copyright © 2000-2003 Marco Pesenti Gritti
   3  *
   4  *  This program is free software; you can redistribute it and/or modify
   5  *  it under the terms of the GNU General Public License as published by
   6  *  the Free Software Foundation; either version 2, or (at your option)
   7  *  any later version.
   8  *
   9  *  This program is distributed in the hope that it will be useful,
  10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *  GNU General Public License for more details.
  13  *
  14  *  You should have received a copy of the GNU General Public License
  15  *  along with this program; if not, write to the Free Software
  16  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  *
  18  *  $Id: ephy-embed-single.c 6952 2007-03-11 19:42:02Z chpe $
  19  */
  20
  21 #include "config.h"
  22
  23 #include "ephy-embed-single.h"
  24 #include "ephy-embed-type-builtins.h"
  25 #include "ephy-marshal.h"
  26 #include "ephy-signal-accumulator.h"
  27
  28 static void ephy_embed_single_iface_init (gpointer g_class);
  29
  30 GType
  31 ephy_embed_single_get_type (void)
  32 {
  33         static GType type = 0;
  34
  35         if (G_UNLIKELY (type == 0))
  36         {
  37                 const GTypeInfo our_info =
  38                 {
  39                         sizeof (EphyEmbedSingleIface),
  40                         ephy_embed_single_iface_init,
  41                         NULL,
  42                 };
  43
  44                 type = g_type_register_static (G_TYPE_INTERFACE,
  45                                                "EphyEmbedSingle",
  46                                                &our_info,
  47                                                (GTypeFlags) 0);
  48         }
  49
  50         return type;
  51 }
  52
  53 static void
  54 ephy_embed_single_iface_init (gpointer g_iface)
  55 {
  56         static gboolean initialised = FALSE;
  57
  58         if (initialised == FALSE)
  59         {
  60 /**
  61  * EphyEmbedSingle::new-window:
  62  * @single:
  63  * @parent_embed: the #EphyEmbed requesting the new window, or %NULL
  64  * @mask: a #EphyEmbedChrome
  65  *
  66  * The ::new_window signal is emitted when a new window needs to be opened.
  67  * For example, when a JavaScript popup window was opened.
  68  *
  69  * Return a new #EphyEmbed.
  70  **/
  71         g_signal_new ("new-window",
  72                       EPHY_TYPE_EMBED_SINGLE,
  73                       G_SIGNAL_RUN_FIRST | G_SIGNAL_RUN_LAST,
  74                       G_STRUCT_OFFSET (EphyEmbedSingleIface, new_window),
  75                       ephy_signal_accumulator_object, ephy_embed_get_type,
  76                       ephy_marshal_OBJECT__OBJECT_FLAGS,
  77                       GTK_TYPE_WIDGET,
  78                       2,
  79                       GTK_TYPE_WIDGET,
  80                       EPHY_TYPE_EMBED_CHROME);
  81
  82 /**
  83  * EphyEmbedSingle::handle_content:
  84  * @single:
  85  * @mime_type: the MIME type of the content
  86  * @address: the URL to the content
  87  *
  88  * The ::handle_content signal is emitted when encountering content of a mime
  89  * type Epiphany is unable to handle itself.
  90  *
  91  * If a connected callback returns %TRUE, the signal will stop propagating. For
  92  * example, this could be used by a download manager to prevent other
  93  * ::handle_content listeners from being called.
  94  **/
  95         g_signal_new ("handle_content",
  96                       EPHY_TYPE_EMBED_SINGLE,
  97                       G_SIGNAL_RUN_LAST,
  98                       G_STRUCT_OFFSET (EphyEmbedSingleIface, handle_content),
  99                       g_signal_accumulator_true_handled, NULL,
 100                       ephy_marshal_BOOLEAN__STRING_STRING,
 101                       G_TYPE_BOOLEAN,
 102                       2,
 103                       G_TYPE_STRING,
 104                       G_TYPE_STRING);
 105
 106 /**
 107  * EphyEmbedSingle::add-sidebar:
 108  * @single:
 109  * @url: The url of the sidebar to be added
 110  * @title: The title of the sidebar to be added
 111  *
 112  * The ::add-sidebar signal is emitted when the user clicks a javascript link that
 113  * requests adding a url to the sidebar.
 114  **/
 115         g_signal_new ("add-sidebar",
 116                       EPHY_TYPE_EMBED_SINGLE,
 117                       G_SIGNAL_RUN_LAST,
 118                       G_STRUCT_OFFSET (EphyEmbedSingleIface, add_sidebar),
 119                       g_signal_accumulator_true_handled, NULL,
 120                       ephy_marshal_BOOLEAN__STRING_STRING,
 121                       G_TYPE_BOOLEAN,
 122                       2,
 123                       G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE,
 124                       G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE);
 125
 126 /**
 127  * EphyEmbedSingle::add-search-engine
 128  * @single:
 129  * @url: The url of the search engine definition file
 130  * @icon_url: The url of the icon to use for this engine
 131  * @title: The title of the search engine to be added
 132  *
 133  * The ::add-search-engine signal is emitted when the user clicks a javascript link that
 134  * requests adding a search engine to the sidebar.
 135  **/
 136         g_signal_new ("add-search-engine",
 137                       EPHY_TYPE_EMBED_SINGLE,
 138                       G_SIGNAL_RUN_LAST,
 139                       G_STRUCT_OFFSET (EphyEmbedSingleIface, add_search_engine),
 140                       g_signal_accumulator_true_handled, NULL,
 141                       ephy_marshal_BOOLEAN__STRING_STRING_STRING,
 142                       G_TYPE_BOOLEAN,
 143                       3,
 144                       G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE,
 145                       G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE,
 146                       G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE);
 147
 148 /**
 149  * EphyEmbedSingle::network-status:
 150  *
 151  * Whether the network is on-line.
 152  */
 153         g_object_interface_install_property
 154                 (g_iface,
 155                  g_param_spec_boolean ("network-status",
 156                                        "network-status",
 157                                        "network-status",
 158                                        FALSE,
 159                                        G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB));
 160
 161         initialised = TRUE;
 162         }
 163 }
 164
 165 /**
 166  * ephy_embed_single_init:
 167  * @single: the #EphyEmbedSingle
 168  *
 169  * Performs startup initialisations. Must be called before calling
 170  * any other methods.
 171  **/
 172 gboolean
 173 ephy_embed_single_init (EphyEmbedSingle *single)
 174 {
 175         EphyEmbedSingleIface *iface = EPHY_EMBED_SINGLE_GET_IFACE (single);
 176         return iface->init (single);
 177 }
 178
 179 /**
 180  * ephy_embed_single_clear_cache:
 181  * @single: the #EphyEmbedSingle
 182  *
 183  * Clears the Mozilla cache (temporarily saved web pages).
 184  **/
 185 void
 186 ephy_embed_single_clear_cache (EphyEmbedSingle *single)
 187 {
 188         EphyEmbedSingleIface *iface = EPHY_EMBED_SINGLE_GET_IFACE (single);
 189         iface->clear_cache (single);
 190 }
 191
 192 /**
 193  * ephy_embed_single_clear_auth_cache:
 194  * @single: the #EphyEmbedSingle
 195  *
 196  * Clears the Mozilla HTTP authentication cache.
 197  *
 198  * This does not clear regular website passwords; it only clears the HTTP
 199  * authentication cache. Websites which use HTTP authentication require the
 200  * browser to send a password along with every HTTP request; the browser will
 201  * ask the user for the password once and then cache the password for subsequent
 202  * HTTP requests. This function will clear the HTTP authentication cache,
 203  * meaning the user will have to re-enter a username and password the next time
 204  * Epiphany requests a web page secured with HTTP authentication.
 205  **/
 206 void
 207 ephy_embed_single_clear_auth_cache (EphyEmbedSingle *single)
 208 {
 209         EphyEmbedSingleIface *iface = EPHY_EMBED_SINGLE_GET_IFACE (single);
 210         iface->clear_auth_cache (single);
 211 }
 212
 213 /**
 214  * ephy_embed_single_get_nework_status:
 215  * @single: the #EphyEmbedSingle
 216  * @offline: %TRUE if the network is on-line
 217  *
 218  * Sets the state of the network connection.
 219  **/
 220 void
 221 ephy_embed_single_set_network_status (EphyEmbedSingle *single,
 222                                       gboolean status)
 223 {
 224         EphyEmbedSingleIface *iface = EPHY_EMBED_SINGLE_GET_IFACE (single);
 225         iface->set_network_status (single, status);
 226 }
 227
 228 /**
 229  * ephy_embed_single_get_network_status:
 230  * @single: the #EphyEmbedSingle
 231  *
 232  * Gets the state of the network connection.
 233  *
 234  * Returns: %TRUE iff the network is on-line.
 235  **/
 236 gboolean
 237 ephy_embed_single_get_network_status (EphyEmbedSingle *single)
 238 {
 239         EphyEmbedSingleIface *iface = EPHY_EMBED_SINGLE_GET_IFACE (single);
 240         return iface->get_network_status (single);
 241 }
 242
 243 /**
 244  * ephy_embed_single_get_font_list:
 245  * @single: the #EphyEmbedSingle
 246  * @lang_group: a mozilla font language group name, or %NULL
 247  *
 248  * Returns the list of fonts matching @lang_group, or all fonts if @lang_group
 249  * is %NULL.
 250  *
 251  * The available @lang_group arguments are listed in Epiphany's Fonts and Colors
 252  * preferences.
 253  *
 254  * Return value: a list of font names
 255  **/
 256 GList *
 257 ephy_embed_single_get_font_list (EphyEmbedSingle *single,
 258                                  const char *lang_group)
 259 {
 260         EphyEmbedSingleIface *iface = EPHY_EMBED_SINGLE_GET_IFACE (single);
 261         return iface->get_font_list (single, lang_group);
 262 }
 263
 264 /**
 265  * ephy_embed_single_open_window:
 266  * @single: the #EphyEmbedSingle
 267  * @parent: the requested window's parent #EphyEmbed
 268  * @address: the URL to load
 269  * @name: a name for the window
 270  * @features: a Javascript features string
 271  *
 272  * Opens a new window, as if it were opened in @parent using the Javascript
 273  * method and arguments: <code>window.open(&quot;@address&quot;,
 274  * &quot;_blank&quot;, &quot;@features&quot;);</code>.
 275  *
 276  * Returns: the new embed. This is either a #EphyEmbed, or, when @features specified
 277  * "chrome", a #GtkMozEmbed.
 278  *
 279  * NOTE: Use ephy_shell_new_tab() unless this handling of the @features string is
 280  * required.
 281  */
 282 GtkWidget *
 283 ephy_embed_single_open_window (EphyEmbedSingle *single,
 284                                EphyEmbed *parent,
 285                                const char *address,
 286                                const char *name,
 287                                const char *features)
 288 {
 289         EphyEmbedSingleIface *iface = EPHY_EMBED_SINGLE_GET_IFACE (single);
 290         return iface->open_window (single, parent, address, name, features);
 291 }
 292
 293 /**
 294  * ephy_embed_single_get_backend_name
 295  * @single: the #EphyEmbedSingle
 296  *
 297  * Can be used to find the particular backend that is being used
 298  * for rendering pages.
 299  *
 300  * Returns: the name of the backend. Valid returns are "gecko-1.7",
 301  * "gecko-1.8" and "gecko-1.9"
 302  */
 303 const char *
 304 ephy_embed_single_get_backend_name (EphyEmbedSingle *single)
 305 {
 306         EphyEmbedSingleIface *iface = EPHY_EMBED_SINGLE_GET_IFACE (single);
 307         return iface->get_backend_name (single);
 308 }