<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="EmpathyChat">
<refmeta>
<refentrytitle role="top_of_page" id="EmpathyChat.top_of_page">EmpathyChat</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBEMPATHY-GTK Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>EmpathyChat</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="EmpathyChat.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="EmpathyChat-struct">EmpathyChat</link>;
<link linkend="EmpathyChat">EmpathyChat</link>*        <link linkend="empathy-chat-new">empathy_chat_new</link>                    (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *tp_chat);
<link linkend="EmpathyTpChat">EmpathyTpChat</link>*      <link linkend="empathy-chat-get-tp-chat">empathy_chat_get_tp_chat</link>            (<link linkend="EmpathyChat">EmpathyChat</link> *chat);
<link linkend="void">void</link>                <link linkend="empathy-chat-set-tp-chat">empathy_chat_set_tp_chat</link>            (<link linkend="EmpathyChat">EmpathyChat</link> *chat,
                                                         <link linkend="EmpathyTpChat">EmpathyTpChat</link> *tp_chat);
<link linkend="McAccount">McAccount</link>*          <link linkend="empathy-chat-get-account">empathy_chat_get_account</link>            (<link linkend="EmpathyChat">EmpathyChat</link> *chat);
const <link linkend="gchar">gchar</link>*        <link linkend="empathy-chat-get-id">empathy_chat_get_id</link>                 (<link linkend="EmpathyChat">EmpathyChat</link> *chat);
const <link linkend="gchar">gchar</link>*        <link linkend="empathy-chat-get-name">empathy_chat_get_name</link>               (<link linkend="EmpathyChat">EmpathyChat</link> *chat);
const <link linkend="gchar">gchar</link>*        <link linkend="empathy-chat-get-subject">empathy_chat_get_subject</link>            (<link linkend="EmpathyChat">EmpathyChat</link> *chat);
<link linkend="EmpathyContact">EmpathyContact</link>*     <link linkend="empathy-chat-get-remote-contact">empathy_chat_get_remote_contact</link>     (<link linkend="EmpathyChat">EmpathyChat</link> *chat);
<link linkend="guint">guint</link>               <link linkend="empathy-chat-get-members-count">empathy_chat_get_members_count</link>      (<link linkend="EmpathyChat">EmpathyChat</link> *chat);
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="empathy-chat-get-contact-menu">empathy_chat_get_contact_menu</link>       (<link linkend="EmpathyChat">EmpathyChat</link> *chat);
<link linkend="void">void</link>                <link linkend="empathy-chat-clear">empathy_chat_clear</link>                  (<link linkend="EmpathyChat">EmpathyChat</link> *chat);
<link linkend="void">void</link>                <link linkend="empathy-chat-scroll-down">empathy_chat_scroll_down</link>            (<link linkend="EmpathyChat">EmpathyChat</link> *chat);
<link linkend="void">void</link>                <link linkend="empathy-chat-cut">empathy_chat_cut</link>                    (<link linkend="EmpathyChat">EmpathyChat</link> *chat);
<link linkend="void">void</link>                <link linkend="empathy-chat-copy">empathy_chat_copy</link>                   (<link linkend="EmpathyChat">EmpathyChat</link> *chat);
<link linkend="void">void</link>                <link linkend="empathy-chat-paste">empathy_chat_paste</link>                  (<link linkend="EmpathyChat">EmpathyChat</link> *chat);
<link linkend="void">void</link>                <link linkend="empathy-chat-correct-word">empathy_chat_correct_word</link>           (<link linkend="EmpathyChat">EmpathyChat</link> *chat,
                                                         <link linkend="GtkTextIter">GtkTextIter</link> *start,
                                                         <link linkend="GtkTextIter">GtkTextIter</link> *end,
                                                         const <link linkend="gchar">gchar</link> *new_word);
</synopsis>
</refsynopsisdiv>

<refsect1 id="EmpathyChat.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
         +----<link linkend="GtkObject">GtkObject</link>
               +----<link linkend="GtkWidget">GtkWidget</link>
                     +----<link linkend="GtkContainer">GtkContainer</link>
                           +----<link linkend="GtkBin">GtkBin</link>
                                 +----EmpathyChat
</synopsis>

</refsect1>



<refsect1 id="EmpathyChat.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
EmpathyChat implements
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>

</refsect1>


<refsect1 id="EmpathyChat.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
  &quot;<link linkend="EmpathyChat--account">account</link>&quot;                  <link linkend="McAccount">McAccount</link>*            : Read
  &quot;<link linkend="EmpathyChat--id">id</link>&quot;                       <link linkend="gchar">gchar</link>*                : Read
  &quot;<link linkend="EmpathyChat--name">name</link>&quot;                     <link linkend="gchar">gchar</link>*                : Read
  &quot;<link linkend="EmpathyChat--remote-contact">remote-contact</link>&quot;           <link linkend="EmpathyContact">EmpathyContact</link>*       : Read
  &quot;<link linkend="EmpathyChat--subject">subject</link>&quot;                  <link linkend="gchar">gchar</link>*                : Read
  &quot;<link linkend="EmpathyChat--tp-chat">tp-chat</link>&quot;                  <link linkend="EmpathyTpChat">EmpathyTpChat</link>*        : Read / Write / Construct
