<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="EphyWindow">
<refmeta>
<refentrytitle role="top_of_page" id="EphyWindow.top_of_page">EphyWindow</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>EPIPHANY Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>EphyWindow</refname>
<refpurpose>Represents an Epiphany window.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="EphyWindow.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="EphyWindow-struct">EphyWindow</link>;
<link linkend="EphyWindow">EphyWindow</link>*         <link linkend="ephy-window-new">ephy_window_new</link>                     (void);
<link linkend="EphyWindow">EphyWindow</link>*         <link linkend="ephy-window-new-with-chrome">ephy_window_new_with_chrome</link>         (<link linkend="EphyEmbedChrome">EphyEmbedChrome</link> chrome,
                                                         <link linkend="gboolean">gboolean</link> is_popup);
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="ephy-window-get-notebook">ephy_window_get_notebook</link>            (<link linkend="EphyWindow">EphyWindow</link> *window);
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="ephy-window-get-toolbar">ephy_window_get_toolbar</link>             (<link linkend="EphyWindow">EphyWindow</link> *window);
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="ephy-window-get-statusbar">ephy_window_get_statusbar</link>           (<link linkend="EphyWindow">EphyWindow</link> *window);
<link linkend="void">void</link>                <link linkend="ephy-window-set-zoom">ephy_window_set_zoom</link>                (<link linkend="EphyWindow">EphyWindow</link> *window,
                                                         <link linkend="float">float</link> zoom);
<link linkend="void">void</link>                <link linkend="ephy-window-activate-location">ephy_window_activate_location</link>       (<link linkend="EphyWindow">EphyWindow</link> *window);
<link linkend="void">void</link>                <link linkend="ephy-window-load-url">ephy_window_load_url</link>                (<link linkend="EphyWindow">EphyWindow</link> *window,
                                                         const <link linkend="char">char</link> *url);
</synopsis>
</refsynopsisdiv>

<refsect1 id="EphyWindow.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
         +----<link linkend="GtkObject">GtkObject</link>
               +----<link linkend="GtkWidget">GtkWidget</link>
                     +----<link linkend="GtkContainer">GtkContainer</link>
                           +----<link linkend="GtkBin">GtkBin</link>
                                 +----<link linkend="GtkWindow">GtkWindow</link>
                                       +----EphyWindow
</synopsis>

</refsect1>



<refsect1 id="EphyWindow.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
EphyWindow implements
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>,  <link linkend="GtkBuildable">GtkBuildable</link>,  <link linkend="EphyEmbedContainer">EphyEmbedContainer</link> and  <link linkend="EphyLink">EphyLink</link>.</para>

</refsect1>





<refsect1 id="EphyWindow.description" role="desc">
<title role="desc.title">Description</title>
<para>
An <link linkend="EphyWindow"><type>EphyWindow</type></link> is what the user sees when opening Epiphany. Think of each
<link linkend="EphyWindow"><type>EphyWindow</type></link> as a giant container which holds many useful items:
</para>
<itemizedlist>
<listitem>A toolbar, available from <link linkend="ephy-window-get-toolbar"><function>ephy_window_get_toolbar()</function></link>.</listitem>
<listitem>An <link linkend="EphyStatusbar"><type>EphyStatusbar</type></link>, available from
<link linkend="ephy-window-get-statusbar"><function>ephy_window_get_statusbar()</function></link>.</listitem>
<listitem>A <link linkend="GtkNotebook"><type>GtkNotebook</type></link> for holding <link linkend="EphyTabs"><type>EphyTabs</type></link>. Use <link linkend="ephy-window-get-notebook"><function>ephy_window_get_notebook()</function></link>,
<link linkend="ephy-window-get-tabs"><function>ephy_window_get_tabs()</function></link> and <link linkend="ephy-window-get-active-tab"><function>ephy_window_get_active_tab()</function></link> to reach
them. Manipulate tabs using <link linkend="ephy-window-add-tab"><function>ephy_window_add_tab()</function></link>, <link linkend="ephy-window-remove-tab"><function>ephy_window_remove_tab()</function></link>
and <link linkend="ephy-window-jump-to-tab"><function>ephy_window_jump_to_tab()</function></link>.</listitem>
</itemizedlist>
<para>
You can also perform simple manipulations of an <link linkend="EphyWindow"><type>EphyWindow</type></link>'s active <link linkend="EphyEmbed"><type>EphyEmbed</type></link>.
These are restricted to <link linkend="ephy-window-set-zoom"><function>ephy_window_set_zoom()</function></link> and <link linkend="ephy-window-load-url"><function>ephy_window_load_url()</function></link>.
</para>
</refsect1>

<refsect1 id="EphyWindow.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="EphyWindow-struct" role="struct">
<title>EphyWindow</title>
<indexterm zone="EphyWindow-struct"><primary>EphyWindow</primary></indexterm><programlisting>typedef struct _EphyWindow EphyWindow;</programlisting>
<para>

