<?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 index-Objects-Grouped SYSTEM "objects_grouped.sgml"-->
<refentry id="GtkToggleCombo">
<refmeta>
<refentrytitle role="top_of_page" id="GtkToggleCombo.top_of_page">GtkToggleCombo</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTKEXTRA Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkToggleCombo</refname>
<refpurpose>A toggle combo widget for GTK.</refpurpose>
</refnamediv>

<refsect1 id="GtkToggleCombo.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_return" colwidth="150px"/>
<colspec colname="functions_name"/>
<tbody>
<row><entry role="function_type"><link linkend="GtkWidget"><returnvalue>GtkWidget</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-toggle-combo-new">gtk_toggle_combo_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-toggle-combo-construct">gtk_toggle_combo_construct</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-toggle-combo-get-nrows">gtk_toggle_combo_get_nrows</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-toggle-combo-get-ncols">gtk_toggle_combo_get_ncols</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-toggle-combo-select">gtk_toggle_combo_select</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-toggle-combo-get-selection">gtk_toggle_combo_get_selection</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkToggleCombo.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<informaltable frame="none">
<tgroup cols="3">
<colspec colname="signals_return" colwidth="150px"/>
<colspec colname="signals_name" colwidth="300px"/>
<colspec colname="signals_flags" colwidth="200px"/>
<tbody>
<row><entry role="signal_type"><link linkend="void"><returnvalue>void</returnvalue></link></entry><entry role="signal_name"><link linkend="GtkToggleCombo-changed">changed</link></entry><entry role="signal_flags"><link linkend="G-SIGNAL-RUN-FIRST:CAPS">Run First</link></entry></row>

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

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkToggleCombo.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="GtkObject">GtkObject</link>
            <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> <link linkend="GtkWidget">GtkWidget</link>
                <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> <link linkend="GtkContainer">GtkContainer</link>
                    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> <link linkend="GtkBox">GtkBox</link>
                        <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> <link linkend="GtkHBox">GtkHBox</link>
                            <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> <link linkend="GtkComboButton">GtkComboButton</link>
                                <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> GtkToggleCombo
</screen>
</refsect1>
<refsect1 id="GtkToggleCombo.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GtkToggleCombo implements
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>,  <link linkend="GtkBuildable">GtkBuildable</link> and  <link linkend="GtkOrientable">GtkOrientable</link>.</para>

</refsect1>

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

<refsect1 id="GtkToggleCombo.description" role="desc">
<title role="desc.title">Description</title>
<para>A GtkToggleCombo is a GtkCombo which will remain 'pressed-in' when clicked. 
Clicking it again will cause the toggle combo to return to it's normal state.
A toggle combo is created by calling <link linkend="gtk-toggle-combo-new"><function>gtk_toggle_combo_new()</function></link>.
The number of rows/columns may be find out by calling <link linkend="gtk-toggle-combo-get-nrows"><function>gtk_toggle_combo_get_nrows()</function></link> or <link linkend="gtk-toggle-combo-get-ncols"><function>gtk_toggle_combo_get_ncols()</function></link>.
A combo row may be selected with <link linkend="gtk-toggle-combo-select"><function>gtk_toggle_combo_select()</function></link>.The current selection is returned by <link linkend="gtk-toggle-combo-get-selection"><function>gtk_toggle_combo_get_selection()</function></link>.</para>

</refsect1>
<refsect1 id="GtkToggleCombo.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="gtk-toggle-combo-new" role="function">
<title>gtk_toggle_combo_new&#160;()</title>
<indexterm zone="gtk-toggle-combo-new"><primary>gtk_toggle_combo_new</primary></indexterm>
<programlisting language="C"><link linkend="GtkWidget"><returnvalue>GtkWidget</returnvalue></link>&#160;*
gtk_toggle_combo_new (<parameter><link linkend="gint"><type>gint</type></link> nrows</parameter>,
                      <parameter><link linkend="gint"><type>gint</type></link> ncols</parameter>);</programlisting>
<para>Creates a new <link linkend="GtkToggleCombo"><type>GtkToggleCombo</type></link> widget with <parameter>nrows</parameter>
 rows and <parameter>ncols</parameter>
 columns.</para>
<refsect3 id="gtk-toggle-combo-new.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>nrows</para></entry>
<entry role="parameter_description"><para>number of rows</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>ncols</para></entry>
<entry role="parameter_description"><para>number of columns</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-toggle-combo-new.returns" role="returns">
<title>Returns</title>
<para> the newly-created <link linkend="GtkToggleCombo"><type>GtkToggleCombo</type></link> widget.</para>
</refsect3></refsect2>
<refsect2 id="gtk-toggle-combo-construct" role="function">
<title>gtk_toggle_combo_construct&#160;()</title>
<indexterm zone="gtk-toggle-combo-construct"><primary>gtk_toggle_combo_construct</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_toggle_combo_construct (<parameter><link linkend="GtkToggleCombo"><type>GtkToggleCombo</type></link> *toggle_combo</parameter>,
                            <parameter><link linkend="gint"><type>gint</type></link> nrows</parameter>,
                            <parameter><link linkend="gint"><type>gint</type></link> ncols</parameter>);</programlisting>
<para>Initializes the <link linkend="GtkToggleCombo"><type>GtkToggleCombo</type></link> with <parameter>nrows</parameter>
 rows and <parameter>ncols</parameter>
 columns.</para>
