<?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="GtkAccessible">
<refmeta>
<refentrytitle role="top_of_page" id="GtkAccessible.top_of_page">GtkAccessible</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK4 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkAccessible</refname>
<refpurpose>Accessibility support for widgets</refpurpose>
</refnamediv>

<refsect1 id="GtkAccessible.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-accessible-get-widget">gtk_accessible_get_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-accessible-set-widget">gtk_accessible_set_widget</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkAccessible.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="GtkWidget"><type>GtkWidget</type></link>&#160;*</entry><entry role="property_name"><link linkend="GtkAccessible--widget">widget</link></entry><entry role="property_flags">Read / Write</entry></row>

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

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

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

<refsect1 id="GtkAccessible.description" role="desc">
<title role="desc.title">Description</title>
<para>The <link linkend="GtkAccessible"><type>GtkAccessible</type></link> class is the base class for accessible
implementations for <link linkend="GtkWidget"><type>GtkWidget</type></link> subclasses. It is a thin
wrapper around <link linkend="AtkObject"><type>AtkObject</type></link>, which adds facilities for associating
a widget with its accessible object.</para>
<para>An accessible implementation for a third-party widget should
derive from <link linkend="GtkAccessible"><type>GtkAccessible</type></link> and implement the suitable interfaces
from ATK, such as <link linkend="AtkText"><type>AtkText</type></link> or <link linkend="AtkSelection"><type>AtkSelection</type></link>. To establish
the connection between the widget class and its corresponding
acccessible implementation, override the get_accessible vfunc
in <link linkend="GtkWidgetClass"><type>GtkWidgetClass</type></link>.</para>

</refsect1>
<refsect1 id="GtkAccessible.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="gtk-accessible-get-widget" role="function">
<title>gtk_accessible_get_widget&#160;()</title>
<indexterm zone="gtk-accessible-get-widget"><primary>gtk_accessible_get_widget</primary></indexterm>
<programlisting language="C"><link linkend="GtkWidget"><returnvalue>GtkWidget</returnvalue></link>&#160;*
gtk_accessible_get_widget (<parameter><link linkend="GtkAccessible"><type>GtkAccessible</type></link> *accessible</parameter>);</programlisting>
<para>Gets the <link linkend="GtkWidget"><type>GtkWidget</type></link> corresponding to the <link linkend="GtkAccessible"><type>GtkAccessible</type></link>.
The returned widget does not have a reference added, so
you do not need to unref it.</para>
<refsect3 id="gtk-accessible-get-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>accessible</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkAccessible"><type>GtkAccessible</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-accessible-get-widget.returns" role="returns">
<title>Returns</title>
<para>pointer to the <link linkend="GtkWidget"><type>GtkWidget</type></link>
corresponding to the <link linkend="GtkAccessible"><type>GtkAccessible</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para>
<para><emphasis role="annotation">[<acronym>nullable</acronym>][<acronym>transfer none</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-accessible-set-widget" role="function">
<title>gtk_accessible_set_widget&#160;()</title>
<indexterm zone="gtk-accessible-set-widget"><primary>gtk_accessible_set_widget</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_accessible_set_widget (<parameter><link linkend="GtkAccessible"><type>GtkAccessible</type></link> *accessible</parameter>,
                           <parameter><link linkend="GtkWidget"><type>GtkWidget</type></link> *widget</parameter>);</programlisting>
<para>Sets the <link linkend="GtkWidget"><type>GtkWidget</type></link> corresponding to the <link linkend="GtkAccessible"><type>GtkAccessible</type></link>.</para>
<para><parameter>accessible</parameter>
 will not hold a reference to <parameter>widget</parameter>
.
It is the caller’s responsibility to ensure that when <parameter>widget</parameter>

is destroyed, the widget is unset by calling this function
again with <parameter>widget</parameter>
 set to <link linkend="NULL:CAPS"><literal>NULL</literal></link>.</para>
<refsect3 id="gtk-accessible-set-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>accessible</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkAccessible"><type>GtkAccessible</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>widget</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkWidget"><type>GtkWidget</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to unset. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>

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

</refsect1>
<refsect1 id="GtkAccessible.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GtkAccessible--widget" role="property"><title>The <literal>“widget”</literal> property</title>
<indexterm zone="GtkAccessible--widget"><primary>GtkAccessible:widget</primary></indexterm>
<programlisting>  “widget”                   <link linkend="GtkWidget"><type>GtkWidget</type></link>&#160;*</programlisting>
<para>The widget referenced by this accessible.</para><para>Owner: GtkAccessible</para>
<para>Flags: Read / Write</para>
</refsect2>

</refsect1>

</refentry>
