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

<refnamediv>
<refname>ETableGroupContainer</refname><refpurpose></refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>

<synopsis>



#define     <link linkend="E-TABLE-GROUP-CONTAINER-TYPE:CAPS">E_TABLE_GROUP_CONTAINER_TYPE</link>
typedef     <link linkend="ETableGroupContainer">ETableGroupContainer</link>;
<link linkend="ETableGroup">ETableGroup</link>* <link linkend="e-table-group-container-new">e_table_group_container_new</link>    (<link linkend="GnomeCanvasGroup">GnomeCanvasGroup</link> *parent,
                                             <link linkend="ETableHeader">ETableHeader</link> *full_header,
                                             <link linkend="ETableHeader">ETableHeader</link> *header,
                                             <link linkend="ETableModel">ETableModel</link> *model,
                                             <link linkend="ETableSortInfo">ETableSortInfo</link> *sort_info,
                                             <link linkend="int">int</link> n);
<link linkend="void">void</link>        <link linkend="e-table-group-container-construct">e_table_group_container_construct</link>
                                            (<link linkend="GnomeCanvasGroup">GnomeCanvasGroup</link> *parent,
                                             <link linkend="ETableGroupContainer">ETableGroupContainer</link> *etgc,
                                             <link linkend="ETableHeader">ETableHeader</link> *full_header,
                                             <link linkend="ETableHeader">ETableHeader</link> *header,
                                             <link linkend="ETableModel">ETableModel</link> *model,
                                             <link linkend="ETableSortInfo">ETableSortInfo</link> *sort_info,
                                             <link linkend="int">int</link> n);

</synopsis>
</refsynopsisdiv>

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

  <link linkend="GtkObject">GtkObject</link>
   +----<link linkend="GnomeCanvasItem">GnomeCanvasItem</link>
         +----<link linkend="GnomeCanvasGroup">GnomeCanvasGroup</link>
               +----<link linkend="ETableGroup">ETableGroup</link>
                     +----ETableGroupContainer
</synopsis>

</refsect1>





<refsect1>
<title>Properties</title>
<synopsis>

  &quot;<link linkend="ETableGroupContainer--drawgrid">drawgrid</link>&quot;             <link linkend="gboolean">gboolean</link>              : Write
  &quot;<link linkend="ETableGroupContainer--drawfocus">drawfocus</link>&quot;            <link linkend="gboolean">gboolean</link>              : Write
  &quot;<link linkend="ETableGroupContainer--cursor-mode">cursor-mode</link>&quot;          <link linkend="gint">gint</link>                  : Write
  &quot;<link linkend="ETableGroupContainer--table-selection-model">table-selection-model</link>&quot; <link linkend="GtkObject">GtkObject</link>             : Write
  &quot;<link linkend="ETableGroupContainer--length-threshold">length-threshold</link>&quot;     <link linkend="gint">gint</link>                  : Write
  &quot;<link linkend="ETableGroupContainer--frozen">frozen</link>&quot;               <link linkend="gboolean">gboolean</link>              : Read / Write
  &quot;<link linkend="ETableGroupContainer--height">height</link>&quot;               <link linkend="gdouble">gdouble</link>               : Read
  &quot;<link linkend="ETableGroupContainer--width">width</link>&quot;                <link linkend="gdouble">gdouble</link>               : Read / Write
  &quot;<link linkend="ETableGroupContainer--minimum-width">minimum-width</link>&quot;        <link linkend="gdouble">gdouble</link>               : Read / Write
</synopsis>
</refsect1>



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

</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="E-TABLE-GROUP-CONTAINER-TYPE:CAPS">E_TABLE_GROUP_CONTAINER_TYPE</title>
<indexterm><primary>E_TABLE_GROUP_CONTAINER_TYPE</primary></indexterm><programlisting>#define E_TABLE_GROUP_CONTAINER_TYPE        (e_table_group_container_get_type ())
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="ETableGroupContainer">ETableGroupContainer</title>
<indexterm><primary>ETableGroupContainer</primary></indexterm><programlisting>typedef struct {
	ETableGroup group;

	/*
	 * The ETableCol used to group this set
	 */
	ETableCol    *ecol;
	gint          ascending;

	/*
	 * List of ETableGroups we stack
	 */
	GList *children;

	/*
	 * The canvas rectangle that contains the children
	 */
	GnomeCanvasItem *rect;

	GdkFont *font;

	gdouble width, height, minimum_width;

	ETableSortInfo *sort_info;
	int n;
	int length_threshold;

	ETableSelectionModel *table_selection_model;

	guint draw_grid : 1;
	guint draw_focus : 1;
	ETableCursorMode cursor_mode;

	/*
	 * State: the ETableGroup is open or closed
	 */
	guint open:1;
} ETableGroupContainer;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="e-table-group-container-new">e_table_group_container_new ()</title>
<indexterm><primary>e_table_group_container_new</primary></indexterm><programlisting><link linkend="ETableGroup">ETableGroup</link>* e_table_group_container_new    (<link linkend="GnomeCanvasGroup">GnomeCanvasGroup</link> *parent,
                                             <link linkend="ETableHeader">ETableHeader</link> *full_header,
                                             <link linkend="ETableHeader">ETableHeader</link> *header,
                                             <link linkend="ETableModel">ETableModel</link> *model,
                                             <link linkend="ETableSortInfo">ETableSortInfo</link> *sort_info,
                                             <link linkend="int">int</link> n);</programlisting>
<para>
<literal>ETableGroupContainer</literal> is an <literal>ETableGroup</literal> which groups by the nth
grouping of the <literal>ETableSortInfo</literal>.  It creates <literal>ETableGroups</literal> as
children.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>parent</parameter>&nbsp;:</term>
<listitem><simpara> The <literal>GnomeCanvasGroup</literal> to create a child of.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>full_header</parameter>&nbsp;:</term>
<listitem><simpara> The full header of the <literal>ETable</literal>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>header</parameter>&nbsp;:</term>
<listitem><simpara> The current header of the <literal>ETable</literal>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> The <literal>ETableModel</literal> of the <literal>ETable</literal>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>sort_info</parameter>&nbsp;:</term>
<listitem><simpara> The <literal>ETableSortInfo</literal> of the <literal>ETable</literal>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>n</parameter>&nbsp;:</term>
<listitem><simpara> Which grouping level this is (Starts at 0 and sends n + 1 to any child <literal>ETableGroups</literal>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The new <literal>ETableGroupContainer</literal>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-table-group-container-construct">e_table_group_container_construct ()</title>
<indexterm><primary>e_table_group_container_construct</primary></indexterm><programlisting><link linkend="void">void</link>        e_table_group_container_construct
                                            (<link linkend="GnomeCanvasGroup">GnomeCanvasGroup</link> *parent,
                                             <link linkend="ETableGroupContainer">ETableGroupContainer</link> *etgc,
                                             <link linkend="ETableHeader">ETableHeader</link> *full_header,
                                             <link linkend="ETableHeader">ETableHeader</link> *header,
                                             <link linkend="ETableModel">ETableModel</link> *model,
                                             <link linkend="ETableSortInfo">ETableSortInfo</link> *sort_info,
                                             <link linkend="int">int</link> n);</programlisting>
<para>
This routine constructs the new <literal>ETableGroupContainer</literal>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>parent</parameter>&nbsp;:</term>
<listitem><simpara> The <literal>GnomeCanvasGroup</literal> to create a child of.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>etgc</parameter>&nbsp;:</term>
<listitem><simpara> The <literal>ETableGroupContainer</literal>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>full_header</parameter>&nbsp;:</term>
<listitem><simpara> The full header of the <literal>ETable</literal>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>header</parameter>&nbsp;:</term>
<listitem><simpara> The current header of the <literal>ETable</literal>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> The <literal>ETableModel</literal> of the <literal>ETable</literal>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>sort_info</parameter>&nbsp;:</term>
<listitem><simpara> The <literal>ETableSortInfo</literal> of the <literal>ETable</literal>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>n</parameter>&nbsp;:</term>
<listitem><simpara> Which grouping level this is (Starts at 0 and sends n + 1 to any child <literal>ETableGroups</literal>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1>
<title>Properties</title>
<refsect2><title><anchor id="ETableGroupContainer--drawgrid">The &quot;<literal>drawgrid</literal>&quot; property</title>
<programlisting>  &quot;drawgrid&quot;             <link linkend="gboolean">gboolean</link>              : Write</programlisting>
<para></para></refsect2>
<refsect2><title><anchor id="ETableGroupContainer--drawfocus">The &quot;<literal>drawfocus</literal>&quot; property</title>
<programlisting>  &quot;drawfocus&quot;            <link linkend="gboolean">gboolean</link>              : Write</programlisting>
<para></para></refsect2>
<refsect2><title><anchor id="ETableGroupContainer--cursor-mode">The &quot;<literal>cursor-mode</literal>&quot; property</title>
<programlisting>  &quot;cursor-mode&quot;          <link linkend="gint">gint</link>                  : Write</programlisting>
<para></para></refsect2>
<refsect2><title><anchor id="ETableGroupContainer--table-selection-model">The &quot;<literal>table-selection-model</literal>&quot; property</title>
<programlisting>  &quot;table-selection-model&quot; <link linkend="GtkObject">GtkObject</link>             : Write</programlisting>
<para></para></refsect2>
<refsect2><title><anchor id="ETableGroupContainer--length-threshold">The &quot;<literal>length-threshold</literal>&quot; property</title>
<programlisting>  &quot;length-threshold&quot;     <link linkend="gint">gint</link>                  : Write</programlisting>
<para></para></refsect2>
<refsect2><title><anchor id="ETableGroupContainer--frozen">The &quot;<literal>frozen</literal>&quot; property</title>
<programlisting>  &quot;frozen&quot;               <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para></para></refsect2>
<refsect2><title><anchor id="ETableGroupContainer--height">The &quot;<literal>height</literal>&quot; property</title>
<programlisting>  &quot;height&quot;               <link linkend="gdouble">gdouble</link>               : Read</programlisting>
<para></para></refsect2>
<refsect2><title><anchor id="ETableGroupContainer--width">The &quot;<literal>width</literal>&quot; property</title>
<programlisting>  &quot;width&quot;                <link linkend="gdouble">gdouble</link>               : Read / Write</programlisting>
<para></para></refsect2>
<refsect2><title><anchor id="ETableGroupContainer--minimum-width">The &quot;<literal>minimum-width</literal>&quot; property</title>
<programlisting>  &quot;minimum-width&quot;        <link linkend="gdouble">gdouble</link>               : Read / Write</programlisting>
<para></para></refsect2>

</refsect1>




</refentry>
