<?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="epiphany-ephy-session">
<refmeta>
<refentrytitle role="top_of_page" id="epiphany-ephy-session.top_of_page">ephy-session</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>EPIPHANY Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>ephy-session</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="epiphany-ephy-session.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
<link linkend="EphyWindow">EphyWindow</link> *        <link linkend="ephy-session-get-active-window">ephy_session_get_active_window</link>      (<link linkend="EphySession">EphySession</link> *session);
<link linkend="gboolean">gboolean</link>            <link linkend="ephy-session-save">ephy_session_save</link>                   (<link linkend="EphySession">EphySession</link> *session,
                                                         const <link linkend="char">char</link> *filename);
<link linkend="gboolean">gboolean</link>            <link linkend="ephy-session-load">ephy_session_load</link>                   (<link linkend="EphySession">EphySession</link> *session,
                                                         const <link linkend="char">char</link> *filename,
                                                         <link linkend="guint32">guint32</link> user_time);
<link linkend="void">void</link>                <link linkend="ephy-session-close">ephy_session_close</link>                  (<link linkend="EphySession">EphySession</link> *session);
<link linkend="GList">GList</link> *             <link linkend="ephy-session-get-windows">ephy_session_get_windows</link>            (<link linkend="EphySession">EphySession</link> *session);
<link linkend="void">void</link>                <link linkend="ephy-session-add-window">ephy_session_add_window</link>             (<link linkend="EphySession">EphySession</link> *session,
                                                         <link linkend="GtkWindow">GtkWindow</link> *window);
<link linkend="void">void</link>                <link linkend="ephy-session-remove-window">ephy_session_remove_window</link>          (<link linkend="EphySession">EphySession</link> *session,
                                                         <link linkend="GtkWindow">GtkWindow</link> *window);
</synopsis>
</refsynopsisdiv>









<refsect1 id="epiphany-ephy-session.description" role="desc">
<title role="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 id="epiphany-ephy-session.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="ephy-session-get-active-window" role="function">
<title>ephy_session_get_active_window ()</title>
<indexterm zone="ephy-session-get-active-window"><primary>ephy_session_get_active_window</primary></indexterm><programlisting><link linkend="EphyWindow">EphyWindow</link> *        ephy_session_get_active_window      (<link linkend="EphySession">EphySession</link> *session);</programlisting>
<para>
Get the current active browser window. Use it when you
need to take an action (like opening an url) on
a window but you dont have a target window.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="EphySession"><type>EphySession</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the current active non-popup browser window, or NULL of there is none.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="ephy-session-save" role="function">
<title>ephy_session_save ()</title>
<indexterm zone="ephy-session-save"><primary>ephy_session_save</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            ephy_session_save                   (<link linkend="EphySession">EphySession</link> *session,
                                                         const <link linkend="char">char</link> *filename);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="ephy-session-load" role="function">
<title>ephy_session_load ()</title>
<indexterm zone="ephy-session-load"><primary>ephy_session_load</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            ephy_session_load                   (<link linkend="EphySession">EphySession</link> *session,
                                                         const <link linkend="char">char</link> *filename,
                                                         <link linkend="guint32">guint32</link> user_time);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_time</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="ephy-session-close" role="function">
<title>ephy_session_close ()</title>
<indexterm zone="ephy-session-close"><primary>ephy_session_close</primary></indexterm><programlisting><link linkend="void">void</link>                ephy_session_close                  (<link linkend="EphySession">EphySession</link> *session);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="ephy-session-get-windows" role="function">
<title>ephy_session_get_windows ()</title>
<indexterm zone="ephy-session-get-windows"><primary>ephy_session_get_windows</primary></indexterm><programlisting><link linkend="GList">GList</link> *             ephy_session_get_windows            (<link linkend="EphySession">EphySession</link> *session);</programlisting>
<para>
</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the list of open <link linkend="EphyWindow--s"><type>"s"</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="ephy-session-add-window" role="function">
<title>ephy_session_add_window ()</title>
<indexterm zone="ephy-session-add-window"><primary>ephy_session_add_window</primary></indexterm><programlisting><link linkend="void">void</link>                ephy_session_add_window             (<link linkend="EphySession">EphySession</link> *session,
                                                         <link linkend="GtkWindow">GtkWindow</link> *window);</programlisting>
<para>
Add a tool window to the session. <link linkend="EphyWindow"><type>EphyWindow</type></link> take care of adding
itself to session.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>window</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="EphyWindow"><type>EphyWindow</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="ephy-session-remove-window" role="function">
<title>ephy_session_remove_window ()</title>
<indexterm zone="ephy-session-remove-window"><primary>ephy_session_remove_window</primary></indexterm><programlisting><link linkend="void">void</link>                ephy_session_remove_window          (<link linkend="EphySession">EphySession</link> *session,
                                                         <link linkend="GtkWindow">GtkWindow</link> *window);</programlisting>
<para>
Remove a tool window from the session.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="EphySession"><type>EphySession</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>window</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GtkWindow"><type>GtkWindow</type></link>, which must be either the bookmarks editor or the
history window.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
