<refentry id="ECellToggle">
<refmeta>
<refentrytitle>ECellToggle</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GAL Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>ECellToggle</refname><refpurpose></refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>

<synopsis>



#define     <link linkend="E-CELL-TOGGLE-TYPE:CAPS">E_CELL_TOGGLE_TYPE</link>
typedef     <link linkend="ECellToggle">ECellToggle</link>;
<link linkend="ECell">ECell</link>*      <link linkend="e-cell-toggle-new">e_cell_toggle_new</link>               (<link linkend="int">int</link> border,
                                             <link linkend="int">int</link> n_states,
                                             <link linkend="GdkPixbuf">GdkPixbuf</link> **images);
<link linkend="void">void</link>        <link linkend="e-cell-toggle-construct">e_cell_toggle_construct</link>         (<link linkend="ECellToggle">ECellToggle</link> *etog,
                                             <link linkend="int">int</link> border,
                                             <link linkend="int">int</link> n_states,
                                             <link linkend="GdkPixbuf">GdkPixbuf</link> **images);

</synopsis>
</refsynopsisdiv>

<refsect1>
<title>Object Hierarchy</title>
<synopsis>

  <link linkend="GtkObject">GtkObject</link>
   +----<link linkend="ECell">ECell</link>
         +----ECellToggle
               +----<link linkend="ECellCheckbox">ECellCheckbox</link>
</synopsis>

</refsect1>








<refsect1>
<title>Description</title>
<para>

</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="E-CELL-TOGGLE-TYPE:CAPS">E_CELL_TOGGLE_TYPE</title>
<indexterm><primary>E_CELL_TOGGLE_TYPE</primary></indexterm><programlisting>#define E_CELL_TOGGLE_TYPE        (e_cell_toggle_get_type ())
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="ECellToggle">ECellToggle</title>
<indexterm><primary>ECellToggle</primary></indexterm><programlisting>typedef struct {
	ECell parent;

	int        border;
	int        n_states;
	GdkPixbuf **images;

	int        height;
} ECellToggle;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="e-cell-toggle-new">e_cell_toggle_new ()</title>
<indexterm><primary>e_cell_toggle_new</primary></indexterm><programlisting><link linkend="ECell">ECell</link>*      e_cell_toggle_new               (<link linkend="int">int</link> border,
                                             <link linkend="int">int</link> n_states,
                                             <link linkend="GdkPixbuf">GdkPixbuf</link> **images);</programlisting>
<para>

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


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-cell-toggle-construct">e_cell_toggle_construct ()</title>
<indexterm><primary>e_cell_toggle_construct</primary></indexterm><programlisting><link linkend="void">void</link>        e_cell_toggle_construct         (<link linkend="ECellToggle">ECellToggle</link> *etog,
                                             <link linkend="int">int</link> border,
                                             <link linkend="int">int</link> n_states,
                                             <link linkend="GdkPixbuf">GdkPixbuf</link> **images);</programlisting>
<para>
Constructs the <parameter>etog</parameter> object with the <parameter>border</parameter>, <parameter>n_staes</parameter>, and <parameter>images</parameter>
arguments.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>etog</parameter>&nbsp;:</term>
<listitem><simpara> a fresh ECellToggle object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>border</parameter>&nbsp;:</term>
<listitem><simpara> number of pixels used as a border
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>n_states</parameter>&nbsp;:</term>
<listitem><simpara> number of states the toggle will have
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>images</parameter>&nbsp;:</term>
<listitem><simpara> a collection of <parameter>n_states</parameter> images, one for each state.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
