diff options
Diffstat (limited to 'doc/reference/tmpl/ephy-embed.sgml')
| -rw-r--r-- | doc/reference/tmpl/ephy-embed.sgml | 399 |
1 files changed, 0 insertions, 399 deletions
diff --git a/doc/reference/tmpl/ephy-embed.sgml b/doc/reference/tmpl/ephy-embed.sgml deleted file mode 100644 index bfa4157ee..000000000 --- a/doc/reference/tmpl/ephy-embed.sgml +++ /dev/null @@ -1,399 +0,0 @@ -<!-- ##### SECTION Title ##### --> -EphyEmbed - -<!-- ##### SECTION Short_Description ##### --> -An interface to the widget displaying web pages - -<!-- ##### SECTION Long_Description ##### --> -<para> -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. -</para> -<para> -#EphyEmbed's most important functions can be divided into sets: -</para> -<itemizedlist> -<listitem>Functions which affect navigation</listitem> -<listitem>Functions which return information about the displayed web -page</listitem> -<listitem>Functions which manipulate the session history</listitem> -</itemizedlist> -<para>The first two sets of functions are self-explanitory.</para> -<para>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.</para> - -<!-- ##### SECTION See_Also ##### --> -<para> -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). -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT EphyEmbed ##### --> -<para> - -</para> - - -<!-- ##### SIGNAL EphyEmbed::close-request ##### --> -<para> - -</para> - -@ephyembed: the object which received the signal. -@Returns: - -<!-- ##### SIGNAL EphyEmbed::content-blocked ##### --> -<para> - -</para> - -@ephyembed: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL EphyEmbed::dom-content-loaded ##### --> -<para> - -</para> - -@ephyembed: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL EphyEmbed::ge-context-menu ##### --> -<para> - -</para> - -@ephyembed: the object which received the signal. -@arg1: -@Returns: - -<!-- ##### SIGNAL EphyEmbed::ge-document-type ##### --> -<para> - -</para> - -@ephyembed: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL EphyEmbed::ge-dom-mouse-click ##### --> -<para> - -</para> - -@ephyembed: the object which received the signal. -@arg1: -@Returns: - -<!-- ##### SIGNAL EphyEmbed::ge-dom-mouse-down ##### --> -<para> - -</para> - -@ephyembed: the object which received the signal. -@arg1: -@Returns: - -<!-- ##### SIGNAL EphyEmbed::ge-favicon ##### --> -<para> - -</para> - -@ephyembed: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL EphyEmbed::ge-feed-link ##### --> -<para> - -</para> - -@ephyembed: the object which received the signal. -@arg1: -@arg2: -@arg3: - -<!-- ##### SIGNAL EphyEmbed::ge-modal-alert ##### --> -<para> - -</para> - -@ephyembed: the object which received the signal. -@Returns: - -<!-- ##### SIGNAL EphyEmbed::ge-modal-alert-closed ##### --> -<para> - -</para> - -@ephyembed: the object which received the signal. - -<!-- ##### SIGNAL EphyEmbed::ge-new-window ##### --> -<para> - -</para> - -@ephyembed: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL EphyEmbed::ge-popup-blocked ##### --> -<para> - -</para> - -@ephyembed: the object which received the signal. -@arg1: -@arg2: -@arg3: - -<!-- ##### SIGNAL EphyEmbed::ge-search-key-press ##### --> -<para> - -</para> - -@ephyembed: the object which received the signal. -@event: -@Returns: - -<!-- ##### SIGNAL EphyEmbed::ge-search-link ##### --> -<para> - -</para> - -@ephyembed: the object which received the signal. -@arg1: -@arg2: -@arg3: - -<!-- ##### SIGNAL EphyEmbed::new-document-now ##### --> -<para> - -</para> - -@ephyembed: the object which received the signal. -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@Param2: - -<!-- ##### STRUCT EphyEmbedIface ##### --> -<para> - -</para> - -@base_iface: -@context_menu: -@favicon: -@feed_link: -@search_link: -@dom_mouse_click: -@dom_mouse_down: -@dom_content_loaded: -@popup_blocked: -@content_blocked: -@modal_alert: -@modal_alert_closed: -@document_type: -@new_window: -@search_key_press: -@close_request: -@new_document_now: -@load_url: -@load: -@can_go_up: -@get_go_up_list: -@go_up: -@get_title: -@get_location: -@get_link_message: -@get_js_status: -@get_security_level: -@show_page_certificate: -@set_print_preview_mode: -@print_preview_n_pages: -@print_preview_navigate: -@has_modified_forms: -@get_document_type: -@get_load_percent: -@get_load_status: -@get_navigation_flags: -@get_typed_address: -@set_typed_address: -@get_address: -@get_status_message: -@get_icon: -@get_icon_address: -@get_is_blank: -@get_loading_title: -@get_visibility: - -<!-- ##### ENUM EphyEmbedChrome ##### --> -<para> -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. -</para> - -@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: - -<!-- ##### FUNCTION ephy_embed_load_url ##### --> -<para> - -</para> - -@embed: -@url: - - -<!-- ##### FUNCTION ephy_embed_get_title ##### --> -<para> - -</para> - -@embed: -@Returns: - - -<!-- ##### FUNCTION ephy_embed_get_location ##### --> -<para> - -</para> - -@embed: -@toplevel: -@Returns: - - -<!-- ##### FUNCTION ephy_embed_get_link_message ##### --> -<para> - -</para> - -@embed: -@Returns: - - -<!-- ##### FUNCTION ephy_embed_get_js_status ##### --> -<para> - -</para> - -@embed: -@Returns: - - -<!-- ##### FUNCTION ephy_embed_can_go_up ##### --> -<para> - -</para> - -@embed: -@Returns: - - -<!-- ##### FUNCTION ephy_embed_get_go_up_list ##### --> -<para> - -</para> - -@embed: -@Returns: - - -<!-- ##### FUNCTION ephy_embed_go_up ##### --> -<para> - -</para> - -@embed: - - -<!-- ##### FUNCTION ephy_embed_get_security_level ##### --> -<para> - -</para> - -@embed: -@level: -@description: - - -<!-- ##### FUNCTION ephy_embed_print_preview_n_pages ##### --> -<para> - -</para> - -@embed: -@Returns: - - -<!-- ##### FUNCTION ephy_embed_print_preview_navigate ##### --> -<para> - -</para> - -@embed: -@type: -@page: - - -<!-- ##### FUNCTION ephy_embed_has_modified_forms ##### --> -<para> - -</para> - -@embed: -@Returns: - - |