diff options
Diffstat (limited to 'doc/reference/tmpl/ephy-window.sgml')
-rw-r--r-- | doc/reference/tmpl/ephy-window.sgml | 198 |
1 files changed, 198 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..391abd920 --- /dev/null +++ b/doc/reference/tmpl/ephy-window.sgml @@ -0,0 +1,198 @@ +<!-- ##### 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> + +<!-- ##### STRUCT EphyWindow ##### --> +<para> + +</para> + +@ui_merge: The #GtkUIManager this window uses to merge user interfaces + +<!-- ##### FUNCTION ephy_window_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION ephy_window_new_with_chrome ##### --> +<para> + +</para> + +@chrome: +@Returns: + + +<!-- ##### FUNCTION ephy_window_get_notebook ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION ephy_window_add_tab ##### --> +<para> + +</para> + +@window: +@tab: +@position: +@jump_to: + + +<!-- ##### FUNCTION ephy_window_remove_tab ##### --> +<para> + +</para> + +@window: +@tab: + + +<!-- ##### FUNCTION ephy_window_jump_to_tab ##### --> +<para> + +</para> + +@window: +@tab: + + +<!-- ##### FUNCTION ephy_window_get_tabs ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION ephy_window_get_active_tab ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION ephy_window_get_active_embed ##### --> +<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_find ##### --> +<para> + +</para> + +@window: + + +<!-- ##### FUNCTION ephy_window_print ##### --> +<para> + +</para> + +@window: + + +<!-- ##### FUNCTION ephy_window_set_print_preview ##### --> +<para> + +</para> + +@window: +@enabled: + + +<!-- ##### 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: + + +<!-- ##### ARG EphyWindow:active-tab ##### --> +<para> + +</para> + +<!-- ##### ARG EphyWindow:chrome ##### --> +<para> + +</para> + |