matrix-glib-sdk/Matrix-0.0-MatrixMessageIma...

438 lines
22 KiB
HTML
Raw Permalink 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>MatrixMessageImage: 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-MatrixEventCallAnswer.html" title="MatrixEventCallAnswer">
<link rel="next" href="Matrix-0.0-MatrixEventCallHangup.html" title="MatrixEventCallHangup">
<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-MatrixMessageImage.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-MatrixEventCallAnswer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="Matrix-0.0-MatrixEventCallHangup.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-MatrixMessageImage"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="Matrix-0.0-MatrixMessageImage.top_of_page"></a>MatrixMessageImage</span></h2>
<p>MatrixMessageImage — Class to hold a m.image message</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixMessageImage.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-MatrixMessageImage.html#MATRIX-MESSAGE-TYPE-IMAGE:CAPS" title="MATRIX_MESSAGE_TYPE_IMAGE">MATRIX_MESSAGE_TYPE_IMAGE</a></td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="Matrix-0.0-MatrixMessageImage.html#MatrixMessageImage" title="struct MatrixMessageImage"><span class="returnvalue">MatrixMessageImage</span></a> *
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixMessageImage.html#matrix-message-image-new" title="matrix_message_image_new ()">matrix_message_image_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixMessageImage.html#matrix-message-image-get-url" title="matrix_message_image_get_url ()">matrix_message_image_get_url</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixMessageImage.html#matrix-message-image-set-url" title="matrix_message_image_set_url ()">matrix_message_image_set_url</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixMessageImage.html#matrix-message-image-get-thumbnail-url" title="matrix_message_image_get_thumbnail_url ()">matrix_message_image_get_thumbnail_url</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixMessageImage.html#matrix-message-image-set-thumbnail-url" title="matrix_message_image_set_thumbnail_url ()">matrix_message_image_set_thumbnail_url</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="Matrix-0.0-matrix-types.html#MatrixImageInfo" title="struct MatrixImageInfo"><span class="returnvalue">MatrixImageInfo</span></a> *
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixMessageImage.html#matrix-message-image-get-info" title="matrix_message_image_get_info ()">matrix_message_image_get_info</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixMessageImage.html#matrix-message-image-set-info" title="matrix_message_image_set_info ()">matrix_message_image_set_info</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="Matrix-0.0-matrix-types.html#MatrixImageInfo" title="struct MatrixImageInfo"><span class="returnvalue">MatrixImageInfo</span></a> *
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixMessageImage.html#matrix-message-image-get-thumbnail-info" title="matrix_message_image_get_thumbnail_info ()">matrix_message_image_get_thumbnail_info</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="Matrix-0.0-MatrixMessageImage.html#matrix-message-image-set-thumbnail-info" title="matrix_message_image_set_thumbnail_info ()">matrix_message_image_set_thumbnail_info</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixMessageImage.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-MatrixMessageImage.html#MatrixMessageImage" title="struct MatrixMessageImage">MatrixMessageImage</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="Matrix-0.0-MatrixMessageImage.html#MatrixMessageImageClass" title="struct MatrixMessageImageClass">MatrixMessageImageClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixMessageImage.description"></a><h2>Description</h2>
<p>This message represents a single image and an optional thumbnail.</p>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixMessageImage.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="MATRIX-MESSAGE-TYPE-IMAGE:CAPS"></a><h3>MATRIX_MESSAGE_TYPE_IMAGE</h3>
<pre class="programlisting">#define MATRIX_MESSAGE_TYPE_IMAGE (matrix_message_image_get_type ())
</pre>
<p>The type for <a class="link" href="Matrix-0.0-MatrixMessageImage.html#MatrixMessageImage" title="struct MatrixMessageImage"><span class="type">MatrixMessageImage</span></a>.</p>
</div>
<hr>
<div class="refsect2">
<a name="matrix-message-image-new"></a><h3>matrix_message_image_new ()</h3>
<pre class="programlisting"><a class="link" href="Matrix-0.0-MatrixMessageImage.html#MatrixMessageImage" title="struct MatrixMessageImage"><span class="returnvalue">MatrixMessageImage</span></a> *
matrix_message_image_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="matrix-message-image-get-url"></a><h3>matrix_message_image_get_url ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
matrix_message_image_get_url (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixMessageImage.html#MatrixMessageImage" title="struct MatrixMessageImage"><span class="type">MatrixMessageImage</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"url"</span> property.</p>
<p>The URL to the image.</p>
<div class="refsect3">
<a name="id-1.2.30.6.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixMessageImage.html#MatrixMessageImage" title="struct MatrixMessageImage"><span class="type">MatrixMessageImage</span></a> instance to query</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.30.6.4.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"url"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-message-image-set-url"></a><h3>matrix_message_image_set_url ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_message_image_set_url (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixMessageImage.html#MatrixMessageImage" title="struct MatrixMessageImage"><span class="type">MatrixMessageImage</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>);</pre>
<p>Set the value of the <span class="type">"url"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The URL to the image.</p>
<div class="refsect3">
<a name="id-1.2.30.6.5.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixMessageImage.html#MatrixMessageImage" title="struct MatrixMessageImage"><span class="type">MatrixMessageImage</span></a> instance to modify</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>the new value of the <span class="type">"url"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-message-image-get-thumbnail-url"></a><h3>matrix_message_image_get_thumbnail_url ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
matrix_message_image_get_thumbnail_url
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixMessageImage.html#MatrixMessageImage" title="struct MatrixMessageImage"><span class="type">MatrixMessageImage</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"thumbnail-url"</span> property.</p>
<p>The URL to the thumbnail of the image.</p>
<div class="refsect3">
<a name="id-1.2.30.6.6.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixMessageImage.html#MatrixMessageImage" title="struct MatrixMessageImage"><span class="type">MatrixMessageImage</span></a> instance to query</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.30.6.6.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"thumbnail-url"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-message-image-set-thumbnail-url"></a><h3>matrix_message_image_set_thumbnail_url ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_message_image_set_thumbnail_url
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixMessageImage.html#MatrixMessageImage" title="struct MatrixMessageImage"><span class="type">MatrixMessageImage</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>);</pre>
<p>Set the value of the <span class="type">"thumbnail-url"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>The URL to the thumbnail of the image.</p>
<div class="refsect3">
<a name="id-1.2.30.6.7.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixMessageImage.html#MatrixMessageImage" title="struct MatrixMessageImage"><span class="type">MatrixMessageImage</span></a> instance to modify</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>the new value of the <span class="type">"thumbnail-url"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-message-image-get-info"></a><h3>matrix_message_image_get_info ()</h3>
<pre class="programlisting"><a class="link" href="Matrix-0.0-matrix-types.html#MatrixImageInfo" title="struct MatrixImageInfo"><span class="returnvalue">MatrixImageInfo</span></a> *
matrix_message_image_get_info (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixMessageImage.html#MatrixMessageImage" title="struct MatrixMessageImage"><span class="type">MatrixMessageImage</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"info"</span> property.</p>
<p>Metadata about the image referred to in <code class="literal">url</code>.</p>
<div class="refsect3">
<a name="id-1.2.30.6.8.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixMessageImage.html#MatrixMessageImage" title="struct MatrixMessageImage"><span class="type">MatrixMessageImage</span></a> instance to query</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.30.6.8.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"info"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-message-image-set-info"></a><h3>matrix_message_image_set_info ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_message_image_set_info (<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixMessageImage.html#MatrixMessageImage" title="struct MatrixMessageImage"><span class="type">MatrixMessageImage</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="Matrix-0.0-matrix-types.html#MatrixImageInfo" title="struct MatrixImageInfo"><span class="type">MatrixImageInfo</span></a> *value</code></em>);</pre>
<p>Set the value of the <span class="type">"info"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>Metadata about the image referred to in <code class="literal">url</code>.</p>
<div class="refsect3">
<a name="id-1.2.30.6.9.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixMessageImage.html#MatrixMessageImage" title="struct MatrixMessageImage"><span class="type">MatrixMessageImage</span></a> instance to modify</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>the new value of the <span class="type">"info"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-message-image-get-thumbnail-info"></a><h3>matrix_message_image_get_thumbnail_info ()</h3>
<pre class="programlisting"><a class="link" href="Matrix-0.0-matrix-types.html#MatrixImageInfo" title="struct MatrixImageInfo"><span class="returnvalue">MatrixImageInfo</span></a> *
matrix_message_image_get_thumbnail_info
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixMessageImage.html#MatrixMessageImage" title="struct MatrixMessageImage"><span class="type">MatrixMessageImage</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <span class="type">"thumbnail-info"</span> property.</p>
<p>Metadata about the image referred to in <code class="literal">thumbnail_url</code>.</p>
<div class="refsect3">
<a name="id-1.2.30.6.10.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixMessageImage.html#MatrixMessageImage" title="struct MatrixMessageImage"><span class="type">MatrixMessageImage</span></a> instance to query</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.30.6.10.7"></a><h4>Returns</h4>
<p> the value of the <span class="type">"thumbnail-info"</span> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="matrix-message-image-set-thumbnail-info"></a><h3>matrix_message_image_set_thumbnail_info ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
matrix_message_image_set_thumbnail_info
(<em class="parameter"><code><a class="link" href="Matrix-0.0-MatrixMessageImage.html#MatrixMessageImage" title="struct MatrixMessageImage"><span class="type">MatrixMessageImage</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="Matrix-0.0-matrix-types.html#MatrixImageInfo" title="struct MatrixImageInfo"><span class="type">MatrixImageInfo</span></a> *value</code></em>);</pre>
<p>Set the value of the <span class="type">"thumbnail-info"</span> property to <em class="parameter"><code>value</code></em>
.</p>
<p>Metadata about the image referred to in <code class="literal">thumbnail_url</code>.</p>
<div class="refsect3">
<a name="id-1.2.30.6.11.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="Matrix-0.0-MatrixMessageImage.html#MatrixMessageImage" title="struct MatrixMessageImage"><span class="type">MatrixMessageImage</span></a> instance to modify</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>the new value of the <span class="type">"thumbnail-info"</span> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="Matrix-0.0-MatrixMessageImage.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="MatrixMessageImage"></a><h3>struct MatrixMessageImage</h3>
<pre class="programlisting">struct MatrixMessageImage {
MatrixMessageBase parent_instance;
MatrixMessageImagePrivate * priv;
};
</pre>
<p>Class to hold a m.image message</p>
<p>This message represents a single image and an optional thumbnail.</p>
</div>
<hr>
<div class="refsect2">
<a name="MatrixMessageImageClass"></a><h3>struct MatrixMessageImageClass</h3>
<pre class="programlisting">struct MatrixMessageImageClass {
MatrixMessageBaseClass parent_class;
};
</pre>
<p>The class structure for <a class="link" href="Matrix-0.0-MatrixMessageImage.html#MATRIX-MESSAGE-TYPE-IMAGE:CAPS" title="MATRIX_MESSAGE_TYPE_IMAGE"><code class="literal">MATRIX_MESSAGE_TYPE_IMAGE</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.30.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="MatrixMessageImageClass.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>