</para></refsect2>
<refsect2 id="ephy-window-new" role="function">
<title>ephy_window_new ()</title>
<indexterm zone="ephy-window-new"><primary>ephy_window_new</primary></indexterm><programlisting><link linkend="EphyWindow">EphyWindow</link>*         ephy_window_new                     (void);</programlisting>
<para>
Equivalent to <link linkend="g-object-new"><function>g_object_new()</function></link> but returns an <link linkend="EphyWindow"><type>EphyWindow</type></link> so you don't have
to cast it.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="EphyWindow"><type>EphyWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="ephy-window-new-with-chrome" role="function">
<title>ephy_window_new_with_chrome ()</title>
<indexterm zone="ephy-window-new-with-chrome"><primary>ephy_window_new_with_chrome</primary></indexterm><programlisting><link linkend="EphyWindow">EphyWindow</link>*         ephy_window_new_with_chrome         (<link linkend="EphyEmbedChrome">EphyEmbedChrome</link> chrome,
                                                         <link linkend="gboolean">gboolean</link> is_popup);</programlisting>
<para>
Identical to <link linkend="ephy-window-new"><function>ephy_window_new()</function></link>, but allows you to specify a chrome.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>chrome</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EphyEmbedChrome"><type>EphyEmbedChrome</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>is_popup</parameter>&nbsp;:</term>
<listitem><simpara> whether the new window is a popup window
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="EphyWindow"><type>EphyWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="ephy-window-get-notebook" role="function">
<title>ephy_window_get_notebook ()</title>
<indexterm zone="ephy-window-get-notebook"><primary>ephy_window_get_notebook</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          ephy_window_get_notebook            (<link linkend="EphyWindow">EphyWindow</link> *window);</programlisting>
<para>
Returns the <link linkend="GtkNotebook"><type>GtkNotebook</type></link> used by this window.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EphyWindow"><type>EphyWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the <parameter>window</parameter>'s <link linkend="GtkNotebook"><type>GtkNotebook</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="ephy-window-get-toolbar" role="function">
<title>ephy_window_get_toolbar ()</title>
<indexterm zone="ephy-window-get-toolbar"><primary>ephy_window_get_toolbar</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          ephy_window_get_toolbar             (<link linkend="EphyWindow">EphyWindow</link> *window);</programlisting>
<para>
Returns this window's toolbar as an <link linkend="EggEditableToolbar"><type>EggEditableToolbar</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EphyWindow"><type>EphyWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an <link linkend="EggEditableToolbar"><type>EggEditableToolbar</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="ephy-window-get-statusbar" role="function">
<title>ephy_window_get_statusbar ()</title>
<indexterm zone="ephy-window-get-statusbar"><primary>ephy_window_get_statusbar</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          ephy_window_get_statusbar           (<link linkend="EphyWindow">EphyWindow</link> *window);</programlisting>
<para>
Returns this window's statusbar as an <link linkend="EphyStatusbar"><type>EphyStatusbar</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EphyWindow"><type>EphyWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> This window's statusbar
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="ephy-window-set-zoom" role="function">
<title>ephy_window_set_zoom ()</title>
<indexterm zone="ephy-window-set-zoom"><primary>ephy_window_set_zoom</primary></indexterm><programlisting><link linkend="void">void</link>                ephy_window_set_zoom                (<link linkend="EphyWindow">EphyWindow</link> *window,
                                                         <link linkend="float">float</link> zoom);</programlisting>
<para>
Sets the zoom on <parameter>window</parameter>'s active <link linkend="EphyEmbed"><type>EphyEmbed</type></link>. A <parameter>zoom</parameter> of 1.0 corresponds to
100% zoom (normal size).</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EphyWindow"><type>EphyWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>zoom</parameter>&nbsp;:</term>
<listitem><simpara> the desired zoom level
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="ephy-window-activate-location" role="function">
<title>ephy_window_activate_location ()</title>
<indexterm zone="ephy-window-activate-location"><primary>ephy_window_activate_location</primary></indexterm><programlisting><link linkend="void">void</link>                ephy_window_activate_location       (<link linkend="EphyWindow">EphyWindow</link> *window);</programlisting>
<para>
Activates the location entry on <parameter>window</parameter>'s toolbar.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EphyWindow"><type>EphyWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="ephy-window-load-url" role="function">
<title>ephy_window_load_url ()</title>
<indexterm zone="ephy-window-load-url"><primary>ephy_window_load_url</primary></indexterm><programlisting><link linkend="void">void</link>                ephy_window_load_url                (<link linkend="EphyWindow">EphyWindow</link> *window,
                                                         const <link linkend="char">char</link> *url);</programlisting>
<para>
Loads a new url in the active tab of <parameter>window</parameter>.
Unlike <link linkend="ephy-embed-load-url"><function>ephy_embed_load_url()</function></link>, this function activates
the embed.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>window</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="EphyWindow"><type>EphyWindow</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>url</parameter>&nbsp;:</term>
<listitem><simpara> the url to load
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