</synopsis>
</refsect1>

<refsect1 id="EmpathyChat.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
  &quot;<link linkend="EmpathyChat-composing">composing</link>&quot;                                      : Run Last
  &quot;<link linkend="EmpathyChat-new-message">new-message</link>&quot;                                    : Run Last
</synopsis>
</refsect1>


<refsect1 id="EmpathyChat.description" role="desc">
<title role="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 id="EmpathyChat.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="EmpathyChat-struct" role="struct">
<title>EmpathyChat</title>
<indexterm zone="EmpathyChat-struct"><primary>EmpathyChat</primary></indexterm><programlisting>typedef struct _EmpathyChat EmpathyChat;</programlisting>
<para>

</para></refsect2>
<refsect2 id="empathy-chat-new" role="function">
<title>empathy_chat_new ()</title>
<indexterm zone="empathy-chat-new"><primary>empathy_chat_new</primary></indexterm><programlisting><link linkend="EmpathyChat">EmpathyChat</link>*        empathy_chat_new                    (<link linkend="EmpathyTpChat">EmpathyTpChat</link> *tp_chat);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>tp_chat</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-chat-get-tp-chat" role="function">
<title>empathy_chat_get_tp_chat ()</title>
<indexterm zone="empathy-chat-get-tp-chat"><primary>empathy_chat_get_tp_chat</primary></indexterm><programlisting><link linkend="EmpathyTpChat">EmpathyTpChat</link>*      empathy_chat_get_tp_chat            (<link linkend="EmpathyChat">EmpathyChat</link> *chat);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>chat</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-chat-set-tp-chat" role="function">
<title>empathy_chat_set_tp_chat ()</title>
<indexterm zone="empathy-chat-set-tp-chat"><primary>empathy_chat_set_tp_chat</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_chat_set_tp_chat            (<link linkend="EmpathyChat">EmpathyChat</link> *chat,
                                                         <link linkend="EmpathyTpChat">EmpathyTpChat</link> *tp_chat);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>chat</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tp_chat</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-chat-get-account" role="function">
<title>empathy_chat_get_account ()</title>
<indexterm zone="empathy-chat-get-account"><primary>empathy_chat_get_account</primary></indexterm><programlisting><link linkend="McAccount">McAccount</link>*          empathy_chat_get_account            (<link linkend="EmpathyChat">EmpathyChat</link> *chat);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>chat</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-chat-get-id" role="function">
<title>empathy_chat_get_id ()</title>
<indexterm zone="empathy-chat-get-id"><primary>empathy_chat_get_id</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        empathy_chat_get_id                 (<link linkend="EmpathyChat">EmpathyChat</link> *chat);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>chat</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-chat-get-name" role="function">
<title>empathy_chat_get_name ()</title>
<indexterm zone="empathy-chat-get-name"><primary>empathy_chat_get_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        empathy_chat_get_name               (<link linkend="EmpathyChat">EmpathyChat</link> *chat);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>chat</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-chat-get-subject" role="function">
<title>empathy_chat_get_subject ()</title>
<indexterm zone="empathy-chat-get-subject"><primary>empathy_chat_get_subject</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        empathy_chat_get_subject            (<link linkend="EmpathyChat">EmpathyChat</link> *chat);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>chat</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-chat-get-remote-contact" role="function">
<title>empathy_chat_get_remote_contact ()</title>
<indexterm zone="empathy-chat-get-remote-contact"><primary>empathy_chat_get_remote_contact</primary></indexterm><programlisting><link linkend="EmpathyContact">EmpathyContact</link>*     empathy_chat_get_remote_contact     (<link linkend="EmpathyChat">EmpathyChat</link> *chat);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>chat</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-chat-get-members-count" role="function">
<title>empathy_chat_get_members_count ()</title>
<indexterm zone="empathy-chat-get-members-count"><primary>empathy_chat_get_members_count</primary></indexterm><programlisting><link linkend="guint">guint</link>               empathy_chat_get_members_count      (<link linkend="EmpathyChat">EmpathyChat</link> *chat);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>chat</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-chat-get-contact-menu" role="function">
<title>empathy_chat_get_contact_menu ()</title>
<indexterm zone="empathy-chat-get-contact-menu"><primary>empathy_chat_get_contact_menu</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          empathy_chat_get_contact_menu       (<link linkend="EmpathyChat">EmpathyChat</link> *chat);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>chat</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-chat-clear" role="function">
<title>empathy_chat_clear ()</title>
<indexterm zone="empathy-chat-clear"><primary>empathy_chat_clear</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_chat_clear                  (<link linkend="EmpathyChat">EmpathyChat</link> *chat);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>chat</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-chat-scroll-down" role="function">
<title>empathy_chat_scroll_down ()</title>
<indexterm zone="empathy-chat-scroll-down"><primary>empathy_chat_scroll_down</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_chat_scroll_down            (<link linkend="EmpathyChat">EmpathyChat</link> *chat);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>chat</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-chat-cut" role="function">
<title>empathy_chat_cut ()</title>
<indexterm zone="empathy-chat-cut"><primary>empathy_chat_cut</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_chat_cut                    (<link linkend="EmpathyChat">EmpathyChat</link> *chat);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>chat</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-chat-copy" role="function">
<title>empathy_chat_copy ()</title>
<indexterm zone="empathy-chat-copy"><primary>empathy_chat_copy</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_chat_copy                   (<link linkend="EmpathyChat">EmpathyChat</link> *chat);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>chat</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-chat-paste" role="function">
<title>empathy_chat_paste ()</title>
<indexterm zone="empathy-chat-paste"><primary>empathy_chat_paste</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_chat_paste                  (<link linkend="EmpathyChat">EmpathyChat</link> *chat);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>chat</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="empathy-chat-correct-word" role="function">
<title>empathy_chat_correct_word ()</title>
<indexterm zone="empathy-chat-correct-word"><primary>empathy_chat_correct_word</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_chat_correct_word           (<link linkend="EmpathyChat">EmpathyChat</link> *chat,
                                                         <link linkend="GtkTextIter">GtkTextIter</link> *start,
                                                         <link linkend="GtkTextIter">GtkTextIter</link> *end,
                                                         const <link linkend="gchar">gchar</link> *new_word);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>chat</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>start</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>end</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_word</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 id="EmpathyChat.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="EmpathyChat--account"><title>The <literal>&quot;account&quot;</literal> property</title>