<refsect3 id="gtk-toggle-combo-construct.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>toggle_combo</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkToggleCombo"><type>GtkToggleCombo</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>nrows</para></entry>
<entry role="parameter_description"><para>number of rows</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>ncols</para></entry>
<entry role="parameter_description"><para>number of columns</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-toggle-combo-get-nrows" role="function">
<title>gtk_toggle_combo_get_nrows&#160;()</title>
<indexterm zone="gtk-toggle-combo-get-nrows"><primary>gtk_toggle_combo_get_nrows</primary></indexterm>
<programlisting language="C"><link linkend="gint"><returnvalue>gint</returnvalue></link>
gtk_toggle_combo_get_nrows (<parameter><link linkend="GtkToggleCombo"><type>GtkToggleCombo</type></link> *combo</parameter>);</programlisting>
<para>Get the number of rows in <link linkend="GtkToggleCombo"><type>GtkToggleCombo</type></link>.</para>
<refsect3 id="gtk-toggle-combo-get-nrows.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>combo</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkToggleCombo"><type>GtkToggleCombo</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-toggle-combo-get-nrows.returns" role="returns">
<title>Returns</title>
<para> number of rows</para>
</refsect3></refsect2>
<refsect2 id="gtk-toggle-combo-get-ncols" role="function">
<title>gtk_toggle_combo_get_ncols&#160;()</title>
<indexterm zone="gtk-toggle-combo-get-ncols"><primary>gtk_toggle_combo_get_ncols</primary></indexterm>
<programlisting language="C"><link linkend="gint"><returnvalue>gint</returnvalue></link>
gtk_toggle_combo_get_ncols (<parameter><link linkend="GtkToggleCombo"><type>GtkToggleCombo</type></link> *combo</parameter>);</programlisting>
<para>Get the number of columns in <link linkend="GtkToggleCombo"><type>GtkToggleCombo</type></link>.</para>
<refsect3 id="gtk-toggle-combo-get-ncols.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>combo</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkToggleCombo"><type>GtkToggleCombo</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-toggle-combo-get-ncols.returns" role="returns">
<title>Returns</title>
<para> number of columns</para>
</refsect3></refsect2>
<refsect2 id="gtk-toggle-combo-select" role="function">
<title>gtk_toggle_combo_select&#160;()</title>
<indexterm zone="gtk-toggle-combo-select"><primary>gtk_toggle_combo_select</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_toggle_combo_select (<parameter><link linkend="GtkToggleCombo"><type>GtkToggleCombo</type></link> *toggle_combo</parameter>,
                         <parameter><link linkend="gint"><type>gint</type></link> new_row</parameter>,
                         <parameter><link linkend="gint"><type>gint</type></link> new_col</parameter>);</programlisting>
<para>Select the cell(row,col) from <link linkend="GtkToggleCombo"><type>GtkToggleCombo</type></link>.</para>
<refsect3 id="gtk-toggle-combo-select.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>toggle_combo</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkToggleCombo"><type>GtkToggleCombo</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>new_row</para></entry>
<entry role="parameter_description"><para>number of row</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>new_col</para></entry>
<entry role="parameter_description"><para>number of column</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-toggle-combo-get-selection" role="function">
<title>gtk_toggle_combo_get_selection&#160;()</title>
<indexterm zone="gtk-toggle-combo-get-selection"><primary>gtk_toggle_combo_get_selection</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_toggle_combo_get_selection (<parameter><link linkend="GtkToggleCombo"><type>GtkToggleCombo</type></link> *combo</parameter>,
                                <parameter><link linkend="gint"><type>gint</type></link> *row</parameter>,
                                <parameter><link linkend="gint"><type>gint</type></link> *col</parameter>);</programlisting>
<para>Get the current selection(row,col) in <link linkend="GtkToggleCombo"><type>GtkToggleCombo</type></link>.</para>
<refsect3 id="gtk-toggle-combo-get-selection.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>combo</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkToggleCombo"><type>GtkToggleCombo</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>row</para></entry>
<entry role="parameter_description"><para>number of row</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>col</para></entry>
<entry role="parameter_description"><para>number of column</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>

</refsect1>
<refsect1 id="GtkToggleCombo.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="GtkToggleCombo-struct" role="struct">
<title>struct GtkToggleCombo</title>
<indexterm zone="GtkToggleCombo-struct"><primary>GtkToggleCombo</primary></indexterm>
<programlisting language="C">struct GtkToggleCombo;</programlisting>
<para>The GtkToggleCombo struct contains only private data.
It should only be accessed through the functions described below.</para>
</refsect2>

</refsect1>
<refsect1 id="GtkToggleCombo.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="GtkToggleCombo-changed" role="signal"><title>The <literal>“changed”</literal> signal</title>
<indexterm zone="GtkToggleCombo-changed"><primary>GtkToggleCombo::changed</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
user_function (<link linkend="GtkToggleCombo"><type>GtkToggleCombo</type></link> *toggle_combo,
               <link linkend="gint"><type>gint</type></link>            row,
               <link linkend="gint"><type>gint</type></link>            col,
               <link linkend="gpointer"><type>gpointer</type></link>        user_data)</programlisting>
<para>Emmited when the <parameter>row</parameter>
,<parameter>col</parameter>
 are selected in <link linkend="GtkToggleCombo"><type>GtkToggleCombo</type></link></para>
<refsect3 id="GtkToggleCombo-changed.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>toggle_combo</para></entry>
<entry role="parameter_description"><para>the <link linkend="GtkToggleCombo"><type>GtkToggleCombo</type></link> object that received the signal</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>row</para></entry>
<entry role="parameter_description"><para>row number</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>col</para></entry>
<entry role="parameter_description"><para>column number</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><simpara>user_data</simpara></entry>
<entry role="parameter_description"><simpara>user data set when the signal handler was connected.</simpara></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para>Flags: <link linkend="G-SIGNAL-RUN-FIRST:CAPS">Run First</link></para>
</refsect2>
</refsect1>

</refentry>