<?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="GtkCellRendererAccel">
<refmeta>
<refentrytitle role="top_of_page" id="GtkCellRendererAccel.top_of_page">GtkCellRendererAccel</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK4 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkCellRendererAccel</refname>
<refpurpose>Renders a keyboard accelerator in a cell</refpurpose>
</refnamediv>

<refsect1 id="GtkCellRendererAccel.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="GtkCellRenderer"><returnvalue>GtkCellRenderer</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-cell-renderer-accel-new">gtk_cell_renderer_accel_new</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkCellRendererAccel.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="guint"><type>guint</type></link></entry><entry role="property_name"><link linkend="GtkCellRendererAccel--accel-key">accel-key</link></entry><entry role="property_flags">Read / Write</entry></row>
<row><entry role="property_type"><link linkend="GtkCellRendererAccelMode"><type>GtkCellRendererAccelMode</type></link></entry><entry role="property_name"><link linkend="GtkCellRendererAccel--accel-mode">accel-mode</link></entry><entry role="property_flags">Read / Write</entry></row>
<row><entry role="property_type"><link linkend="GdkModifierType"><type>GdkModifierType</type></link></entry><entry role="property_name"><link linkend="GtkCellRendererAccel--accel-mods">accel-mods</link></entry><entry role="property_flags">Read / Write</entry></row>
<row><entry role="property_type"><link linkend="guint"><type>guint</type></link></entry><entry role="property_name"><link linkend="GtkCellRendererAccel--keycode">keycode</link></entry><entry role="property_flags">Read / Write</entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkCellRendererAccel.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<informaltable frame="none">
<tgroup cols="3">
<colspec colname="signal_proto_type" colwidth="150px"/>
<colspec colname="signal_proto_name" colwidth="300px"/>
<colspec colname="signal_proto_flags" colwidth="200px"/>
<tbody>
<row><entry role="signal_type"><link linkend="void"><returnvalue>void</returnvalue></link></entry><entry role="signal_name"><link linkend="GtkCellRendererAccel-accel-cleared">accel-cleared</link></entry><entry role="signal_flags"><link linkend="G-SIGNAL-RUN-LAST:CAPS">Run Last</link></entry></row>
<row><entry role="signal_type"><link linkend="void"><returnvalue>void</returnvalue></link></entry><entry role="signal_name"><link linkend="GtkCellRendererAccel-accel-edited">accel-edited</link></entry><entry role="signal_flags"><link linkend="G-SIGNAL-RUN-LAST:CAPS">Run Last</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkCellRendererAccel.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="GtkCellRendererAccel-struct">GtkCellRendererAccel</link></entry></row>
<row><entry role="datatype_keyword">enum</entry><entry role="function_name"><link linkend="GtkCellRendererAccelMode">GtkCellRendererAccelMode</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkCellRendererAccel.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="GtkCellRenderer">GtkCellRenderer</link>
            <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> <link linkend="GtkCellRendererText">GtkCellRendererText</link>
                <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> GtkCellRendererAccel
</screen>
</refsect1>

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

<refsect1 id="GtkCellRendererAccel.description" role="desc">
<title role="desc.title">Description</title>
<para><link linkend="GtkCellRendererAccel"><type>GtkCellRendererAccel</type></link> displays a keyboard accelerator (i.e. a key
combination like <literal>Control + a</literal>). If the cell renderer is editable,
the accelerator can be changed by simply typing the new combination.</para>
<para>The <link linkend="GtkCellRendererAccel"><type>GtkCellRendererAccel</type></link> cell renderer was added in GTK+ 2.10.</para>

</refsect1>
<refsect1 id="GtkCellRendererAccel.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="gtk-cell-renderer-accel-new" role="function">
<title>gtk_cell_renderer_accel_new&#160;()</title>
<indexterm zone="gtk-cell-renderer-accel-new"><primary>gtk_cell_renderer_accel_new</primary></indexterm>
<programlisting language="C"><link linkend="GtkCellRenderer"><returnvalue>GtkCellRenderer</returnvalue></link>&#160;*
gtk_cell_renderer_accel_new (<parameter><type>void</type></parameter>);</programlisting>
<para>Creates a new <link linkend="GtkCellRendererAccel"><type>GtkCellRendererAccel</type></link>.</para>
<refsect3 id="gtk-cell-renderer-accel-new.returns" role="returns">
<title>Returns</title>
<para> the new cell renderer</para>
</refsect3></refsect2>

</refsect1>
<refsect1 id="GtkCellRendererAccel.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="GtkCellRendererAccel-struct" role="struct">
<title>GtkCellRendererAccel</title>
<indexterm zone="GtkCellRendererAccel-struct"><primary>GtkCellRendererAccel</primary></indexterm>
<programlisting language="C">typedef struct _GtkCellRendererAccel GtkCellRendererAccel;</programlisting>
</refsect2>
<refsect2 id="GtkCellRendererAccelMode" role="enum">
<title>enum GtkCellRendererAccelMode</title>
<indexterm zone="GtkCellRendererAccelMode"><primary>GtkCellRendererAccelMode</primary></indexterm>
<para>Determines if the edited accelerators are GTK+ accelerators. If
they are, consumed modifiers are suppressed, only accelerators
accepted by GTK+ are allowed, and the accelerators are rendered
in the same way as they are in menus.</para>
<refsect3 id="GtkCellRendererAccelMode.members" role="enum_members">
<title>Members</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="enum_members_name" colwidth="300px"/>
<colspec colname="enum_members_description"/>
<colspec colname="enum_members_annotations" colwidth="200px"/>
<tbody>
<row role="constant"><entry role="enum_member_name"><para id="GTK-CELL-RENDERER-ACCEL-MODE-GTK:CAPS">GTK_CELL_RENDERER_ACCEL_MODE_GTK</para></entry>
<entry role="enum_member_description"><para>GTK+ accelerators mode</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="GTK-CELL-RENDERER-ACCEL-MODE-OTHER:CAPS">GTK_CELL_RENDERER_ACCEL_MODE_OTHER</para></entry>
<entry role="enum_member_description"><para>Other accelerator mode</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>

