EphyEmbed
An interface to the widget displaying web pages
Each #EphyTab contains an #EphyEmbed. An #EphyEmbed is an interface; right now
it is only implemented by #MozillaEmbed, but whenever possible, #EphyEmbed's
functions should be used instead of their #MozillaEmbed equivalents.
#EphyEmbed's most important functions can be divided into sets:
Functions which affect navigation
Functions which return information about the displayed web
page
Functions which manipulate the session history
The first two sets of functions are self-explanitory.
The session history functions are used to traverse the embedded browser's
history. Each #EphyEmbed remembers a history of the web pages it has visited.
There can be a maximum limit, however; for #MozillaEmbed, this limit is
determined by Mozilla's browser.sessionhistory.max_entries preference. Because
of this limit, ephy_embed_shistory_n_items() will not necessarily return the
number of web pages visited in the embed's lifetime; likewise,
ephy_embed_shistory_go_nth() will not always return to the user's home page
when called with a 0 argument.
Using #EphyEmbed instead of #MozillaEmbed is good practice. However, using a
#MozillaEmbed or even a #GtkMozEmbed may be necessary in certain cases (this can
be done by casting).
@ephyembed: the object which received the signal.
@Returns:
@ephyembed: the object which received the signal.
@arg1:
@ephyembed: the object which received the signal.
@arg1:
@ephyembed: the object which received the signal.
@arg1:
@ephyembed: the object which received the signal.
@arg1:
@Returns:
@ephyembed: the object which received the signal.
@arg1:
@ephyembed: the object which received the signal.
@arg1:
@Returns:
@ephyembed: the object which received the signal.
@arg1:
@Returns:
@ephyembed: the object which received the signal.
@arg1:
@ephyembed: the object which received the signal.
@arg1:
@arg2:
@arg3:
@ephyembed: the object which received the signal.
@arg1:
@ephyembed: the object which received the signal.
@Returns:
@ephyembed: the object which received the signal.
@ephyembed: the object which received the signal.
@arg1:
@arg2:
@ephyembed: the object which received the signal.
@arg1:
@ephyembed: the object which received the signal.
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@:
@ephyembed: the object which received the signal.
@event:
@Returns:
@ephyembed: the object which received the signal.
@arg1:
@ephyembed: the object which received the signal.
@arg1:
@base_iface:
@context_menu:
@favicon:
@feed_link:
@location:
@net_state:
@dom_mouse_click:
@dom_mouse_down:
@dom_content_loaded:
@popup_blocked:
@security_change:
@zoom_change:
@content_change:
@content_blocked:
@modal_alert:
@modal_alert_closed:
@document_type:
@new_window:
@search_key_press:
@close_request:
@load_url:
@stop_load:
@reload:
@can_go_back:
@can_go_forward:
@can_go_up:
@get_go_up_list:
@go_back:
@go_forward:
@go_up:
@get_title:
@get_location:
@get_link_message:
@get_js_status:
@shistory_n_items:
@shistory_get_nth:
@shistory_get_pos:
@shistory_go_nth:
@shistory_copy:
@get_security_level:
@show_page_certificate:
@set_zoom:
@get_zoom:
@scroll_lines:
@scroll_pages:
@scroll_pixels:
@get_encoding:
@has_automatic_encoding:
@set_encoding:
@print:
@set_print_preview_mode:
@print_preview_n_pages:
@print_preview_navigate:
@has_modified_forms:
@close:
Determines which aspects of the user interface should be displayed. Most of the
time, an #EphyEmbed's chrome will simply be %EPHY_EMBED_CHROME_DEFAULT. However,
windows opened with JavaScript often use a nonstandard chrome.
@EPHY_EMBED_CHROME_MENUBAR: %TRUE for the #EphyEmbed's containing #EphyWindow
to display its menubar.
@EPHY_EMBED_CHROME_TOOLBAR: %TRUE for the #EphyEmbed's containing #EphyWindow
to display its toolbars.
@EPHY_EMBED_CHROME_STATUSBAR: %TRUE for the #EphyEmbed's containing #EphyWindow
to display its statusbar.
@EPHY_EMBED_CHROME_BOOKMARKSBAR:
@embed:
@url:
@embed:
@embed:
@force:
@embed:
@Returns:
@embed:
@toplevel:
@Returns:
@embed:
@Returns:
@embed:
@Returns:
@embed:
@Returns:
@embed:
@Returns:
@embed:
@Returns:
@embed:
@Returns:
@embed:
@embed:
@embed:
@embed:
@Returns:
@embed:
@nth:
@is_relative:
@url:
@title:
@embed:
@Returns:
@embed:
@nth:
@embed:
@level:
@description:
@embed:
@zoom:
@embed:
@Returns:
@find:
@search_string:
@case_sensitive:
@embed:
@encoding:
@embed:
@embed:
@Returns:
@embed:
@type:
@page:
@embed:
@Returns: