<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
<!ENTITY pi "&#960;">
<!ENTITY solidus "&#8260;">
]>
<refentry id="GtkCellAreaBox">
<refmeta>
<refentrytitle role="top_of_page" id="GtkCellAreaBox.top_of_page">GtkCellAreaBox</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK4 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkCellAreaBox</refname>
<refpurpose>A cell area that renders GtkCellRenderers
into a row or a column</refpurpose>
</refnamediv>

<refsect1 id="GtkCellAreaBox.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_proto_type" colwidth="150px"/>
<colspec colname="functions_proto_name"/>
<tbody>
<row><entry role="function_type"><link linkend="GtkCellArea"><returnvalue>GtkCellArea</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-cell-area-box-new">gtk_cell_area_box_new</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-cell-area-box-pack-start">gtk_cell_area_box_pack_start</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-cell-area-box-pack-end">gtk_cell_area_box_pack_end</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gint"><returnvalue>gint</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-cell-area-box-get-spacing">gtk_cell_area_box_get_spacing</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-cell-area-box-set-spacing">gtk_cell_area_box_set_spacing</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkCellAreaBox.properties" role="properties">
<title role="properties.title">Properties</title>
<informaltable frame="none">
<tgroup cols="3">
<colspec colname="properties_type" colwidth="150px"/>
<colspec colname="properties_name" colwidth="300px"/>
<colspec colname="properties_flags" colwidth="200px"/>
<tbody>
<row><entry role="property_type"><link linkend="gint"><type>gint</type></link></entry><entry role="property_name"><link linkend="GtkCellAreaBox--spacing">spacing</link></entry><entry role="property_flags">Read / Write</entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkCellAreaBox.child-properties" role="child_properties">
<title role="child_properties.title">Child Properties</title>
<informaltable frame="none">
<tgroup cols="3">
<colspec colname="child_properties_type" colwidth="150px"/>
<colspec colname="child_properties_name" colwidth="300px"/>
<colspec colname="child_properties_flags" colwidth="200px"/>
<tbody>
<row><entry role="property_type"><link linkend="gboolean"><type>gboolean</type></link></entry><entry role="property_name"><link linkend="GtkCellAreaBox--c-align">align</link></entry><entry role="property_flags">Read / Write</entry></row>
<row><entry role="property_type"><link linkend="gboolean"><type>gboolean</type></link></entry><entry role="property_name"><link linkend="GtkCellAreaBox--c-expand">expand</link></entry><entry role="property_flags">Read / Write</entry></row>
<row><entry role="property_type"><link linkend="gboolean"><type>gboolean</type></link></entry><entry role="property_name"><link linkend="GtkCellAreaBox--c-fixed-size">fixed-size</link></entry><entry role="property_flags">Read / Write</entry></row>
<row><entry role="property_type"><link linkend="GtkPackType"><type>GtkPackType</type></link></entry><entry role="property_name"><link linkend="GtkCellAreaBox--c-pack-type">pack-type</link></entry><entry role="property_flags">Read / Write</entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkCellAreaBox.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="other_proto_type" colwidth="150px"/>
<colspec colname="other_proto_name"/>
<tbody>
<row><entry role="datatype_keyword"></entry><entry role="function_name"><link linkend="GtkCellAreaBox-struct">GtkCellAreaBox</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkCellAreaBox.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen>    <link linkend="GObject">GObject</link>
    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> <link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
        <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> <link linkend="GtkCellArea">GtkCellArea</link>
            <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> GtkCellAreaBox
</screen>
</refsect1>
<refsect1 id="GtkCellAreaBox.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GtkCellAreaBox implements
 <link linkend="GtkCellLayout">GtkCellLayout</link>,  <link linkend="GtkBuildable">GtkBuildable</link> and  <link linkend="GtkOrientable">GtkOrientable</link>.</para>

</refsect1>

<refsect1 id="GtkCellAreaBox.includes"><title>Includes</title><synopsis>#include &lt;gtk/gtk.h&gt;
</synopsis></refsect1>

<refsect1 id="GtkCellAreaBox.description" role="desc">
<title role="desc.title">Description</title>
<para>The <link linkend="GtkCellAreaBox"><type>GtkCellAreaBox</type></link> renders cell renderers into a row or a column
depending on its <link linkend="GtkOrientation"><type>GtkOrientation</type></link>.</para>
<para>GtkCellAreaBox uses a notion of packing. Packing
refers to adding cell renderers with reference to a particular position
in a <link linkend="GtkCellAreaBox"><type>GtkCellAreaBox</type></link>. There are two reference positions: the
start and the end of the box.
When the <link linkend="GtkCellAreaBox"><type>GtkCellAreaBox</type></link> is oriented in the <link linkend="GTK-ORIENTATION-VERTICAL:CAPS"><literal>GTK_ORIENTATION_VERTICAL</literal></link>
orientation, the start is defined as the top of the box and the end is
defined as the bottom. In the <link linkend="GTK-ORIENTATION-HORIZONTAL:CAPS"><literal>GTK_ORIENTATION_HORIZONTAL</literal></link> orientation
start is defined as the left side and the end is defined as the right
side.</para>
<para>Alignments of <link linkend="GtkCellRenderers"><type>GtkCellRenderers</type></link> rendered in adjacent rows can be
configured by configuring the <link linkend="GtkCellAreaBox"><type>GtkCellAreaBox</type></link> align child cell property
with <link linkend="gtk-cell-area-cell-set-property"><function>gtk_cell_area_cell_set_property()</function></link> or by specifying the "align"
argument to <link linkend="gtk-cell-area-box-pack-start"><function>gtk_cell_area_box_pack_start()</function></link> and <link linkend="gtk-cell-area-box-pack-end"><function>gtk_cell_area_box_pack_end()</function></link>.</para>

</refsect1>
<refsect1 id="GtkCellAreaBox.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="gtk-cell-area-box-new" role="function">
<title>gtk_cell_area_box_new&#160;()</title>
<indexterm zone="gtk-cell-area-box-new"><primary>gtk_cell_area_box_new</primary></indexterm>
<programlisting language="C"><link linkend="GtkCellArea"><returnvalue>GtkCellArea</returnvalue></link>&#160;*
gtk_cell_area_box_new (<parameter><type>void</type></parameter>);</programlisting>
<para>Creates a new <link linkend="GtkCellAreaBox"><type>GtkCellAreaBox</type></link>.</para>
<refsect3 id="gtk-cell-area-box-new.returns" role="returns">
<title>Returns</title>
<para> a newly created <link linkend="GtkCellAreaBox"><type>GtkCellAreaBox</type></link></para>
</refsect3></refsect2>
<refsect2 id="gtk-cell-area-box-pack-start" role="function">
<title>gtk_cell_area_box_pack_start&#160;()</title>
<indexterm zone="gtk-cell-area-box-pack-start"><primary>gtk_cell_area_box_pack_start</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_cell_area_box_pack_start (<parameter><link linkend="GtkCellAreaBox"><type>GtkCellAreaBox</type></link> *box</parameter>,
                              <parameter><link linkend="GtkCellRenderer"><type>GtkCellRenderer</type></link> *renderer</parameter>,
                              <parameter><link linkend="gboolean"><type>gboolean</type></link> expand</parameter>,
                              <parameter><link linkend="gboolean"><type>gboolean</type></link> align</parameter>,
                              <parameter><link linkend="gboolean"><type>gboolean</type></link> fixed</parameter>);</programlisting>
<para>Adds <parameter>renderer</parameter>
 to <parameter>box</parameter>
, packed with reference to the start of <parameter>box</parameter>
.</para>
<para>The <parameter>renderer</parameter>
 is packed after any other <link linkend="GtkCellRenderer"><type>GtkCellRenderer</type></link> packed
with reference to the start of <parameter>box</parameter>
.</para>
<refsect3 id="gtk-cell-area-box-pack-start.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>box</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkCellAreaBox"><type>GtkCellAreaBox</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>renderer</para></entry>
<entry role="parameter_description"><para>the <link linkend="GtkCellRenderer"><type>GtkCellRenderer</type></link> to add</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>expand</para></entry>
<entry role="parameter_description"><para>whether <parameter>renderer</parameter>
should receive extra space when the area receives
more than its natural size</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>align</para></entry>
<entry role="parameter_description"><para>whether <parameter>renderer</parameter>
should be aligned in adjacent rows</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>fixed</para></entry>
<entry role="parameter_description"><para>whether <parameter>renderer</parameter>
should have the same size in all rows</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-cell-area-box-pack-end" role="function">
<title>gtk_cell_area_box_pack_end&#160;()</title>
<indexterm zone="gtk-cell-area-box-pack-end"><primary>gtk_cell_area_box_pack_end</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_cell_area_box_pack_end (<parameter><link linkend="GtkCellAreaBox"><type>GtkCellAreaBox</type></link> *box</parameter>,
                            <parameter><link linkend="GtkCellRenderer"><type>GtkCellRenderer</type></link> *renderer</parameter>,
                            <parameter><link linkend="gboolean"><type>gboolean</type></link> expand</parameter>,
                            <parameter><link linkend="gboolean"><type>gboolean</type></link> align</parameter>,
                            <parameter><link linkend="gboolean"><type>gboolean</type></link> fixed</parameter>);</programlisting>
<para>Adds <parameter>renderer</parameter>
 to <parameter>box</parameter>
, packed with reference to the end of <parameter>box</parameter>
.</para>
<para>The <parameter>renderer</parameter>
 is packed after (away from end of) any other
<link linkend="GtkCellRenderer"><type>GtkCellRenderer</type></link> packed with reference to the end of <parameter>box</parameter>
.</para>
<refsect3 id="gtk-cell-area-box-pack-end.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>box</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkCellAreaBox"><type>GtkCellAreaBox</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>renderer</para></entry>
<entry role="parameter_description"><para>the <link linkend="GtkCellRenderer"><type>GtkCellRenderer</type></link> to add</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>expand</para></entry>
<entry role="parameter_description"><para>whether <parameter>renderer</parameter>
should receive extra space when the area receives
more than its natural size</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>align</para></entry>
<entry role="parameter_description"><para>whether <parameter>renderer</parameter>
should be aligned in adjacent rows</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>fixed</para></entry>
<entry role="parameter_description"><para>whether <parameter>renderer</parameter>
should have the same size in all rows</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-cell-area-box-get-spacing" role="function">
<title>gtk_cell_area_box_get_spacing&#160;()</title>
<indexterm zone="gtk-cell-area-box-get-spacing"><primary>gtk_cell_area_box_get_spacing</primary></indexterm>
<programlisting language="C"><link linkend="gint"><returnvalue>gint</returnvalue></link>
gtk_cell_area_box_get_spacing (<parameter><link linkend="GtkCellAreaBox"><type>GtkCellAreaBox</type></link> *box</parameter>);</programlisting>
<para>Gets the spacing added between cell renderers.</para>
<refsect3 id="gtk-cell-area-box-get-spacing.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>box</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkCellAreaBox"><type>GtkCellAreaBox</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-cell-area-box-get-spacing.returns" role="returns">
<title>Returns</title>
<para> the space added between cell renderers in <parameter>box</parameter>
.</para>
</refsect3></refsect2>
<refsect2 id="gtk-cell-area-box-set-spacing" role="function">
<title>gtk_cell_area_box_set_spacing&#160;()</title>
<indexterm zone="gtk-cell-area-box-set-spacing"><primary>gtk_cell_area_box_set_spacing</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_cell_area_box_set_spacing (<parameter><link linkend="GtkCellAreaBox"><type>GtkCellAreaBox</type></link> *box</parameter>,
                               <parameter><link linkend="gint"><type>gint</type></link> spacing</parameter>);</programlisting>
