<?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="GtkATContext">
<refmeta>
<refentrytitle role="top_of_page" id="GtkATContext.top_of_page">GtkATContext</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK4 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkATContext</refname>
<refpurpose>An object communicating to Assistive Technologies</refpurpose>
</refnamediv>

<refsect1 id="GtkATContext.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="GtkAccessible"><returnvalue>GtkAccessible</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-at-context-get-accessible">gtk_at_context_get_accessible</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GtkAccessibleRole"><returnvalue>GtkAccessibleRole</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-at-context-get-accessible-role">gtk_at_context_get_accessible_role</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

<row><entry role="function_type"><link linkend="GtkATContext"><returnvalue>GtkATContext</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-at-context-create">gtk_at_context_create</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

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

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkATContext.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="GtkATContext-state-change">state-change</link></entry><entry role="signal_flags"><link linkend="G-SIGNAL-RUN-FIRST:CAPS">Run First</link></entry></row>

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

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkATContext.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> GtkATContext
</screen>
</refsect1>

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

<refsect1 id="GtkATContext.description" role="desc">
<title role="desc.title">Description</title>
<para>GtkATContext is an abstract class provided by GTK to communicate to
platform-specific assistive technologies API.</para>
<para>Each platform supported by GTK implements a <link linkend="GtkATContext"><type>GtkATContext</type></link> subclass, and
is responsible for updating the accessible state in response to state
changes in <link linkend="GtkAccessible"><type>GtkAccessible</type></link>.</para>

</refsect1>
<refsect1 id="GtkATContext.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="gtk-at-context-get-accessible" role="function">
<title>gtk_at_context_get_accessible&#160;()</title>
<indexterm zone="gtk-at-context-get-accessible"><primary>gtk_at_context_get_accessible</primary></indexterm>
<programlisting language="C"><link linkend="GtkAccessible"><returnvalue>GtkAccessible</returnvalue></link>&#160;*
gtk_at_context_get_accessible (<parameter><link linkend="GtkATContext"><type>GtkATContext</type></link> *self</parameter>);</programlisting>
<para>Retrieves the <link linkend="GtkAccessible"><type>GtkAccessible</type></link> using this context.</para>
<refsect3 id="gtk-at-context-get-accessible.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>self</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkATContext"><type>GtkATContext</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-at-context-get-accessible.returns" role="returns">
<title>Returns</title>
<para>a <link linkend="GtkAccessible"><type>GtkAccessible</type></link>. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-at-context-get-accessible-role" role="function">
<title>gtk_at_context_get_accessible_role&#160;()</title>
<indexterm zone="gtk-at-context-get-accessible-role"><primary>gtk_at_context_get_accessible_role</primary></indexterm>
<programlisting language="C"><link linkend="GtkAccessibleRole"><returnvalue>GtkAccessibleRole</returnvalue></link>
gtk_at_context_get_accessible_role (<parameter><link linkend="GtkATContext"><type>GtkATContext</type></link> *self</parameter>);</programlisting>
<para>Retrieves the accessible role of this context.</para>
<refsect3 id="gtk-at-context-get-accessible-role.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>self</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkATContext"><type>GtkATContext</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-at-context-get-accessible-role.returns" role="returns">
<title>Returns</title>
<para> a <link linkend="GtkAccessibleRole"><type>GtkAccessibleRole</type></link></para>
</refsect3></refsect2>
<refsect2 id="gtk-at-context-create" role="function">
<title>gtk_at_context_create&#160;()</title>
<indexterm zone="gtk-at-context-create"><primary>gtk_at_context_create</primary></indexterm>
<programlisting language="C"><link linkend="GtkATContext"><returnvalue>GtkATContext</returnvalue></link>&#160;*
gtk_at_context_create (<parameter><link linkend="GtkAccessibleRole"><type>GtkAccessibleRole</type></link> accessible_role</parameter>,
                       <parameter><link linkend="GtkAccessible"><type>GtkAccessible</type></link> *accessible</parameter>);</programlisting>
<para>Creates a new <link linkend="GtkATContext"><type>GtkATContext</type></link> instance for the given accessible role and
accessible instance.</para>
<para>The <link linkend="GtkATContext"><type>GtkATContext</type></link> implementation being instantiated will depend on the
platform.</para>

<para><emphasis role="annotation">[<acronym>constructor</acronym>]</emphasis></para><refsect3 id="gtk-at-context-create.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_role</para></entry>
<entry role="parameter_description"><para>the accessible role used by the <link linkend="GtkATContext"><type>GtkATContext</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>accessible</para></entry>
<entry role="parameter_description"><para>the <link linkend="GtkAccessible"><type>GtkAccessible</type></link> implementation using the <link linkend="GtkATContext"><type>GtkATContext</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-at-context-create.returns" role="returns">
<title>Returns</title>
<para>the <link linkend="GtkATContext"><type>GtkATContext</type></link>. </para>
<para><emphasis role="annotation">[<acronym>nullable</acronym>][<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>

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

</refsect1>
<refsect1 id="GtkATContext.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GtkATContext--accessible" role="property"><title>The <literal>“accessible”</literal> property</title>
<indexterm zone="GtkATContext--accessible"><primary>GtkATContext:accessible</primary></indexterm>
<programlisting>  “accessible”               <link linkend="GtkAccessible"><type>GtkAccessible</type></link>&#160;*</programlisting>
<para>The <link linkend="GtkAccessible"><type>GtkAccessible</type></link> that created the <link linkend="GtkATContext"><type>GtkATContext</type></link> instance.</para>
<para>Owner: GtkATContext</para>
<para>Flags: Read / Write / Construct&#160;Only</para>
</refsect2>
<refsect2 id="GtkATContext--accessible-role" role="property"><title>The <literal>“accessible-role”</literal> property</title>
<indexterm zone="GtkATContext--accessible-role"><primary>GtkATContext:accessible-role</primary></indexterm>
<programlisting>  “accessible-role”          <link linkend="GtkAccessibleRole"><type>GtkAccessibleRole</type></link></programlisting>
<para>The accessible role used by the AT context.</para>
<para>Depending on the given role, different states and properties can be
set or retrieved.</para>
<para>Owner: GtkATContext</para>
<para>Flags: Read / Write / Construct&#160;Only</para>
<para>Default value: GTK_ACCESSIBLE_ROLE_NONE</para>
</refsect2>

</refsect1>
<refsect1 id="GtkATContext.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="GtkATContext-state-change" role="signal"><title>The <literal>“state-change”</literal> signal</title>
<indexterm zone="GtkATContext-state-change"><primary>GtkATContext::state-change</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
user_function (<link linkend="GtkATContext"><type>GtkATContext</type></link> *self,
               <link linkend="gpointer"><type>gpointer</type></link>      user_data)</programlisting>
<para>Emitted when the attributes of the accessible for the
<link linkend="GtkATContext"><type>GtkATContext</type></link> instance change.</para>
<refsect3 id="GtkATContext-state-change.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>self</para></entry>
<entry role="parameter_description"><para>the <link linkend="GtkATContext"><type>GtkATContext</type></link></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>
