aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/tmpl/ephy-window.sgml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/reference/tmpl/ephy-window.sgml')
-rw-r--r--doc/reference/tmpl/ephy-window.sgml110
1 files changed, 110 insertions, 0 deletions
diff --git a/doc/reference/tmpl/ephy-window.sgml b/doc/reference/tmpl/ephy-window.sgml
new file mode 100644
index 000000000..23c9b1e2d
--- /dev/null
+++ b/doc/reference/tmpl/ephy-window.sgml
@@ -0,0 +1,110 @@
+<!-- ##### SECTION Title ##### -->
+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 ##### -->
+
+
+<!-- ##### STRUCT EphyWindow ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION ephy_window_new ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_window_new_with_chrome ##### -->
+<para>
+
+</para>
+
+@chrome:
+@is_popup:
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_window_get_notebook ##### -->
+<para>
+
+</para>
+
+@window:
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_window_get_toolbar ##### -->
+<para>
+
+</para>
+
+@window:
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_window_get_statusbar ##### -->
+<para>
+
+</para>
+
+@window:
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_window_set_zoom ##### -->
+<para>
+
+</para>
+
+@window:
+@zoom:
+
+
+<!-- ##### FUNCTION ephy_window_activate_location ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### FUNCTION ephy_window_load_url ##### -->
+<para>
+
+</para>
+
+@window:
+@url:
+
+