Blob Blame History Raw
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GData Types: GData Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GData Reference Manual">
<link rel="up" href="ch02.html" title="Core API">
<link rel="prev" href="GDataEntry.html" title="GDataEntry">
<link rel="next" href="GDataParsable.html" title="GDataParsable">
<meta name="generator" content="GTK-Doc V1.26.1 (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="#gdata-GData-Types.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#gdata-GData-Types.object-hierarchy" class="shortcut">Object Hierarchy</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GDataEntry.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GDataParsable.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gdata-GData-Types"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gdata-GData-Types.top_of_page"></a>GData Types</span></h2>
<p>GData Types — miscellaneous data types</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gdata-GData-Types.stability-level"></a><h2>Stability Level</h2>
<acronym title="The intention of a Stable interface is to enable arbitrary third parties to
develop applications to these interfaces, release them, and have confidence that
they will run on all minor releases of the product (after the one in which the
interface was introduced, and within the same major release). Even at a major
release, incompatible changes are expected to be rare, and to have strong
justifications.
"><span class="acronym">Stable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="gdata-GData-Types.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="gdata-GData-Types.html#gdata-color-from-hexadecimal" title="gdata_color_from_hexadecimal ()">gdata_color_from_hexadecimal</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="gdata-GData-Types.html#gdata-color-to-hexadecimal" title="gdata_color_to_hexadecimal ()">gdata_color_to_hexadecimal</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<a name="GDataColor"></a><div class="refsect1">
<a name="gdata-GData-Types.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="gdata-GData-Types.html#GDataColor-struct" title="GDataColor">GDataColor</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gdata-GData-Types.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/opt/gnome/install/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a>
    <span class="lineart">╰──</span> GDataColor
</pre>
</div>
<div class="refsect1">
<a name="gdata-GData-Types.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gdata/gdata-types.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="gdata-GData-Types.description"></a><h2>Description</h2>
<p>The structures here are used haphazardly across the library, describing
various small data types.</p>
</div>
<div class="refsect1">
<a name="gdata-GData-Types.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gdata-color-from-hexadecimal"></a><h3>gdata_color_from_hexadecimal ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gdata_color_from_hexadecimal (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *hexadecimal</code></em>,
                              <em class="parameter"><code><a class="link" href="gdata-GData-Types.html#GDataColor"><span class="type">GDataColor</span></a> *color</code></em>);</pre>
<p>Parses <em class="parameter"><code>hexadecimal</code></em>
 and returns a <a class="link" href="gdata-GData-Types.html#GDataColor"><span class="type">GDataColor</span></a> describing it in <em class="parameter"><code>color</code></em>
.</p>
<p><em class="parameter"><code>hexadecimal</code></em>
 should be in the form <code class="literal">#<em class="replaceable"><code>rr</code></em><em class="replaceable"><code>gg</code></em><em class="replaceable"><code>bb</code></em></code>,
where <em class="replaceable"><code>rr</code></em> is a two-digit hexadecimal red intensity value, <em class="replaceable"><code>gg</code></em> is green
and <em class="replaceable"><code>bb</code></em> is blue. The hash is optional.</p>
<div class="refsect3">
<a name="gdata-color-from-hexadecimal.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>hexadecimal</p></td>
<td class="parameter_description"><p>a hexadecimal color string</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p>a <a class="link" href="gdata-GData-Types.html#GDataColor"><span class="type">GDataColor</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-color-from-hexadecimal.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gdata-color-to-hexadecimal"></a><h3>gdata_color_to_hexadecimal ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_color_to_hexadecimal (<em class="parameter"><code>const <a class="link" href="gdata-GData-Types.html#GDataColor"><span class="type">GDataColor</span></a> *color</code></em>);</pre>
<p>Returns a string describing <em class="parameter"><code>color</code></em>
 in hexadecimal form; in the form <code class="literal">#<em class="replaceable"><code>rr</code></em><em class="replaceable"><code>gg</code></em>
<em class="replaceable"><code>bb</code></em></code>, where <em class="replaceable"><code>rr</code></em> is a two-digit hexadecimal red intensity value,
<em class="replaceable"><code>gg</code></em> is green and <em class="replaceable"><code>bb</code></em> is blue. The hash is always present.</p>
<div class="refsect3">
<a name="gdata-color-to-hexadecimal.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>color</p></td>
<td class="parameter_description"><p>a <a class="link" href="gdata-GData-Types.html#GDataColor"><span class="type">GDataColor</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-color-to-hexadecimal.returns"></a><h4>Returns</h4>
<p> the color string; free with <a href="../glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a></p>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.3.0">0.3.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="gdata-GData-Types.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GDataColor-struct"></a><h3>GDataColor</h3>
<pre class="programlisting">typedef struct {
	guint16 red;
	guint16 green;
	guint16 blue;
} GDataColor;
</pre>
<p>Describes a color, such as used in the Google Calendar interface to
differentiate calendars.</p>
<div class="refsect3">
<a name="GDataColor.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" 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 href="../glib/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> <em class="structfield"><code><a name="GDataColor-struct.red"></a>red</code></em>;</p></td>
<td class="struct_member_description"><p>red color intensity, from 0–255</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> <em class="structfield"><code><a name="GDataColor-struct.green"></a>green</code></em>;</p></td>
<td class="struct_member_description"><p>green color intensity, from 0–255</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="../glib/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> <em class="structfield"><code><a name="GDataColor-struct.blue"></a>blue</code></em>;</p></td>
<td class="struct_member_description"><p>blue color intensity, from 0–255</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.26.1</div>
</body>
</html>