<?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 % gtkdocentities SYSTEM "../xml/gtkdocentities.ent">
  %gtkdocentities;
]>
<refentry id="AtkPlug">
<refmeta>
<refentrytitle role="top_of_page" id="AtkPlug.top_of_page">AtkPlug</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>ATK Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>AtkPlug</refname>
<refpurpose>Toplevel for embedding into other processes</refpurpose>
</refnamediv>

<refsect1 id="AtkPlug.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="AtkObject"><returnvalue>AtkObject</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="atk-plug-new">atk_plug_new</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="atk-plug-get-id">atk_plug_get_id</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

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

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AtkPlug.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> AtkPlug
</screen>
</refsect1>
<refsect1 id="AtkPlug.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
AtkPlug implements
 <link linkend="AtkComponent">AtkComponent</link>.</para>

</refsect1>


<refsect1 id="AtkPlug.description" role="desc">
<title role="desc.title">Description</title>
<para>See <link linkend="AtkSocket"><type>AtkSocket</type></link></para>

</refsect1>
<refsect1 id="AtkPlug.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="atk-plug-new" role="function">
<title>atk_plug_new&#160;()</title>
<indexterm zone="atk-plug-new"><primary>atk_plug_new</primary></indexterm>
<programlisting language="C"><link linkend="AtkObject"><returnvalue>AtkObject</returnvalue></link>&#160;*
atk_plug_new (<parameter><type>void</type></parameter>);</programlisting>
</refsect2>
<refsect2 id="atk-plug-get-id" role="function" condition="since:1.30">
<title>atk_plug_get_id&#160;()</title>
<indexterm zone="atk-plug-get-id" role="1.30"><primary>atk_plug_get_id</primary></indexterm>
<programlisting language="C"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
atk_plug_get_id (<parameter><link linkend="AtkPlug"><type>AtkPlug</type></link> *plug</parameter>);</programlisting>
<para>Gets the unique ID of an <link linkend="AtkPlug"><type>AtkPlug</type></link> object, which can be used to
embed inside of an <link linkend="AtkSocket"><type>AtkSocket</type></link> using <link linkend="atk-socket-embed"><function>atk_socket_embed()</function></link>.</para>
<para>Internally, this calls a class function that should be registered
by the IPC layer (usually at-spi2-atk). The implementor of an
<link linkend="AtkPlug"><type>AtkPlug</type></link> object should call this function (after atk-bridge is
loaded) and pass the value to the process implementing the
<link linkend="AtkSocket"><type>AtkSocket</type></link>, so it could embed the plug.</para>
<refsect3 id="atk-plug-get-id.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>plug</para></entry>
<entry role="parameter_description"><para>an <link linkend="AtkPlug"><type>AtkPlug</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-plug-get-id.returns" role="returns">
<title>Returns</title>
<para> the unique ID for the plug</para>
</refsect3><para role="since">Since: <link linkend="api-index-1.30">1.30</link></para></refsect2>

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

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

</refsect1>

</refentry>
