<?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="GtkActionBar">
<refmeta>
<refentrytitle role="top_of_page" id="GtkActionBar.top_of_page">GtkActionBar</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK4 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkActionBar</refname>
<refpurpose>A full width bar for presenting contextual actions</refpurpose>
</refnamediv>

<refsect1 id="GtkActionBar.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="GtkWidget"><returnvalue>GtkWidget</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-action-bar-new">gtk_action_bar_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-action-bar-pack-start">gtk_action_bar_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-action-bar-pack-end">gtk_action_bar_pack_end</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-action-bar-remove">gtk_action_bar_remove</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GtkWidget"><returnvalue>GtkWidget</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-action-bar-get-center-widget">gtk_action_bar_get_center_widget</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-action-bar-set-center-widget">gtk_action_bar_set_center_widget</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-action-bar-get-revealed">gtk_action_bar_get_revealed</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-action-bar-set-revealed">gtk_action_bar_set_revealed</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkActionBar.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="gboolean"><type>gboolean</type></link></entry><entry role="property_name"><link linkend="GtkActionBar--revealed">revealed</link></entry><entry role="property_flags">Read / Write</entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkActionBar.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="GtkActionBar-struct">GtkActionBar</link></entry></row>

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

</refsect1>

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

<refsect1 id="GtkActionBar.description" role="desc">
<title role="desc.title">Description</title>
<para>GtkActionBar is designed to present contextual actions. It is
expected to be displayed below the content and expand horizontally
to fill the area.</para>
<para>It allows placing children at the start or the end. In addition, it
contains an internal centered box which is centered with respect to
the full width of the box, even if the children at either side take
up different amounts of space.</para>
<refsect2><title>CSS nodes</title><para>GtkActionBar has a single CSS node with name actionbar.</para>
</refsect2>

</refsect1>
<refsect1 id="GtkActionBar.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="gtk-action-bar-new" role="function">
<title>gtk_action_bar_new&#160;()</title>
<indexterm zone="gtk-action-bar-new"><primary>gtk_action_bar_new</primary></indexterm>
<programlisting language="C"><link linkend="GtkWidget"><returnvalue>GtkWidget</returnvalue></link>&#160;*
gtk_action_bar_new (<parameter><type>void</type></parameter>);</programlisting>
<para>Creates a new <link linkend="GtkActionBar"><type>GtkActionBar</type></link> widget.</para>
<refsect3 id="gtk-action-bar-new.returns" role="returns">
<title>Returns</title>
<para> a new <link linkend="GtkActionBar"><type>GtkActionBar</type></link></para>
</refsect3></refsect2>
<refsect2 id="gtk-action-bar-pack-start" role="function">
<title>gtk_action_bar_pack_start&#160;()</title>
<indexterm zone="gtk-action-bar-pack-start"><primary>gtk_action_bar_pack_start</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_action_bar_pack_start (<parameter><link linkend="GtkActionBar"><type>GtkActionBar</type></link> *action_bar</parameter>,
                           <parameter><link linkend="GtkWidget"><type>GtkWidget</type></link> *child</parameter>);</programlisting>
<para>Adds <parameter>child</parameter>
 to <parameter>action_bar</parameter>
, packed with reference to the
start of the <parameter>action_bar</parameter>
.</para>
<refsect3 id="gtk-action-bar-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>action_bar</para></entry>
<entry role="parameter_description"><para>A <link linkend="GtkActionBar"><type>GtkActionBar</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>child</para></entry>
<entry role="parameter_description"><para>the <link linkend="GtkWidget"><type>GtkWidget</type></link> to be added to <parameter>action_bar</parameter>
</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-action-bar-pack-end" role="function">
<title>gtk_action_bar_pack_end&#160;()</title>
<indexterm zone="gtk-action-bar-pack-end"><primary>gtk_action_bar_pack_end</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_action_bar_pack_end (<parameter><link linkend="GtkActionBar"><type>GtkActionBar</type></link> *action_bar</parameter>,
                         <parameter><link linkend="GtkWidget"><type>GtkWidget</type></link> *child</parameter>);</programlisting>
<para>Adds <parameter>child</parameter>
 to <parameter>action_bar</parameter>
, packed with reference to the
end of the <parameter>action_bar</parameter>
.</para>
<refsect3 id="gtk-action-bar-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>action_bar</para></entry>
<entry role="parameter_description"><para>A <link linkend="GtkActionBar"><type>GtkActionBar</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>child</para></entry>
<entry role="parameter_description"><para>the <link linkend="GtkWidget"><type>GtkWidget</type></link> to be added to <parameter>action_bar</parameter>
</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-action-bar-remove" role="function">
<title>gtk_action_bar_remove&#160;()</title>
<indexterm zone="gtk-action-bar-remove"><primary>gtk_action_bar_remove</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_action_bar_remove (<parameter><link linkend="GtkActionBar"><type>GtkActionBar</type></link> *action_bar</parameter>,
                       <parameter><link linkend="GtkWidget"><type>GtkWidget</type></link> *child</parameter>);</programlisting>
