aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/tmpl/ephy-embed-single.sgml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/reference/tmpl/ephy-embed-single.sgml')
-rw-r--r--doc/reference/tmpl/ephy-embed-single.sgml52
1 files changed, 34 insertions, 18 deletions
diff --git a/doc/reference/tmpl/ephy-embed-single.sgml b/doc/reference/tmpl/ephy-embed-single.sgml
index 29899db97..3368ee788 100644
--- a/doc/reference/tmpl/ephy-embed-single.sgml
+++ b/doc/reference/tmpl/ephy-embed-single.sgml
@@ -1,40 +1,47 @@
<!-- ##### SECTION Title ##### -->
-ephy-embed-single
+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>
-
-<!-- ##### SECTION See_Also ##### -->
<para>
+<example>
+<title>Acquiring an <structname>EphyEmbedSingle</structname></title>
+<programlisting>#<![CDATA[include <ephy-embed-shell.h>]]>
+#<![CDATA[include <ephy-embed-single.h>
-</para>
+EphyEmbedSingle *ephy_single;
-<!-- ##### MACRO EPHY_EMBED_SINGLE_IFACE ##### -->
+/* 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>
-@k:
-
-
-<!-- ##### MACRO EPHY_IS_EMBED_SINGLE_IFACE ##### -->
+<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-@k:
-
-
<!-- ##### FUNCTION ephy_embed_single_clear_cache ##### -->
<para>
</para>
+@single:
+<!-- # Unused Parameters # -->
@shell:
@@ -43,6 +50,8 @@ ephy-embed-single
</para>
+@single:
+<!-- # Unused Parameters # -->
@shell:
@@ -51,8 +60,10 @@ ephy-embed-single
</para>
-@shell:
+@single:
@offline:
+<!-- # Unused Parameters # -->
+@shell:
<!-- ##### FUNCTION ephy_embed_single_load_proxy_autoconf ##### -->
@@ -60,8 +71,10 @@ ephy-embed-single
</para>
-@shell:
+@single:
@url:
+<!-- # Unused Parameters # -->
+@shell:
<!-- ##### FUNCTION ephy_embed_single_get_font_list ##### -->
@@ -69,8 +82,11 @@ ephy-embed-single
</para>
+@single:
+@lang_group:
+@Returns:
+<!-- # Unused Parameters # -->
@shell:
@langGroup:
-@Returns: