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

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

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

<synopsis>
extern              EphyShell *<link linkend="ephy-shell">ephy_shell</link>;
enum                <link linkend="EphyNewTabFlags">EphyNewTabFlags</link>;
<link linkend="EphyEmbed">EphyEmbed</link>*          <link linkend="ephy-shell-new-tab">ephy_shell_new_tab</link>                  (<link linkend="EphyShell">EphyShell</link> *shell,
                                                         <link linkend="EphyWindow">EphyWindow</link> *parent_window,
                                                         <link linkend="EphyEmbed">EphyEmbed</link> *previous_embed,
                                                         const <link linkend="char">char</link> *url,
                                                         <link linkend="EphyNewTabFlags">EphyNewTabFlags</link> flags);
<link linkend="GObject">GObject</link>*            <link linkend="ephy-shell-get-session">ephy_shell_get_session</link>              (<link linkend="EphyShell">EphyShell</link> *shell);
<link linkend="EphyBookmarks">EphyBookmarks</link>*      <link linkend="ephy-shell-get-bookmarks">ephy_shell_get_bookmarks</link>            (<link linkend="EphyShell">EphyShell</link> *shell);
<link linkend="GObject">GObject</link>*            <link linkend="ephy-shell-get-toolbars-model">ephy_shell_get_toolbars_model</link>       (<link linkend="EphyShell">EphyShell</link> *shell,
                                                         <link linkend="gboolean">gboolean</link> fullscreen);
<link linkend="GObject">GObject</link>*            <link linkend="ephy-shell-get-extensions-manager">ephy_shell_get_extensions_manager</link>   (<link linkend="EphyShell">EphyShell</link> *shell);
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="ephy-shell-get-bookmarks-editor">ephy_shell_get_bookmarks_editor</link>     (<link linkend="EphyShell">EphyShell</link> *shell);
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="ephy-shell-get-history-window">ephy_shell_get_history_window</link>       (<link linkend="EphyShell">EphyShell</link> *shell);
<link linkend="GObject">GObject</link>*            <link linkend="ephy-shell-get-pdm-dialog">ephy_shell_get_pdm_dialog</link>           (<link linkend="EphyShell">EphyShell</link> *shell);
<link linkend="GObject">GObject</link>*            <link linkend="ephy-shell-get-prefs-dialog">ephy_shell_get_prefs_dialog</link>         (<link linkend="EphyShell">EphyShell</link> *shell);
</synopsis>
</refsynopsisdiv>









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

</para>
</refsect1>

<refsect1 id="epiphany-ephy-shell.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="ephy-shell" role="variable">
<title>ephy_shell</title>
<indexterm zone="ephy-shell"><primary>ephy_shell</primary></indexterm><programlisting>extern EphyShell *ephy_shell;
</programlisting>
<para>

</para></refsect2>
<refsect2 id="EphyNewTabFlags" role="enum">
<title>enum EphyNewTabFlags</title>
<indexterm zone="EphyNewTabFlags"><primary>EphyNewTabFlags</primary></indexterm><programlisting>typedef enum
{
	/* Page types */
	EPHY_NEW_TAB_HOME_PAGE		= 1 &lt;&lt; 0,
	EPHY_NEW_TAB_NEW_PAGE		= 1 &lt;&lt; 1,
	EPHY_NEW_TAB_OPEN_PAGE		= 1 &lt;&lt; 2,

	/* Page mode */
	EPHY_NEW_TAB_FULLSCREEN_MODE	= 1 &lt;&lt; 4,
	EPHY_NEW_TAB_DONT_SHOW_WINDOW	= 1 &lt;&lt; 5,

	/* Tabs */
	EPHY_NEW_TAB_APPEND_LAST	= 1 &lt;&lt; 7,
	EPHY_NEW_TAB_APPEND_AFTER	= 1 &lt;&lt; 8,
	EPHY_NEW_TAB_JUMP		= 1 &lt;&lt; 9,
	EPHY_NEW_TAB_IN_NEW_WINDOW	= 1 &lt;&lt; 10,
	EPHY_NEW_TAB_IN_EXISTING_WINDOW	= 1 &lt;&lt; 11,

	/* The way to load */
	EPHY_NEW_TAB_ALLOW_FIXUP	= 1 &lt;&lt; 12,
	EPHY_NEW_TAB_FROM_EXTERNAL      = 1 &lt;&lt; 13,
	
} EphyNewTabFlags;
</programlisting>
<para>

</para></refsect2>
<refsect2 id="ephy-shell-new-tab" role="function">
<title>ephy_shell_new_tab ()</title>
<indexterm zone="ephy-shell-new-tab"><primary>ephy_shell_new_tab</primary></indexterm><programlisting><link linkend="EphyEmbed">EphyEmbed</link>*          ephy_shell_new_tab                  (<link linkend="EphyShell">EphyShell</link> *shell,
                                                         <link linkend="EphyWindow">EphyWindow</link> *parent_window,
                                                         <link linkend="EphyEmbed">EphyEmbed</link> *previous_embed,
                                                         const <link linkend="char">char</link> *url,
                                                         <link linkend="EphyNewTabFlags">EphyNewTabFlags</link> flags);</programlisting>
<para>
Create a new tab and the parent window when necessary.
Use this function to open urls in new window/tabs.
</para>
<para>
ReturnValue: the created <link linkend="EphyEmbed"><type>EphyEmbed</type></link></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>shell</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="EphyShell"><type>EphyShell</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>parent_window</parameter>&nbsp;:</term>
<listitem><simpara> the target <link linkend="EphyWindow"><type>EphyWindow</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>previous_embed</parameter>&nbsp;:</term>
<listitem><simpara> the referrer embed, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>url</parameter>&nbsp;:</term>
<listitem><simpara> an url to load or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</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-shell-get-session" role="function">
<title>ephy_shell_get_session ()</title>
<indexterm zone="ephy-shell-get-session"><primary>ephy_shell_get_session</primary></indexterm><programlisting><link linkend="GObject">GObject</link>*            ephy_shell_get_session              (<link linkend="EphyShell">EphyShell</link> *shell);</programlisting>
<para>
Returns current session.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>shell</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="EphyShell"><type>EphyShell</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the current session.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="ephy-shell-get-bookmarks" role="function">
<title>ephy_shell_get_bookmarks ()</title>
<indexterm zone="ephy-shell-get-bookmarks"><primary>ephy_shell_get_bookmarks</primary></indexterm><programlisting><link linkend="EphyBookmarks">EphyBookmarks</link>*      ephy_shell_get_bookmarks            (<link linkend="EphyShell">EphyShell</link> *shell);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>shell</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-shell-get-toolbars-model" role="function">
<title>ephy_shell_get_toolbars_model ()</title>
<indexterm zone="ephy-shell-get-toolbars-model"><primary>ephy_shell_get_toolbars_model</primary></indexterm><programlisting><link linkend="GObject">GObject</link>*            ephy_shell_get_toolbars_model       (<link linkend="EphyShell">EphyShell</link> *shell,
                                                         <link linkend="gboolean">gboolean</link> fullscreen);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>shell</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fullscreen</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-shell-get-extensions-manager" role="function">
<title>ephy_shell_get_extensions_manager ()</title>
<indexterm zone="ephy-shell-get-extensions-manager"><primary>ephy_shell_get_extensions_manager</primary></indexterm><programlisting><link linkend="GObject">GObject</link>*            ephy_shell_get_extensions_manager   (<link linkend="EphyShell">EphyShell</link> *shell);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>shell</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-shell-get-bookmarks-editor" role="function">
<title>ephy_shell_get_bookmarks_editor ()</title>
<indexterm zone="ephy-shell-get-bookmarks-editor"><primary>ephy_shell_get_bookmarks_editor</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          ephy_shell_get_bookmarks_editor     (<link linkend="EphyShell">EphyShell</link> *shell);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>shell</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-shell-get-history-window" role="function">
<title>ephy_shell_get_history_window ()</title>
<indexterm zone="ephy-shell-get-history-window"><primary>ephy_shell_get_history_window</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          ephy_shell_get_history_window       (<link linkend="EphyShell">EphyShell</link> *shell);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>shell</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-shell-get-pdm-dialog" role="function">
<title>ephy_shell_get_pdm_dialog ()</title>
<indexterm zone="ephy-shell-get-pdm-dialog"><primary>ephy_shell_get_pdm_dialog</primary></indexterm><programlisting><link linkend="GObject">GObject</link>*            ephy_shell_get_pdm_dialog           (<link linkend="EphyShell">EphyShell</link> *shell);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>shell</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-shell-get-prefs-dialog" role="function">
<title>ephy_shell_get_prefs_dialog ()</title>
<indexterm zone="ephy-shell-get-prefs-dialog"><primary>ephy_shell_get_prefs_dialog</primary></indexterm><programlisting><link linkend="GObject">GObject</link>*            ephy_shell_get_prefs_dialog         (<link linkend="EphyShell">EphyShell</link> *shell);</programlisting>
<para>

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


</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