<para>Removes a child from <parameter>action_bar</parameter>
.</para>
<refsect3 id="gtk-action-bar-remove.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>action_bar</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkActionBar"><type>GtkActionBar</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>child</para></entry>
<entry role="parameter_description"><para>the <link linkend="GtkWidget"><type>GtkWidget</type></link> to be removed</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-action-bar-get-center-widget" role="function">
<title>gtk_action_bar_get_center_widget&#160;()</title>
<indexterm zone="gtk-action-bar-get-center-widget"><primary>gtk_action_bar_get_center_widget</primary></indexterm>
<programlisting language="C"><link linkend="GtkWidget"><returnvalue>GtkWidget</returnvalue></link>&#160;*
gtk_action_bar_get_center_widget (<parameter><link linkend="GtkActionBar"><type>GtkActionBar</type></link> *action_bar</parameter>);</programlisting>
<para>Retrieves the center bar widget of the bar.</para>
<refsect3 id="gtk-action-bar-get-center-widget.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>action_bar</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkActionBar"><type>GtkActionBar</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-action-bar-get-center-widget.returns" role="returns">
<title>Returns</title>
<para>the center <link linkend="GtkWidget"><type>GtkWidget</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>][<acronym>nullable</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-action-bar-set-center-widget" role="function">
<title>gtk_action_bar_set_center_widget&#160;()</title>
<indexterm zone="gtk-action-bar-set-center-widget"><primary>gtk_action_bar_set_center_widget</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_action_bar_set_center_widget (<parameter><link linkend="GtkActionBar"><type>GtkActionBar</type></link> *action_bar</parameter>,
                                  <parameter><link linkend="GtkWidget"><type>GtkWidget</type></link> *center_widget</parameter>);</programlisting>
<para>Sets the center widget for the <link linkend="GtkActionBar"><type>GtkActionBar</type></link>.</para>
<refsect3 id="gtk-action-bar-set-center-widget.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>action_bar</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkActionBar"><type>GtkActionBar</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>center_widget</para></entry>
<entry role="parameter_description"><para>a widget to use for the center. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-action-bar-get-revealed" role="function">
<title>gtk_action_bar_get_revealed&#160;()</title>
<indexterm zone="gtk-action-bar-get-revealed"><primary>gtk_action_bar_get_revealed</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_action_bar_get_revealed (<parameter><link linkend="GtkActionBar"><type>GtkActionBar</type></link> *action_bar</parameter>);</programlisting>
<para>Gets the value of the <link linkend="GtkActionBar--revealed"><type>“revealed”</type></link> property.</para>
<refsect3 id="gtk-action-bar-get-revealed.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>action_bar</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkActionBar"><type>GtkActionBar</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-action-bar-get-revealed.returns" role="returns">
<title>Returns</title>
<para> the current value of the <link linkend="GtkActionBar--revealed"><type>“revealed”</type></link> property.</para>
</refsect3></refsect2>
<refsect2 id="gtk-action-bar-set-revealed" role="function">
<title>gtk_action_bar_set_revealed&#160;()</title>
<indexterm zone="gtk-action-bar-set-revealed"><primary>gtk_action_bar_set_revealed</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_action_bar_set_revealed (<parameter><link linkend="GtkActionBar"><type>GtkActionBar</type></link> *action_bar</parameter>,
                             <parameter><link linkend="gboolean"><type>gboolean</type></link> revealed</parameter>);</programlisting>
<para>Sets the <link linkend="GtkActionBar--revealed"><type>“revealed”</type></link> property to <parameter>revealed</parameter>
. Changing this will
make <parameter>action_bar</parameter>
 reveal (<link linkend="TRUE:CAPS"><literal>TRUE</literal></link>) or conceal (<link linkend="FALSE:CAPS"><literal>FALSE</literal></link>) itself via a sliding
transition.</para>
<para>Note: this does not show or hide <parameter>action_bar</parameter>
 in the <link linkend="GtkWidget--visible"><type>“visible”</type></link> sense,
so revealing has no effect if <link linkend="GtkWidget--visible"><type>“visible”</type></link> is <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>.</para>
<refsect3 id="gtk-action-bar-set-revealed.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>action_bar</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkActionBar"><type>GtkActionBar</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>revealed</para></entry>
<entry role="parameter_description"><para>The new value of the property</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>

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

</refsect1>
<refsect1 id="GtkActionBar.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GtkActionBar--revealed" role="property"><title>The <literal>“revealed”</literal> property</title>
<indexterm zone="GtkActionBar--revealed"><primary>GtkActionBar:revealed</primary></indexterm>
<programlisting>  “revealed”                 <link linkend="gboolean"><type>gboolean</type></link></programlisting>
<para>Controls whether the action bar shows its contents or not.</para><para>Owner: GtkActionBar</para>
<para>Flags: Read / Write</para>
<para>Default value: TRUE</para>
</refsect2>

</refsect1>
<refsect1 id="GtkActionBar.see-also">
<title>See Also</title>
<para><link linkend="GtkBox"><type>GtkBox</type></link></para>

</refsect1>

</refentry>
