matrix-glib-sdk/Matrix-0.0-MatrixMessageEmote.html

136 lines
7.1 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MatrixMessageEmote: Matrix-0.0 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Matrix-0.0 Reference Manual">
<link rel="up" href="ch01.html" title="Matrix-0.0 API Reference">
<link rel="prev" href="Matrix-0.0-MatrixEventRoomMessage.html" title="MatrixEventRoomMessage">
<link rel="next" href="Matrix-0.0-matrix-types.html" title="matrix-types">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
<a href="#Matrix-0.0-MatrixMessageEmote.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="Matrix-0.0-MatrixEventRoomMessage.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="Matrix-0.0-matrix-types.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="Matrix-0.0-MatrixMessageEmote"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixMessageEmote.top_of_page"></a>MatrixMessageEmote</span></h2>
<p>MatrixMessageEmote — The emote message type</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixMessageEmote.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixMessageEmote.html#MATRIX-MESSAGE-TYPE-EMOTE:CAPS" title="MATRIX_MESSAGE_TYPE_EMOTE">MATRIX_MESSAGE_TYPE_EMOTE</a></td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="Matrix-0.0-MatrixMessageEmote.html#MatrixMessageEmote" title="struct MatrixMessageEmote"><span class="returnvalue">MatrixMessageEmote</span></a> *
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixMessageEmote.html#matrix-message-emote-new" title="matrix_message_emote_new ()">matrix_message_emote_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixMessageEmote.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixMessageEmote.html#MatrixMessageEmote" title="struct MatrixMessageEmote">MatrixMessageEmote</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixMessageEmote.html#MatrixMessageEmoteClass" title="struct MatrixMessageEmoteClass">MatrixMessageEmoteClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixMessageEmote.description"></a><h2>Description</h2>
<p>This message is similar to `m.text` except that the sender is 'performing' the action contained in the `body` key, similar to `/me` in IRC. This message should be prefixed by the name of the sender. This message could also be represented in a different colour to distinguish it from regular `m.text` messages.</p>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixMessageEmote.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="MATRIX-MESSAGE-TYPE-EMOTE:CAPS"></a><h3>MATRIX_MESSAGE_TYPE_EMOTE</h3>
<pre class="programlisting">#define MATRIX_MESSAGE_TYPE_EMOTE (matrix_message_emote_get_type ())
</pre>
<p>The type for <a class="link" href="Matrix-0.0-MatrixMessageEmote.html#MatrixMessageEmote" title="struct MatrixMessageEmote"><span class="type">MatrixMessageEmote</span></a>.</p>
</div>
<hr>
<div class="refsect2">
<a name="matrix-message-emote-new"></a><h3>matrix_message_emote_new ()</h3>
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixMessageEmote.html#MatrixMessageEmote" title="struct MatrixMessageEmote"><span class="returnvalue">MatrixMessageEmote</span></a> *
matrix_message_emote_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixMessageEmote.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="MatrixMessageEmote"></a><h3>struct MatrixMessageEmote</h3>
<pre class="programlisting">struct MatrixMessageEmote {
MatrixMessageBase parent_instance;
MatrixMessageEmotePrivate * priv;
};
</pre>
<p>The emote message type</p>
<p>This message is similar to `m.text` except that the sender is 'performing' the action contained in the `body` key, similar to `/me` in IRC. This message should be prefixed by the name of the sender. This message could also be represented in a different colour to distinguish it from regular `m.text` messages.</p>
</div>
<hr>
<div class="refsect2">
<a name="MatrixMessageEmoteClass"></a><h3>struct MatrixMessageEmoteClass</h3>
<pre class="programlisting">struct MatrixMessageEmoteClass {
MatrixMessageBaseClass parent_class;
};
</pre>
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixMessageEmote.html#MATRIX-MESSAGE-TYPE-EMOTE:CAPS" title="MATRIX_MESSAGE_TYPE_EMOTE"><code class="literal">MATRIX_MESSAGE_TYPE_EMOTE</code></a>. All the fields in this structure are private and should never be accessed directly.</p>
<div class="refsect3">
<a name="id-1.2.43.7.3.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><a class="link" href="Matrix-0.0-MatrixMessageBase.html#MatrixMessageBaseClass" title="struct MatrixMessageBaseClass"><span class="type">MatrixMessageBaseClass</span></a> <em class="structfield"><code><a name="MatrixMessageEmoteClass.parent-class"></a>parent_class</code></em>;</p></td>
<td class="struct_member_description"><p>the parent class structure</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>