<para>Sets the spacing to add between cell renderers in <parameter>box</parameter>
.</para>
<refsect3 id="gtk-cell-area-box-set-spacing.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>box</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkCellAreaBox"><type>GtkCellAreaBox</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>spacing</para></entry>
<entry role="parameter_description"><para>the space to add between <link linkend="GtkCellRenderers"><type>GtkCellRenderers</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>

</refsect1>
<refsect1 id="GtkCellAreaBox.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="GtkCellAreaBox-struct" role="struct">
<title>GtkCellAreaBox</title>
<indexterm zone="GtkCellAreaBox-struct"><primary>GtkCellAreaBox</primary></indexterm>
<programlisting language="C">typedef struct _GtkCellAreaBox GtkCellAreaBox;</programlisting>
</refsect2>

</refsect1>
<refsect1 id="GtkCellAreaBox.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GtkCellAreaBox--spacing" role="property"><title>The <literal>“spacing”</literal> property</title>
<indexterm zone="GtkCellAreaBox--spacing"><primary>GtkCellAreaBox:spacing</primary></indexterm>
<programlisting>  “spacing”                  <link linkend="gint"><type>gint</type></link></programlisting>
<para>The amount of space to reserve between cells.</para>
<para>Owner: GtkCellAreaBox</para>
<para>Flags: Read / Write</para>
<para>Allowed values: &gt;= 0</para>
<para>Default value: 0</para>
</refsect2>

</refsect1>
<refsect1 id="GtkCellAreaBox.child-property-details" role="child_property_details">
<title role="child_property_details.title">Child Property Details</title>
<refsect2 id="GtkCellAreaBox--c-align" role="property"><title>The <literal>“align”</literal> child property</title>
<indexterm zone="GtkCellAreaBox--c-align"><primary>GtkCellAreaBox:align</primary></indexterm>
<programlisting>  “align”                    <link linkend="gboolean"><type>gboolean</type></link></programlisting>
<para>Whether the cell renderer should be aligned in adjacent rows.</para>
<para>Owner: GtkCellAreaBox</para>
<para>Flags: Read / Write</para>
<para>Default value: FALSE</para>
</refsect2>
<refsect2 id="GtkCellAreaBox--c-expand" role="property"><title>The <literal>“expand”</literal> child property</title>
<indexterm zone="GtkCellAreaBox--c-expand"><primary>GtkCellAreaBox:expand</primary></indexterm>
<programlisting>  “expand”                   <link linkend="gboolean"><type>gboolean</type></link></programlisting>
<para>Whether the cell renderer should receive extra space
when the area receives more than its natural size.</para>
<para>Owner: GtkCellAreaBox</para>
<para>Flags: Read / Write</para>
<para>Default value: FALSE</para>
</refsect2>
<refsect2 id="GtkCellAreaBox--c-fixed-size" role="property"><title>The <literal>“fixed-size”</literal> child property</title>
<indexterm zone="GtkCellAreaBox--c-fixed-size"><primary>GtkCellAreaBox:fixed-size</primary></indexterm>
<programlisting>  “fixed-size”               <link linkend="gboolean"><type>gboolean</type></link></programlisting>
<para>Whether the cell renderer should require the same size
for all rows for which it was requested.</para>
<para>Owner: GtkCellAreaBox</para>
<para>Flags: Read / Write</para>
<para>Default value: TRUE</para>
</refsect2>
<refsect2 id="GtkCellAreaBox--c-pack-type" role="property"><title>The <literal>“pack-type”</literal> child property</title>
<indexterm zone="GtkCellAreaBox--c-pack-type"><primary>GtkCellAreaBox:pack-type</primary></indexterm>
<programlisting>  “pack-type”                <link linkend="GtkPackType"><type>GtkPackType</type></link></programlisting>
<para>A GtkPackType indicating whether the cell renderer is packed
with reference to the start or end of the area.</para>
<para>Owner: GtkCellAreaBox</para>
<para>Flags: Read / Write</para>
<para>Default value: GTK_PACK_START</para>
</refsect2>

</refsect1>

</refentry>