</refsect1>
<refsect1 id="GtkCellRendererAccel.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GtkCellRendererAccel--accel-key" role="property"><title>The <literal>“accel-key”</literal> property</title>
<indexterm zone="GtkCellRendererAccel--accel-key"><primary>GtkCellRendererAccel:accel-key</primary></indexterm>
<programlisting>  “accel-key”                <link linkend="guint"><type>guint</type></link></programlisting>
<para>The keyval of the accelerator.</para>
<para>Owner: GtkCellRendererAccel</para>
<para>Flags: Read / Write</para>
<para>Allowed values: &lt;= G_MAXINT</para>
<para>Default value: 0</para>
</refsect2>
<refsect2 id="GtkCellRendererAccel--accel-mode" role="property"><title>The <literal>“accel-mode”</literal> property</title>
<indexterm zone="GtkCellRendererAccel--accel-mode"><primary>GtkCellRendererAccel:accel-mode</primary></indexterm>
<programlisting>  “accel-mode”               <link linkend="GtkCellRendererAccelMode"><type>GtkCellRendererAccelMode</type></link></programlisting>
<para>Determines if the edited accelerators are GTK+ accelerators. If
they are, consumed modifiers are suppressed, only accelerators
accepted by GTK+ are allowed, and the accelerators are rendered
in the same way as they are in menus.</para>
<para>Owner: GtkCellRendererAccel</para>
<para>Flags: Read / Write</para>
<para>Default value: GTK_CELL_RENDERER_ACCEL_MODE_GTK</para>
</refsect2>
<refsect2 id="GtkCellRendererAccel--accel-mods" role="property"><title>The <literal>“accel-mods”</literal> property</title>
<indexterm zone="GtkCellRendererAccel--accel-mods"><primary>GtkCellRendererAccel:accel-mods</primary></indexterm>
<programlisting>  “accel-mods”               <link linkend="GdkModifierType"><type>GdkModifierType</type></link></programlisting>
<para>The modifier mask of the accelerator.</para>
<para>Owner: GtkCellRendererAccel</para>
<para>Flags: Read / Write</para>
</refsect2>
<refsect2 id="GtkCellRendererAccel--keycode" role="property"><title>The <literal>“keycode”</literal> property</title>
<indexterm zone="GtkCellRendererAccel--keycode"><primary>GtkCellRendererAccel:keycode</primary></indexterm>
<programlisting>  “keycode”                  <link linkend="guint"><type>guint</type></link></programlisting>
<para>The hardware keycode of the accelerator. Note that the hardware keycode is
only relevant if the key does not have a keyval. Normally, the keyboard
configuration should assign keyvals to all keys.</para>
<para>Owner: GtkCellRendererAccel</para>
<para>Flags: Read / Write</para>
<para>Allowed values: &lt;= G_MAXINT</para>
<para>Default value: 0</para>
</refsect2>

</refsect1>
<refsect1 id="GtkCellRendererAccel.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="GtkCellRendererAccel-accel-cleared" role="signal"><title>The <literal>“accel-cleared”</literal> signal</title>
<indexterm zone="GtkCellRendererAccel-accel-cleared"><primary>GtkCellRendererAccel::accel-cleared</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
user_function (<link linkend="GtkCellRendererAccel"><type>GtkCellRendererAccel</type></link> *accel,
               <link linkend="gchar"><type>gchar</type></link>                *path_string,
               <link linkend="gpointer"><type>gpointer</type></link>              user_data)</programlisting>
<para>Gets emitted when the user has removed the accelerator.</para>
<refsect3 id="GtkCellRendererAccel-accel-cleared.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>accel</para></entry>
<entry role="parameter_description"><para>the object reveiving the signal</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>path_string</para></entry>
<entry role="parameter_description"><para>the path identifying the row of the edited cell</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-LAST:CAPS">Run Last</link></para>
</refsect2><refsect2 id="GtkCellRendererAccel-accel-edited" role="signal"><title>The <literal>“accel-edited”</literal> signal</title>
<indexterm zone="GtkCellRendererAccel-accel-edited"><primary>GtkCellRendererAccel::accel-edited</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
user_function (<link linkend="GtkCellRendererAccel"><type>GtkCellRendererAccel</type></link> *accel,
               <link linkend="gchar"><type>gchar</type></link>                *path_string,
               <link linkend="guint"><type>guint</type></link>                 accel_key,
               <link linkend="GdkModifierType"><type>GdkModifierType</type></link>       accel_mods,
               <link linkend="guint"><type>guint</type></link>                 hardware_keycode,
               <link linkend="gpointer"><type>gpointer</type></link>              user_data)</programlisting>
<para>Gets emitted when the user has selected a new accelerator.</para>
<refsect3 id="GtkCellRendererAccel-accel-edited.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>accel</para></entry>
<entry role="parameter_description"><para>the object reveiving the signal</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>path_string</para></entry>
<entry role="parameter_description"><para>the path identifying the row of the edited cell</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>accel_key</para></entry>
<entry role="parameter_description"><para>the new accelerator keyval</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>accel_mods</para></entry>
<entry role="parameter_description"><para>the new acclerator modifier mask</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>hardware_keycode</para></entry>
<entry role="parameter_description"><para>the keycode of the new accelerator</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-LAST:CAPS">Run Last</link></para>
</refsect2>
</refsect1>

</refentry>