<indexterm zone="EmpathyChat--account"><primary>EmpathyChat:account</primary></indexterm><programlisting>  &quot;account&quot;                  <link linkend="McAccount">McAccount</link>*            : Read</programlisting>
<para>The account of the chat.</para></refsect2>
<refsect2 id="EmpathyChat--id"><title>The <literal>&quot;id&quot;</literal> property</title>
<indexterm zone="EmpathyChat--id"><primary>EmpathyChat:id</primary></indexterm><programlisting>  &quot;id&quot;                       <link linkend="gchar">gchar</link>*                : Read</programlisting>
<para>The id of the chat.</para><para>Default value: NULL</para>
</refsect2>
<refsect2 id="EmpathyChat--name"><title>The <literal>&quot;name&quot;</literal> property</title>
<indexterm zone="EmpathyChat--name"><primary>EmpathyChat:name</primary></indexterm><programlisting>  &quot;name&quot;                     <link linkend="gchar">gchar</link>*                : Read</programlisting>
<para>The name of the chat.</para><para>Default value: NULL</para>
</refsect2>
<refsect2 id="EmpathyChat--remote-contact"><title>The <literal>&quot;remote-contact&quot;</literal> property</title>
<indexterm zone="EmpathyChat--remote-contact"><primary>EmpathyChat:remote-contact</primary></indexterm><programlisting>  &quot;remote-contact&quot;           <link linkend="EmpathyContact">EmpathyContact</link>*       : Read</programlisting>
<para>The remote contact is any.</para></refsect2>
<refsect2 id="EmpathyChat--subject"><title>The <literal>&quot;subject&quot;</literal> property</title>
<indexterm zone="EmpathyChat--subject"><primary>EmpathyChat:subject</primary></indexterm><programlisting>  &quot;subject&quot;                  <link linkend="gchar">gchar</link>*                : Read</programlisting>
<para>The subject or topic of the chat.</para><para>Default value: NULL</para>
</refsect2>
<refsect2 id="EmpathyChat--tp-chat"><title>The <literal>&quot;tp-chat&quot;</literal> property</title>
<indexterm zone="EmpathyChat--tp-chat"><primary>EmpathyChat:tp-chat</primary></indexterm><programlisting>  &quot;tp-chat&quot;                  <link linkend="EmpathyTpChat">EmpathyTpChat</link>*        : Read / Write / Construct</programlisting>
<para>The tp chat object.</para></refsect2>

</refsect1>

<refsect1 id="EmpathyChat.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="EmpathyChat-composing"><title>The <literal>&quot;composing&quot;</literal> signal</title>
<indexterm zone="EmpathyChat-composing"><primary>EmpathyChat::composing</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EmpathyChat">EmpathyChat</link> *empathychat,
                                                        <link linkend="gboolean">gboolean</link>     arg1,
                                                        <link linkend="gpointer">gpointer</link>     user_data)        : Run Last</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>empathychat</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
<listitem><simpara>

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="EmpathyChat-new-message"><title>The <literal>&quot;new-message&quot;</literal> signal</title>
<indexterm zone="EmpathyChat-new-message"><primary>EmpathyChat::new-message</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EmpathyChat">EmpathyChat</link>    *empathychat,
                                                        <link linkend="EmpathyMessage">EmpathyMessage</link> *arg1,
                                                        <link linkend="gpointer">gpointer</link>        user_data)        : Run Last</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>empathychat</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
<listitem><simpara>

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>



</refentry>
