diff options
Diffstat (limited to 'doc')
22 files changed, 53 insertions, 2738 deletions
diff --git a/doc/reference/tmpl/EphyContentPolicy.sgml b/doc/reference/tmpl/EphyContentPolicy.sgml deleted file mode 100644 index 5cd2d4f61..000000000 --- a/doc/reference/tmpl/EphyContentPolicy.sgml +++ /dev/null @@ -1,19 +0,0 @@ -<!-- ##### SECTION Title ##### --> -EphyContentPolicy - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - diff --git a/doc/reference/tmpl/EphySingle.sgml b/doc/reference/tmpl/EphySingle.sgml deleted file mode 100644 index 5ecfb7239..000000000 --- a/doc/reference/tmpl/EphySingle.sgml +++ /dev/null @@ -1,64 +0,0 @@ -<!-- ##### SECTION Title ##### --> -EphySingle - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### FUNCTION Init ##### --> -<para> - -</para> - -@aOwner: -@Returns: - - -<!-- ##### FUNCTION Detach ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION EmitPermissionNotification ##### --> -<para> - -</para> - -@name: -@aSubject: -@Returns: - - -<!-- ##### FUNCTION mozilla_cookie_to_ephy_cookie ##### --> -<para> - -</para> - -@cookie: -@Returns: - - -<!-- ##### FUNCTION mozilla_permission_to_ephy_permission ##### --> -<para> - -</para> - -@perm: -@Returns: - - diff --git a/doc/reference/tmpl/ephy-embed-factory.sgml b/doc/reference/tmpl/ephy-embed-factory.sgml deleted file mode 100644 index eda17fe3a..000000000 --- a/doc/reference/tmpl/ephy-embed-factory.sgml +++ /dev/null @@ -1,34 +0,0 @@ -<!-- ##### SECTION Title ##### --> -EphyEmbedFactory - -<!-- ##### SECTION Short_Description ##### --> -Factory for creating new embed objects - -<!-- ##### SECTION Long_Description ##### --> -<para> -#EphyEmbed, #EphyEmbedPersist and #EphyEmbedSingle are all interfaces. In the -interest of abstraction, the only recommended way to create new instances of -the objects which implement these interfaces is to use #EphyEmbedFactory. -</para> -<para> -To create a new instance of an #EphyEmbed, #EphyEmbedPersist or -#EphyEmbedSingle, use ephy_embed_factory_new_object(). -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### FUNCTION ephy_embed_factory_new_object ##### --> -<para> - -</para> - -@type: -@Returns: - - diff --git a/doc/reference/tmpl/ephy-embed-persist.sgml b/doc/reference/tmpl/ephy-embed-persist.sgml deleted file mode 100644 index 32fa72e63..000000000 --- a/doc/reference/tmpl/ephy-embed-persist.sgml +++ /dev/null @@ -1,235 +0,0 @@ -<!-- ##### SECTION Title ##### --> -EphyEmbedPersist - -<!-- ##### SECTION Short_Description ##### --> -A class to download files - -<!-- ##### SECTION Long_Description ##### --> -<para> -An #EphyEmbedPersist is a relatively simple way to save a web page or file to -disk. It is an abstract class, implemented by #MozillaEmbedPersist. -</para> -<para> -To create an #EphyEmbedPersist, use ephy_embed_factory_new_object(). Next, call -ephy_embed_persist_set_flags() and ephy_embed_persist_set_embed(). Depending -on the flags, you may also want to call ephy_embed_persist_set_dest() or -ephy_embed_persist_set_source(). Finally, call ephy_embed_persist_save() to -save the file. -</para> -<para> -<example> -<title>Saving the current web page to disk</title> -<programlisting>#<![CDATA[include <epiphany/ephy-embed-persist.h>]]> -#<![CDATA[include <epiphany/ephy-embed.h> - -static void -save_source_completed_cb (EphyEmbedPersist *persist, - gpointer dummy) -{ - g_print ("Download to %]]><![CDATA[s complete.\n", - ephy_embed_persist_get_dest (persist)); -} - -void -save_page (EphyEmbed *embed, - const char *filename) -{ - EphyEmbedPersist *persist; - - persist = EPHY_EMBED_PERSIST - (ephy_embed_factory_new_object ("EphyEmbedPersist")); - - ephy_embed_persist_set_embed (persist, embed); - ephy_embed_persist_set_flags (persist, EMBED_PERSIST_NO_VIEW | - EMBED_PERSIST_COPY_PAGE); - ephy_embed_persist_set_dest (persist, filename); - - g_signal_connect (persist, "completed", - G_CALLBACK (save_source_completed_cb), NULL); - - ephy_embed_persist_save (persist); - - g_object_unref (persist); -}]]> -</programlisting> -</example> -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### FUNCTION ephy_embed_persist_set_dest ##### --> -<para> - -</para> - -@persist: -@value: - - -<!-- ##### FUNCTION ephy_embed_persist_set_embed ##### --> -<para> - -</para> - -@persist: -@value: - - -<!-- ##### FUNCTION ephy_embed_persist_set_fc_title ##### --> -<para> - -</para> - -@persist: -@value: - - -<!-- ##### FUNCTION ephy_embed_persist_set_fc_parent ##### --> -<para> - -</para> - -@persist: -@value: - - -<!-- ##### FUNCTION ephy_embed_persist_set_flags ##### --> -<para> - -</para> - -@persist: -@value: - - -<!-- ##### FUNCTION ephy_embed_persist_set_max_size ##### --> -<para> - -</para> - -@persist: -@value: - - -<!-- ##### FUNCTION ephy_embed_persist_set_persist_key ##### --> -<para> - -</para> - -@persist: -@value: - - -<!-- ##### FUNCTION ephy_embed_persist_set_source ##### --> -<para> - -</para> - -@persist: -@value: - - -<!-- ##### FUNCTION ephy_embed_persist_get_dest ##### --> -<para> - -</para> - -@persist: -@Returns: - - -<!-- ##### FUNCTION ephy_embed_persist_get_embed ##### --> -<para> - -</para> - -@persist: -@Returns: - - -<!-- ##### FUNCTION ephy_embed_persist_get_fc_title ##### --> -<para> - -</para> - -@persist: -@Returns: - - -<!-- ##### FUNCTION ephy_embed_persist_get_fc_parent ##### --> -<para> - -</para> - -@persist: -@Returns: - - -<!-- ##### FUNCTION ephy_embed_persist_get_flags ##### --> -<para> - -</para> - -@persist: -@Returns: - - -<!-- ##### FUNCTION ephy_embed_persist_get_max_size ##### --> -<para> - -</para> - -@persist: -@Returns: - - -<!-- ##### FUNCTION ephy_embed_persist_get_persist_key ##### --> -<para> - -</para> - -@persist: -@Returns: - - -<!-- ##### FUNCTION ephy_embed_persist_get_source ##### --> -<para> - -</para> - -@persist: -@Returns: - - -<!-- ##### FUNCTION ephy_embed_persist_save ##### --> -<para> - -</para> - -@persist: -@Returns: - - -<!-- ##### FUNCTION ephy_embed_persist_cancel ##### --> -<para> - -</para> - -@persist: - - -<!-- ##### FUNCTION ephy_embed_persist_to_string ##### --> -<para> - -</para> - -@persist: -@Returns: - - diff --git a/doc/reference/tmpl/ephy-embed-single.sgml b/doc/reference/tmpl/ephy-embed-single.sgml deleted file mode 100644 index e49aa628b..000000000 --- a/doc/reference/tmpl/ephy-embed-single.sgml +++ /dev/null @@ -1,69 +0,0 @@ -<!-- ##### SECTION Title ##### --> -EphyEmbedSingle - -<!-- ##### SECTION Short_Description ##### --> -An interface to the global embedded browser - -<!-- ##### SECTION Long_Description ##### --> -<para> -While Epiphany is running, its global embed_shell variable (an #EphyEmbedShell) -holds a reference to an #EphyEmbedSingle. The only class which implements -#EphyEmbedSingle is #MozillaEmbedSingle, so the two types are interchangeable -via casting. -</para> -<para> -<example> -<title>Acquiring an <structname>EphyEmbedSingle</structname></title> -<programlisting>#<![CDATA[include <ephy-embed-shell.h>]]> -#<![CDATA[include <ephy-embed-single.h> - -EphyEmbedSingle *ephy_single; - -/* embed_shell is a global variable, initialized as Epiphany starts */ -ephy_single = ephy_embed_shell_get_embed_single (embed_shell); -]]></programlisting> -</example> -</para> -<para> -Since there is only one #EphyEmbedShell, there is only one #EphyEmbedSingle. It -is used to perform browser-related actions which do not refer to an individual -#EphyEmbed. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### FUNCTION ephy_embed_single_clear_cache ##### --> -<para> - -</para> - -@single: - - -<!-- ##### FUNCTION ephy_embed_single_clear_auth_cache ##### --> -<para> - -</para> - -@single: - - -<!-- ##### FUNCTION ephy_embed_single_open_window ##### --> -<para> - -</para> - -@single: -@parent: -@address: -@name: -@features: -@Returns: - - 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: - - diff --git a/doc/reference/tmpl/ephy-extensions-manager.sgml b/doc/reference/tmpl/ephy-extensions-manager.sgml deleted file mode 100644 index e7d7c7bae..000000000 --- a/doc/reference/tmpl/ephy-extensions-manager.sgml +++ /dev/null @@ -1,37 +0,0 @@ -<!-- ##### SECTION Title ##### --> -EphyExtensionsManager - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### FUNCTION ephy_extensions_manager_load ##### --> -<para> - -</para> - -@manager: -@identifier: - - -<!-- ##### FUNCTION ephy_extensions_manager_unload ##### --> -<para> - -</para> - -@manager: -@identifier: - - diff --git a/doc/reference/tmpl/ephy-glade.sgml b/doc/reference/tmpl/ephy-glade.sgml deleted file mode 100644 index 96c99456f..000000000 --- a/doc/reference/tmpl/ephy-glade.sgml +++ /dev/null @@ -1,25 +0,0 @@ -<!-- ##### SECTION Title ##### --> -EphyGlade - -<!-- ##### SECTION Short_Description ##### --> -Load a glade XML definition - -<!-- ##### SECTION Long_Description ##### --> -<para> -Epiphany has its own convenience wrapper around glade_xml_new() which will -automatically connect all a widget's signals and return the #GtkWidget root -object. -</para> -<para> -After retrieving a #GladeXML object from ephy_glade_widget_new(), regular -#GladeXML functions can be called on that object. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - diff --git a/doc/reference/tmpl/ephy-icon-entry.sgml b/doc/reference/tmpl/ephy-icon-entry.sgml deleted file mode 100644 index 6ed857e9f..000000000 --- a/doc/reference/tmpl/ephy-icon-entry.sgml +++ /dev/null @@ -1,53 +0,0 @@ -<!-- ##### SECTION Title ##### --> -EphyIconEntry - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT EphyIconEntry ##### --> -<para> - -</para> - -@entry: - -<!-- ##### FUNCTION ephy_icon_entry_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION ephy_icon_entry_pack_widget ##### --> -<para> - -</para> - -@entry: -@widget: -@start: - - -<!-- ##### FUNCTION ephy_icon_entry_get_entry ##### --> -<para> - -</para> - -@entry: -@Returns: - - diff --git a/doc/reference/tmpl/ephy-location-entry.sgml b/doc/reference/tmpl/ephy-location-entry.sgml index c9c7e42c6..acc02be2a 100644 --- a/doc/reference/tmpl/ephy-location-entry.sgml +++ b/doc/reference/tmpl/ephy-location-entry.sgml @@ -9,11 +9,13 @@ EphyLocationEntry </para> + <!-- ##### SECTION See_Also ##### --> <para> </para> + <!-- ##### SECTION Stability_Level ##### --> @@ -70,7 +72,6 @@ EphyLocationEntry @entry: @address: -@typed_address: <!-- ##### FUNCTION ephy_location_entry_get_location ##### --> @@ -109,15 +110,6 @@ EphyLocationEntry @Returns: -<!-- ##### FUNCTION ephy_location_entry_get_regex ##### --> -<para> - -</para> - -@entry: -@Returns: - - <!-- ##### FUNCTION ephy_location_entry_activate ##### --> <para> diff --git a/doc/reference/tmpl/ephy-node-db.sgml b/doc/reference/tmpl/ephy-node-db.sgml deleted file mode 100644 index 49bc95913..000000000 --- a/doc/reference/tmpl/ephy-node-db.sgml +++ /dev/null @@ -1,123 +0,0 @@ -<!-- ##### SECTION Title ##### --> -EphyNodeDb - -<!-- ##### SECTION Short_Description ##### --> -Data tree - -<!-- ##### SECTION Long_Description ##### --> -<para> -An #EphyNodeDb is a database for arbitrary data organized in a tree. -</para> -<para> -Each database is stored along with its name in a global set of databases. -Databases can be created using ephy_node_db_new() and retrieved using -ephy_node_db_get_by_name(). -</para> -<para> -Each #EphyNode inside an #EphyNodeDb is identified by a unique node ID. By -keeping a handle on the ID, one can use ephy_node_db_get_node_from_id() to -retrieve its corresponding #EphyNode. -</para> -<para> -#EphyNodeDb<!-- -->s can be saved to disk using ephy_node_db_write_to_xml_safe() -and restored using ephy_node_db_load_from_file(). -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT EphyNodeDb ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyNodeDb:immutable ##### --> -<para> -%TRUE if no #EphyNode<!-- -->s can be added, removed or modified from this -#EphyNodeDb -</para> - -<!-- ##### ARG EphyNodeDb:name ##### --> -<para> -A string identifier unique to this #EphyNodeDb -</para> - -<!-- ##### FUNCTION ephy_node_db_new ##### --> -<para> - -</para> - -@name: -@Returns: - - -<!-- ##### FUNCTION ephy_node_db_load_from_file ##### --> -<para> - -</para> - -@db: -@xml_file: -@xml_root: -@xml_version: -@Returns: - - -<!-- ##### FUNCTION ephy_node_db_write_to_xml_safe ##### --> -<para> - -</para> - -@db: -@filename: -@root: -@version: -@comment: -@node: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION ephy_node_db_get_name ##### --> -<para> - -</para> - -@db: -@Returns: - - -<!-- ##### FUNCTION ephy_node_db_is_immutable ##### --> -<para> - -</para> - -@db: -@Returns: - - -<!-- ##### FUNCTION ephy_node_db_set_immutable ##### --> -<para> - -</para> - -@db: -@immutable: - - -<!-- ##### FUNCTION ephy_node_db_get_node_from_id ##### --> -<para> - -</para> - -@db: -@id: -@Returns: - - diff --git a/doc/reference/tmpl/ephy-password-manager.sgml b/doc/reference/tmpl/ephy-password-manager.sgml deleted file mode 100644 index bfb3f287a..000000000 --- a/doc/reference/tmpl/ephy-password-manager.sgml +++ /dev/null @@ -1,78 +0,0 @@ -<!-- ##### SECTION Title ##### --> -ephy-password-manager - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### MACRO EPHY_PASSWORD_MANAGER_IFACE ##### --> -<para> - -</para> - -@k: - - -<!-- ##### MACRO EPHY_IS_PASSWORD_MANAGER_IFACE ##### --> -<para> - -</para> - -@k: - - -<!-- ##### MACRO EPHY_TYPE_PASSWORD_INFO ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION ephy_password_info_new ##### --> -<para> - -</para> - -@host: -@username: -@password: -@Returns: - - -<!-- ##### FUNCTION ephy_password_info_copy ##### --> -<para> - -</para> - -@info: -@Returns: - - -<!-- ##### FUNCTION ephy_password_info_free ##### --> -<para> - -</para> - -@info: - - -<!-- ##### FUNCTION ephy_password_manager_get_type ##### --> -<para> - -</para> - -@Returns: - - diff --git a/doc/reference/tmpl/ephy-permission-manager.sgml b/doc/reference/tmpl/ephy-permission-manager.sgml deleted file mode 100644 index ded9a0742..000000000 --- a/doc/reference/tmpl/ephy-permission-manager.sgml +++ /dev/null @@ -1,78 +0,0 @@ -<!-- ##### SECTION Title ##### --> -EphyPermissionManager - -<!-- ##### SECTION Short_Description ##### --> -Sets webpages' cookie, image and popup permissions. - -<!-- ##### SECTION Long_Description ##### --> -<para> -The #EphyPermissionManager keeps a list of websites and their permissions. For -example, the user may want a certain website to display images but block -cookies and popup windows; this could correspond to three entries in the -#EphyPermissionManager. -</para> -<para> -Use ephy_permission_manager_add() to set permissions for a website, -ephy_permission_manager_remove() to remove the permissions, and -ephy_permission_manager_test() to test them. Note that -ephy_permission_manager_test() may return %EPHY_PERMISSION_DEFAULT, which -means the caller might need to find the default permission some other way. -</para> -<para> -The #EphyPermissionManager stores a list of site-specific permissions, but not -defaults. For popups, the default permission is determined by the GConf key -/apps/epiphany/web/allow_popups, which in turn determines Mozilla's -dom.disable_open_during_load preference. For cookies, the GConf key -/apps/epiphany/web/cookie_accept determines Mozilla's -network.cookie.cookieBehavior preference. For images, the default is determined -by Mozilla's network.image.imageBehavior preference. -</para> -<para> -The predefined permission types are EPT_COOKIE ("cookie"), EPT_IMAGE ("image") -and EPT_POPUP ("popup"). You can also make up your own type string. -</para> -<para> -Though the word "host" is used in many function descriptions, Mozilla -does not act as one would expect. Always pass a URL to any functions which -need have a "host" parameter. However, the "host" in an -#EphyPermissionInfo is a simple DNS hostname. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT EphyPermissionInfo ##### --> -<para> -Details a specific permission of a specific website. -</para> - -@host: The hostname of the website to which this permission applies. -@qtype: -@permission: An #EphyPermission (either allow or deny). - -<!-- ##### ENUM EphyPermission ##### --> -<para> -Determines whether the website is allowed or denied access. -</para> - -@EPHY_PERMISSION_ALLOWED: - The website is unconditionally allowed to perform the desired action. -@EPHY_PERMISSION_DENIED: - The website is unconditionally denied to perform the desired action. -@EPHY_PERMISSION_DEFAULT: - The user has not set a preference for this particular website; the - caller should therefore fall back to default settings. - -<!-- ##### FUNCTION ephy_permission_info_free ##### --> -<para> - -</para> - -@info: - - diff --git a/doc/reference/tmpl/ephy-search-entry.sgml b/doc/reference/tmpl/ephy-search-entry.sgml index d0b12203a..3a9d3ff58 100644 --- a/doc/reference/tmpl/ephy-search-entry.sgml +++ b/doc/reference/tmpl/ephy-search-entry.sgml @@ -9,11 +9,13 @@ EphySearchEntry </para> + <!-- ##### SECTION See_Also ##### --> <para> </para> + <!-- ##### SECTION Stability_Level ##### --> diff --git a/doc/reference/tmpl/ephy-session.sgml b/doc/reference/tmpl/ephy-session.sgml deleted file mode 100644 index ce97b6371..000000000 --- a/doc/reference/tmpl/ephy-session.sgml +++ /dev/null @@ -1,84 +0,0 @@ -<!-- ##### SECTION Title ##### --> -ephy-session - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### FUNCTION ephy_session_get_active_window ##### --> -<para> - -</para> - -@session: -@Returns: - - -<!-- ##### FUNCTION ephy_session_save ##### --> -<para> - -</para> - -@session: -@filename: -@Returns: - - -<!-- ##### FUNCTION ephy_session_load ##### --> -<para> - -</para> - -@session: -@filename: -@user_time: -@Returns: - - -<!-- ##### FUNCTION ephy_session_close ##### --> -<para> - -</para> - -@session: - - -<!-- ##### FUNCTION ephy_session_get_windows ##### --> -<para> - -</para> - -@session: -@Returns: - - -<!-- ##### FUNCTION ephy_session_add_window ##### --> -<para> - -</para> - -@session: -@window: - - -<!-- ##### FUNCTION ephy_session_remove_window ##### --> -<para> - -</para> - -@session: -@window: - - diff --git a/doc/reference/tmpl/ephy-shell.sgml b/doc/reference/tmpl/ephy-shell.sgml deleted file mode 100644 index f50e4bcfa..000000000 --- a/doc/reference/tmpl/ephy-shell.sgml +++ /dev/null @@ -1,129 +0,0 @@ -<!-- ##### SECTION Title ##### --> -ephy-shell - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### VARIABLE ephy_shell ##### --> -<para> - -</para> - - -<!-- ##### ENUM EphyNewTabFlags ##### --> -<para> - -</para> - -@EPHY_NEW_TAB_HOME_PAGE: -@EPHY_NEW_TAB_NEW_PAGE: -@EPHY_NEW_TAB_OPEN_PAGE: -@EPHY_NEW_TAB_FULLSCREEN_MODE: -@EPHY_NEW_TAB_DONT_SHOW_WINDOW: -@EPHY_NEW_TAB_APPEND_LAST: -@EPHY_NEW_TAB_APPEND_AFTER: -@EPHY_NEW_TAB_JUMP: -@EPHY_NEW_TAB_IN_NEW_WINDOW: -@EPHY_NEW_TAB_IN_EXISTING_WINDOW: -@EPHY_NEW_TAB_ALLOW_FIXUP: -@EPHY_NEW_TAB_FROM_EXTERNAL: - -<!-- ##### FUNCTION ephy_shell_new_tab ##### --> -<para> - -</para> - -@shell: -@parent_window: -@previous_embed: -@url: -@flags: -@Returns: - - -<!-- ##### FUNCTION ephy_shell_get_session ##### --> -<para> - -</para> - -@shell: -@Returns: - - -<!-- ##### FUNCTION ephy_shell_get_bookmarks ##### --> -<para> - -</para> - -@shell: -@Returns: - - -<!-- ##### FUNCTION ephy_shell_get_toolbars_model ##### --> -<para> - -</para> - -@shell: -@fullscreen: -@Returns: - - -<!-- ##### FUNCTION ephy_shell_get_extensions_manager ##### --> -<para> - -</para> - -@shell: -@Returns: - - -<!-- ##### FUNCTION ephy_shell_get_bookmarks_editor ##### --> -<para> - -</para> - -@shell: -@Returns: - - -<!-- ##### FUNCTION ephy_shell_get_history_window ##### --> -<para> - -</para> - -@shell: -@Returns: - - -<!-- ##### FUNCTION ephy_shell_get_pdm_dialog ##### --> -<para> - -</para> - -@shell: -@Returns: - - -<!-- ##### FUNCTION ephy_shell_get_prefs_dialog ##### --> -<para> - -</para> - -@shell: -@Returns: - - diff --git a/doc/reference/tmpl/ephy-spinner.sgml b/doc/reference/tmpl/ephy-spinner.sgml index 170eeb0c1..9c4d12cc6 100644 --- a/doc/reference/tmpl/ephy-spinner.sgml +++ b/doc/reference/tmpl/ephy-spinner.sgml @@ -9,11 +9,13 @@ EphySpinner </para> + <!-- ##### SECTION See_Also ##### --> <para> </para> + <!-- ##### SECTION Stability_Level ##### --> @@ -36,7 +38,7 @@ EphySpinner </para> -@throbber: +@spinner: <!-- ##### FUNCTION ephy_spinner_stop ##### --> @@ -44,7 +46,7 @@ EphySpinner </para> -@throbber: +@spinner: <!-- ##### FUNCTION ephy_spinner_set_size ##### --> diff --git a/doc/reference/tmpl/ephy-tab.sgml b/doc/reference/tmpl/ephy-tab.sgml deleted file mode 100644 index 7b9bf485f..000000000 --- a/doc/reference/tmpl/ephy-tab.sgml +++ /dev/null @@ -1,202 +0,0 @@ -<!-- ##### SECTION Title ##### --> -EphyTab - -<!-- ##### SECTION Short_Description ##### --> -Represents an Epiphany tab - -<!-- ##### SECTION Long_Description ##### --> -<para> -Each #EphyWindow contains a #GtkNotebook which holds one or more #EphyTab:s. -An #EphyTab is basically a container for an #EphyEmbed. -</para> -<para> -To retrieve an #EphyTab's parent #EphyWindow, use gtk_widget_get_toplevel(). -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT EphyTab ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyTab:address ##### --> -<para> - -</para> - -<!-- ##### ARG EphyTab:document-type ##### --> -<para> - -</para> - -<!-- ##### ARG EphyTab:hidden-popup-count ##### --> -<para> - -</para> - -<!-- ##### ARG EphyTab:icon ##### --> -<para> - -</para> - -<!-- ##### ARG EphyTab:icon-address ##### --> -<para> - -</para> - -<!-- ##### ARG EphyTab:load-progress ##### --> -<para> - -</para> - -<!-- ##### ARG EphyTab:load-status ##### --> -<para> - -</para> - -<!-- ##### ARG EphyTab:message ##### --> -<para> - -</para> - -<!-- ##### ARG EphyTab:navigation ##### --> -<para> - -</para> - -<!-- ##### ARG EphyTab:popups-allowed ##### --> -<para> - -</para> - -<!-- ##### ARG EphyTab:security-level ##### --> -<para> - -</para> - -<!-- ##### ARG EphyTab:title ##### --> -<para> - -</para> - -<!-- ##### ARG EphyTab:typed-address ##### --> -<para> - -</para> - -<!-- ##### ARG EphyTab:visibility ##### --> -<para> - -</para> - -<!-- ##### ARG EphyTab:zoom ##### --> -<para> - -</para> - -<!-- ##### FUNCTION ephy_tab_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION ephy_tab_get_embed ##### --> -<para> - -</para> - -@tab: -@Returns: - - -<!-- ##### FUNCTION ephy_tab_for_embed ##### --> -<para> - -</para> - -@embed: -@Returns: - - -<!-- ##### FUNCTION ephy_tab_get_icon_address ##### --> -<para> - -</para> - -@tab: -@Returns: - - -<!-- ##### FUNCTION ephy_tab_get_security_level ##### --> -<para> - -</para> - -@tab: -@Returns: - - -<!-- ##### FUNCTION ephy_tab_get_title ##### --> -<para> - -</para> - -@tab: -@Returns: - - -<!-- ##### FUNCTION ephy_tab_get_zoom ##### --> -<para> - -</para> - -@tab: -@Returns: - - -<!-- ##### FUNCTION ephy_tab_get_load_status ##### --> -<para> - -</para> - -@tab: -@Returns: - - -<!-- ##### FUNCTION ephy_tab_get_load_percent ##### --> -<para> - -</para> - -@tab: -@Returns: - - -<!-- ##### FUNCTION ephy_tab_get_link_message ##### --> -<para> - -</para> - -@tab: -@Returns: - - -<!-- ##### FUNCTION ephy_tab_get_status_message ##### --> -<para> - -</para> - -@tab: -@Returns: - - diff --git a/doc/reference/tmpl/ephy-window.sgml b/doc/reference/tmpl/ephy-window.sgml index 23c9b1e2d..9e59c490c 100644 --- a/doc/reference/tmpl/ephy-window.sgml +++ b/doc/reference/tmpl/ephy-window.sgml @@ -2,32 +2,20 @@ EphyWindow <!-- ##### SECTION Short_Description ##### --> -Represents an Epiphany window. + <!-- ##### SECTION Long_Description ##### --> <para> -An #EphyWindow is what the user sees when opening Epiphany. Think of each -#EphyWindow as a giant container which holds many useful items: -</para> -<itemizedlist> -<listitem>A toolbar, available from ephy_window_get_toolbar().</listitem> -<listitem>An #EphyStatusbar, available from -ephy_window_get_statusbar().</listitem> -<listitem>A #GtkNotebook for holding #EphyTabs. Use ephy_window_get_notebook(), -ephy_window_get_tabs() and ephy_window_get_active_tab() to reach -them. Manipulate tabs using ephy_window_add_tab(), ephy_window_remove_tab() -and ephy_window_jump_to_tab().</listitem> -</itemizedlist> -<para> -You can also perform simple manipulations of an #EphyWindow's active #EphyEmbed. -These are restricted to ephy_window_set_zoom() and ephy_window_load_url(). + </para> + <!-- ##### SECTION See_Also ##### --> <para> </para> + <!-- ##### SECTION Stability_Level ##### --> @@ -55,7 +43,7 @@ These are restricted to ephy_window_set_zoom() and ephy_window_load_url(). @Returns: -<!-- ##### FUNCTION ephy_window_get_notebook ##### --> +<!-- ##### FUNCTION ephy_window_get_ui_manager ##### --> <para> </para> @@ -73,6 +61,24 @@ These are restricted to ephy_window_set_zoom() and ephy_window_load_url(). @Returns: +<!-- ##### FUNCTION ephy_window_get_notebook ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION ephy_window_get_find_toolbar ##### --> +<para> + +</para> + +@window: +@Returns: + + <!-- ##### FUNCTION ephy_window_get_statusbar ##### --> <para> @@ -82,6 +88,15 @@ These are restricted to ephy_window_set_zoom() and ephy_window_load_url(). @Returns: +<!-- ##### FUNCTION ephy_window_load_url ##### --> +<para> + +</para> + +@window: +@url: + + <!-- ##### FUNCTION ephy_window_set_zoom ##### --> <para> @@ -99,12 +114,21 @@ These are restricted to ephy_window_set_zoom() and ephy_window_load_url(). @window: -<!-- ##### FUNCTION ephy_window_load_url ##### --> +<!-- ##### FUNCTION ephy_window_get_is_print_preview ##### --> <para> </para> @window: -@url: +@Returns: + + +<!-- ##### FUNCTION ephy_window_get_context_event ##### --> +<para> + +</para> + +@window: +@Returns: diff --git a/doc/reference/tmpl/ephy-zoom-control.sgml b/doc/reference/tmpl/ephy-zoom-control.sgml index fcad1c60a..69b33f2af 100644 --- a/doc/reference/tmpl/ephy-zoom-control.sgml +++ b/doc/reference/tmpl/ephy-zoom-control.sgml @@ -9,11 +9,13 @@ EphyZoomControl </para> + <!-- ##### SECTION See_Also ##### --> <para> </para> + <!-- ##### SECTION Stability_Level ##### --> diff --git a/doc/reference/tmpl/epiphany-unused.sgml b/doc/reference/tmpl/epiphany-unused.sgml index ff95f58a9..e69de29bb 100644 --- a/doc/reference/tmpl/epiphany-unused.sgml +++ b/doc/reference/tmpl/epiphany-unused.sgml @@ -1,1043 +0,0 @@ -<!-- ##### SECTION ./tmpl/EphySingle.sgml:Long_Description ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/EphySingle.sgml:See_Also ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/EphySingle.sgml:Short_Description ##### --> - - - -<!-- ##### SECTION ./tmpl/EphySingle.sgml:Stability_Level ##### --> - - - -<!-- ##### SECTION ./tmpl/EphySingle.sgml:Title ##### --> -EphySingle - - -<!-- ##### SECTION ./tmpl/ephy-tab.sgml:Long_Description ##### --> -<para> -Each #EphyWindow contains a #GtkNotebook which holds one or more #EphyTab:s. -An #EphyTab is basically a container for an #EphyEmbed. -</para> -<para> -To retrieve an #EphyTab's parent #EphyWindow, use gtk_widget_get_toplevel(). -</para> - - -<!-- ##### SECTION ./tmpl/ephy-tab.sgml:See_Also ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/ephy-tab.sgml:Short_Description ##### --> -Represents an Epiphany tab - - -<!-- ##### SECTION ./tmpl/ephy-tab.sgml:Stability_Level ##### --> - - - -<!-- ##### SECTION ./tmpl/ephy-tab.sgml:Title ##### --> -EphyTab - - -<!-- ##### SECTION ./tmpl/epiphany-unused.sgml:Stability_Level ##### --> - - - -<!-- ##### SECTION ./tmpl/mozilla-embed-event.sgml:Long_Description ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/mozilla-embed-event.sgml:See_Also ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/mozilla-embed-event.sgml:Short_Description ##### --> - - - -<!-- ##### SECTION ./tmpl/mozilla-embed-event.sgml:Title ##### --> -mozilla-embed-event - - -<!-- ##### FUNCTION Detach ##### --> -<para> - -</para> - -@Returns: - -<!-- ##### MACRO EPHY_EMBED_SINGLE_IFACE ##### --> -<para> - -</para> - -@k: - -<!-- ##### MACRO EPHY_ICON_ENTRY ##### --> -<para> - -</para> - -@object: - -<!-- ##### MACRO EPHY_ICON_ENTRY_CLASS ##### --> -<para> - -</para> - -@klass: - -<!-- ##### MACRO EPHY_ICON_ENTRY_GET_CLASS ##### --> -<para> - -</para> - -@obj: - -<!-- ##### MACRO EPHY_IS_EMBED_SINGLE_IFACE ##### --> -<para> - -</para> - -@k: - -<!-- ##### MACRO EPHY_IS_ICON_ENTRY ##### --> -<para> - -</para> - -@object: - -<!-- ##### MACRO EPHY_IS_ICON_ENTRY_CLASS ##### --> -<para> - -</para> - -@klass: - -<!-- ##### MACRO EPHY_SHELL_ERROR ##### --> -<para> - -</para> - - -<!-- ##### MACRO EPHY_SHELL_TYPE_DEF ##### --> -<para> - -</para> - - -<!-- ##### MACRO EPHY_TYPE_ICON_ENTRY ##### --> -<para> - -</para> - - -<!-- ##### ENUM EmbedPersistFlags ##### --> -<para> -Determines how the #EphyEmbedPersist should act. -</para> - -@EMBED_PERSIST_COPY_PAGE: If set, download a copy of the page being browsed by - the #EphyEmbedPersist's #EphyEmbed. This should be - specified with ephy_embed_persist_set_embed(). If - unset, ephy_embed_persist_set_source() must have been - called. -@EMBED_PERSIST_MAINDOC: If set and %EMBED_PERSIST_COPY_PAGE is set, download the - #EphyEmbedPersist's #EphyEmbed's page's frameset. If - unset, download the currently-focused frame. -@EMBED_PERSIST_NO_VIEW: If set, do not display this download in the download - manager. -@EMBED_PERSIST_ASK_DESTINATION: If set, display a filechooser dialog. You must - call ephy_embed_persist_set_fc_title() and - ephy_embed_persist_set_fc_parent() before - ephy_embed_persist_save() if this is the case. - If unset, use the destination specified with - ephy_embed_persist_set_dest(). -@EMBED_PERSIST_DO_CONVERSION: - -<!-- ##### ENUM EmbedPrintPreviewNavType ##### --> -<para> -Specifies the action to perform in ephy_embed_print_preview_navigate(). -</para> - -@PRINTPREVIEW_GOTO_PAGENUM: -@PRINTPREVIEW_PREV_PAGE: -@PRINTPREVIEW_NEXT_PAGE: -@PRINTPREVIEW_HOME: -@PRINTPREVIEW_END: - -<!-- ##### ENUM EmbedReloadFlags ##### --> -<para> - -</para> - -@EMBED_RELOAD_NORMAL: -@EMBED_RELOAD_FORCE: Bypass cache and proxy while reloading a web page - -<!-- ##### ENUM EmbedSecurityLevel ##### --> -<para> -Represents the security status of an #EphyEmbed. For example, a page with an -invalid SSL certificate will have an #EmbedSecurityLevel of %STATE_IS_BROKEN. -</para> - -@STATE_IS_UNKNOWN: -@STATE_IS_INSECURE: -@STATE_IS_BROKEN: -@STATE_IS_SECURE_MED: -@STATE_IS_SECURE_LOW: -@STATE_IS_SECURE_HIGH: - -<!-- ##### ENUM EmbedState ##### --> -<para> -Represents the state of an #EphyEmbed with regards to networking negotiations. -</para> - -@EMBED_STATE_UNKNOWN: -@EMBED_STATE_START: -@EMBED_STATE_REDIRECTING: -@EMBED_STATE_TRANSFERRING: -@EMBED_STATE_NEGOTIATING: -@EMBED_STATE_STOP: -@EMBED_STATE_IS_REQUEST: -@EMBED_STATE_IS_DOCUMENT: -@EMBED_STATE_IS_NETWORK: -@EMBED_STATE_IS_WINDOW: - -<!-- ##### FUNCTION EmitCookieNotification ##### --> -<para> - -</para> - -@name: -@aSubject: -@Returns: - -<!-- ##### FUNCTION EmitPermissionNotification ##### --> -<para> - -</para> - -@name: -@aSubject: -@Returns: - -<!-- ##### ENUM EphyCookieP3PPolicy ##### --> -<para> - -</para> - -@EPHY_COOKIE_P3P_POLICY_UNKNOWN: -@EPHY_COOKIE_P3P_POLICY_NONE: -@EPHY_COOKIE_P3P_POLICY_NO_CONSENT: -@EPHY_COOKIE_P3P_POLICY_IMPLICIT_CONSENT: -@EPHY_COOKIE_P3P_POLICY_EXPLICIT_CONSENT: -@EPHY_COOKIE_P3P_POLICY_NO_II: - -<!-- ##### ENUM EphyCookieP3PState ##### --> -<para> - -</para> - -@EPHY_COOKIE_P3P_STATE_UNKNOWN: -@EPHY_COOKIE_P3P_STATE_ACCEPTED: -@EPHY_COOKIE_P3P_STATE_DOWNGRADED: -@EPHY_COOKIE_P3P_STATE_FLAGGED: -@EPHY_COOKIE_P3P_STATE_REJECTED: - -<!-- ##### SIGNAL EphyEmbed::ge-content-change ##### --> -<para> - -</para> - -@ephyembed: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL EphyEmbed::ge-location ##### --> -<para> - -</para> - -@ephyembed: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL EphyEmbed::ge-net-state ##### --> -<para> - -</para> - -@ephyembed: the object which received the signal. -@arg1: -@arg2: - -<!-- ##### SIGNAL EphyEmbed::ge-security-change ##### --> -<para> - -</para> - -@ephyembed: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL EphyEmbed::ge-zoom-change ##### --> -<para> - -</para> - -@ephyembed: the object which received the signal. -@arg1: - -<!-- ##### SIGNAL EphyEmbedPersist::cancelled ##### --> -<para> - -</para> - -@ephyembedpersist: the object which received the signal. - -<!-- ##### SIGNAL EphyEmbedPersist::completed ##### --> -<para> - -</para> - -@ephyembedpersist: the object which received the signal. - -<!-- ##### ARG EphyEmbedPersist:dest ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyEmbedPersist:embed ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyEmbedPersist:filechooser-parent ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyEmbedPersist:filechooser-title ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyEmbedPersist:flags ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyEmbedPersist:max-size ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyEmbedPersist:persist-key ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyEmbedPersist:source ##### --> -<para> - -</para> - - -<!-- ##### ENUM EphyShellError ##### --> -<para> - -</para> - -@EPHY_SHELL_ERROR_MISSING_SERVER: -@EPHY_SHELL_ERROR_OBJECT_REG_FAILED: -@EPHY_SHELL_ERROR_FACTORY_REG_FAILED: - -<!-- ##### ENUM EphyShellStartupFlags ##### --> -<para> - -</para> - -@EPHY_SHELL_STARTUP_TABS: -@EPHY_SHELL_STARTUP_EXISTING_WINDOW: -@EPHY_SHELL_STARTUP_FULLSCREEN: -@EPHY_SHELL_STARTUP_BOOKMARKS_EDITOR: -@EPHY_SHELL_STARTUP_SESSION: -@EPHY_SHELL_STARTUP_IMPORT_BOOKMARKS: -@EPHY_SHELL_STARTUP_ADD_BOOKMARK: - -<!-- ##### STRUCT EphyTab ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyTab:address ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyTab:blocked-popup-count ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyTab:document-type ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyTab:hidden-popup-count ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyTab:icon ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyTab:icon-address ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyTab:load-progress ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyTab:load-status ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyTab:message ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyTab:navigation ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyTab:popups-allowed ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyTab:security-level ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyTab:title ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyTab:typed-address ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyTab:visibility ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyTab:visible ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyTab:zoom ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyWindow:active-tab ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyWindow:chrome ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyWindow:is-popup ##### --> -<para> - -</para> - - -<!-- ##### ARG EphyWindow:print-preview-mode ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION Init ##### --> -<para> - -</para> - -@aOwner: -@Returns: - -<!-- ##### FUNCTION ephy_embed_activate ##### --> -<para> - -</para> - -@embed: - -<!-- ##### FUNCTION ephy_embed_can_go_back ##### --> -<para> - -</para> - -@embed: -@Returns: - -<!-- ##### FUNCTION ephy_embed_can_go_forward ##### --> -<para> - -</para> - -@embed: -@Returns: - -<!-- ##### FUNCTION ephy_embed_find_next ##### --> -<para> - -</para> - -@embed: -@backwards: -@Returns: - -<!-- ##### FUNCTION ephy_embed_find_set_properties ##### --> -<para> - -</para> - -@find: -@search_string: -@case_sensitive: - -<!-- ##### FUNCTION ephy_embed_get_encoding_info ##### --> -<para> - -</para> - -@embed: -@Returns: - -<!-- ##### FUNCTION ephy_embed_get_type ##### --> -<para> - -</para> - -@Returns: - -<!-- ##### FUNCTION ephy_embed_get_zoom ##### --> -<para> - -</para> - -@embed: -@Returns: - -<!-- ##### FUNCTION ephy_embed_go_back ##### --> -<para> - -</para> - -@embed: - -<!-- ##### FUNCTION ephy_embed_go_forward ##### --> -<para> - -</para> - -@embed: - -<!-- ##### FUNCTION ephy_embed_print ##### --> -<para> - -</para> - -@embed: - -<!-- ##### FUNCTION ephy_embed_print_preview_close ##### --> -<para> - -</para> - -@embed: - -<!-- ##### FUNCTION ephy_embed_reload ##### --> -<para> - -</para> - -@embed: -@force: - -<!-- ##### FUNCTION ephy_embed_set_zoom ##### --> -<para> - -</para> - -@embed: -@zoom: - -<!-- ##### FUNCTION ephy_embed_single_load_proxy_autoconf ##### --> -<para> - -</para> - -@single: -@url: -@shell: - -<!-- ##### FUNCTION ephy_embed_single_set_offline_mode ##### --> -<para> - -</para> - -@single: -@offline: -@shell: - -<!-- ##### FUNCTION ephy_embed_stop_load ##### --> -<para> - -</para> - -@embed: - -<!-- ##### FUNCTION ephy_extensions_manager_add ##### --> -<para> - -</para> - -@manager: -@type: -@Returns: - -<!-- ##### FUNCTION ephy_extensions_manager_load_dir ##### --> -<para> - -</para> - -@manager: -@path: - -<!-- ##### FUNCTION ephy_extensions_manager_new ##### --> -<para> - -</para> - -@Returns: - -<!-- ##### FUNCTION ephy_glade_widget_new ##### --> -<para> - -</para> - -@file: -@widget_name: -@root: -@data: -@domain: -@Returns: - -<!-- ##### FUNCTION ephy_node_db_get_by_name ##### --> -<para> - -</para> - -@name: -@Returns: - -<!-- ##### FUNCTION ephy_password_manager_add ##### --> -<para> - -</para> - -@manager: -@info: - -<!-- ##### FUNCTION ephy_password_manager_list ##### --> -<para> - -</para> - -@manager: -@Returns: - -<!-- ##### FUNCTION ephy_password_manager_remove ##### --> -<para> - -</para> - -@manager: -@info: - -<!-- ##### FUNCTION ephy_permission_manager_add ##### --> -<para> - -</para> - -@manager: -@host: -@type: -@permission: - -<!-- ##### FUNCTION ephy_permission_manager_clear ##### --> -<para> - -</para> - -@manager: - -<!-- ##### FUNCTION ephy_permission_manager_list ##### --> -<para> - -</para> - -@manager: -@type: -@Returns: - -<!-- ##### FUNCTION ephy_permission_manager_remove ##### --> -<para> - -</para> - -@manager: -@host: -@type: - -<!-- ##### FUNCTION ephy_permission_manager_test ##### --> -<para> - -</para> - -@manager: -@host: -@type: -@Returns: - -<!-- ##### FUNCTION ephy_session_autoresume ##### --> -<para> - -</para> - -@session: -@user_time: -@Returns: - -<!-- ##### FUNCTION ephy_shell_delete_on_exit ##### --> -<para> - -</para> - -@shell: -@path: -@gs: - -<!-- ##### FUNCTION ephy_shell_error_quark ##### --> -<para> - -</para> - -@Returns: - -<!-- ##### FUNCTION ephy_shell_get_active_window ##### --> -<para> - -</para> - -@shell: -@Returns: - -<!-- ##### FUNCTION ephy_shell_get_print_setup_dialog ##### --> -<para> - -</para> - -@shell: -@Returns: - -<!-- ##### FUNCTION ephy_shell_new ##### --> -<para> - -</para> - -@Returns: - -<!-- ##### FUNCTION ephy_shell_startup ##### --> -<para> - -</para> - -@shell: -@flags: -@user_time: -@args: -@string_arg: -@error: -@Returns: -@startup_id: - -<!-- ##### FUNCTION ephy_tab_for_embed ##### --> -<para> - -</para> - -@embed: -@Returns: - -<!-- ##### FUNCTION ephy_tab_get_embed ##### --> -<para> - -</para> - -@tab: -@Returns: - -<!-- ##### FUNCTION ephy_tab_get_icon_address ##### --> -<para> - -</para> - -@tab: -@Returns: - -<!-- ##### FUNCTION ephy_tab_get_link_message ##### --> -<para> - -</para> - -@tab: -@Returns: - -<!-- ##### FUNCTION ephy_tab_get_load_percent ##### --> -<para> - -</para> - -@tab: -@Returns: - -<!-- ##### FUNCTION ephy_tab_get_load_status ##### --> -<para> - -</para> - -@tab: -@Returns: - -<!-- ##### FUNCTION ephy_tab_get_location ##### --> -<para> - -</para> - -@tab: -@Returns: - -<!-- ##### FUNCTION ephy_tab_get_security_level ##### --> -<para> - -</para> - -@tab: -@Returns: - -<!-- ##### FUNCTION ephy_tab_get_status_message ##### --> -<para> - -</para> - -@tab: -@Returns: - -<!-- ##### FUNCTION ephy_tab_get_title ##### --> -<para> - -</para> - -@tab: -@Returns: - -<!-- ##### FUNCTION ephy_tab_get_window ##### --> -<para> - -</para> - -@tab: -@Returns: - -<!-- ##### FUNCTION ephy_tab_get_zoom ##### --> -<para> - -</para> - -@tab: -@Returns: - -<!-- ##### FUNCTION ephy_tab_new ##### --> -<para> - -</para> - -@Returns: - -<!-- ##### FUNCTION ephy_window_add_tab ##### --> -<para> - -</para> - -@window: -@tab: -@position: -@jump_to: - -<!-- ##### FUNCTION ephy_window_find ##### --> -<para> - -</para> - -@window: - -<!-- ##### FUNCTION ephy_window_get_active_embed ##### --> -<para> - -</para> - -@window: -@Returns: - -<!-- ##### FUNCTION ephy_window_get_active_tab ##### --> -<para> - -</para> - -@window: -@Returns: - -<!-- ##### FUNCTION ephy_window_get_tabs ##### --> -<para> - -</para> - -@window: -@Returns: - -<!-- ##### FUNCTION ephy_window_jump_to_tab ##### --> -<para> - -</para> - -@window: -@tab: - -<!-- ##### FUNCTION ephy_window_print ##### --> -<para> - -</para> - -@window: - -<!-- ##### FUNCTION ephy_window_remove_tab ##### --> -<para> - -</para> - -@window: -@tab: - -<!-- ##### FUNCTION ephy_window_set_print_preview ##### --> -<para> - -</para> - -@window: -@enabled: - -<!-- ##### FUNCTION mozilla_cookie_to_ephy_cookie ##### --> -<para> - -</para> - -@cookie: -@Returns: - -<!-- ##### FUNCTION mozilla_embed_event_new ##### --> -<para> - -</para> - -@dom_event: -@Returns: - -<!-- ##### FUNCTION mozilla_embed_event_set_property ##### --> -<para> - -</para> - -@event: -@name: -@value: - -<!-- ##### FUNCTION mozilla_permission_to_ephy_permission ##### --> -<para> - -</para> - -@perm: -@Returns: - diff --git a/doc/reference/tmpl/mozilla-embed-event.sgml b/doc/reference/tmpl/mozilla-embed-event.sgml deleted file mode 100644 index d8aa00dd3..000000000 --- a/doc/reference/tmpl/mozilla-embed-event.sgml +++ /dev/null @@ -1,35 +0,0 @@ -<!-- ##### SECTION Title ##### --> -mozilla-embed-event - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### FUNCTION mozilla_embed_event_new ##### --> -<para> - -</para> - -@dom_event: -@Returns: - - -<!-- ##### FUNCTION mozilla_embed_event_set_property ##### --> -<para> - -</para> - -@event: -@name: -@value: - - |