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>GDataGContactLanguage: 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="ch10.html" title="GContact API">
<link rel="prev" href="GDataGContactJot.html" title="GDataGContactJot">
<link rel="next" href="GDataGContactRelation.html" title="GDataGContactRelation">
<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="#GDataGContactLanguage.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GDataGContactLanguage.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GDataGContactLanguage.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GDataGContactLanguage.properties" class="shortcut">Properties</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="ch10.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GDataGContactJot.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GDataGContactRelation.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GDataGContactLanguage"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GDataGContactLanguage.top_of_page"></a>GDataGContactLanguage</span></h2>
<p>GDataGContactLanguage — gContact language element</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GDataGContactLanguage.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="GDataGContactLanguage.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 class="link" href="GDataGContactLanguage.html" title="GDataGContactLanguage"><span class="returnvalue">GDataGContactLanguage</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataGContactLanguage.html#gdata-gcontact-language-new" title="gdata_gcontact_language_new ()">gdata_gcontact_language_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataGContactLanguage.html#gdata-gcontact-language-get-code" title="gdata_gcontact_language_get_code ()">gdata_gcontact_language_get_code</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="GDataGContactLanguage.html#gdata-gcontact-language-set-code" title="gdata_gcontact_language_set_code ()">gdata_gcontact_language_set_code</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataGContactLanguage.html#gdata-gcontact-language-get-label" title="gdata_gcontact_language_get_label ()">gdata_gcontact_language_get_label</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="GDataGContactLanguage.html#gdata-gcontact-language-set-label" title="gdata_gcontact_language_set_label ()">gdata_gcontact_language_set_label</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataGContactLanguage.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GDataGContactLanguage.html#GDataGContactLanguage--code" title="The “code” property">code</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GDataGContactLanguage.html#GDataGContactLanguage--label" title="The “label” property">label</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataGContactLanguage.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="GDataGContactLanguage.html#GDataGContactLanguage-struct" title="GDataGContactLanguage">GDataGContactLanguage</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataGContactLanguage.html#GDataGContactLanguageClass" title="GDataGContactLanguageClass">GDataGContactLanguageClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataGContactLanguage.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a class="link" href="GDataParsable.html" title="GDataParsable">GDataParsable</a>
        <span class="lineart">╰──</span> GDataGContactLanguage
</pre>
</div>
<div class="refsect1">
<a name="GDataGContactLanguage.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GDataGContactLanguage implements
 <a class="link" href="GDataComparable.html" title="GDataComparable">GDataComparable</a>.</p>
</div>
<div class="refsect1">
<a name="GDataGContactLanguage.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gdata/gcontact/gdata-gcontact-language.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GDataGContactLanguage.description"></a><h2>Description</h2>
<p><a class="link" href="GDataGContactLanguage.html" title="GDataGContactLanguage"><span class="type">GDataGContactLanguage</span></a> represents a "language" element from the</p>
<a class="ulink" href="http://code.google.com/apis/contacts/docs/3.0/reference.html#gcLanguage" target="_top">gContact specification</a>.

</div>
<div class="refsect1">
<a name="GDataGContactLanguage.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gdata-gcontact-language-new"></a><h3>gdata_gcontact_language_new ()</h3>
<pre class="programlisting"><a class="link" href="GDataGContactLanguage.html" title="GDataGContactLanguage"><span class="returnvalue">GDataGContactLanguage</span></a> *
gdata_gcontact_language_new (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *code</code></em>,
                             <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>);</pre>
<p>Creates a new <a class="link" href="GDataGContactLanguage.html" title="GDataGContactLanguage"><span class="type">GDataGContactLanguage</span></a>. More information is available in the <a class="ulink" href="http://code.google.com/apis/contacts/docs/3.0/reference.html#gcLanguage" target="_top">gContact specification</a>.</p>
<p>Exactly one of <em class="parameter"><code>code</code></em>
 and <em class="parameter"><code>label</code></em>
 should be provided; the other must be <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<div class="refsect3">
<a name="gdata-gcontact-language-new.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>code</p></td>
<td class="parameter_description"><p>the language code, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>label</p></td>
<td class="parameter_description"><p>a free-form label for the language, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-gcontact-language-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GDataGContactLanguage.html" title="GDataGContactLanguage"><span class="type">GDataGContactLanguage</span></a>; unref with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a></p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-gcontact-language-get-code"></a><h3>gdata_gcontact_language_get_code ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_gcontact_language_get_code (<em class="parameter"><code><a class="link" href="GDataGContactLanguage.html" title="GDataGContactLanguage"><span class="type">GDataGContactLanguage</span></a> *self</code></em>);</pre>
<p>Gets the <a class="link" href="GDataGContactLanguage.html#GDataGContactLanguage--code" title="The “code” property"><span class="type">“code”</span></a> property.</p>
<div class="refsect3">
<a name="gdata-gcontact-language-get-code.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>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataGContactLanguage.html" title="GDataGContactLanguage"><span class="type">GDataGContactLanguage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-gcontact-language-get-code.returns"></a><h4>Returns</h4>
<p> the language's code, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-gcontact-language-set-code"></a><h3>gdata_gcontact_language_set_code ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdata_gcontact_language_set_code (<em class="parameter"><code><a class="link" href="GDataGContactLanguage.html" title="GDataGContactLanguage"><span class="type">GDataGContactLanguage</span></a> *self</code></em>,
                                  <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *code</code></em>);</pre>
<p>Sets the <a class="link" href="GDataGContactLanguage.html#GDataGContactLanguage--code" title="The “code” property"><span class="type">“code”</span></a> property to <em class="parameter"><code>code</code></em>
.</p>
<p>If <em class="parameter"><code>code</code></em>
 is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the code will be unset. When the <a class="link" href="GDataGContactLanguage.html" title="GDataGContactLanguage"><span class="type">GDataGContactLanguage</span></a> is used in a query, however,
exactly one of <a class="link" href="GDataGContactLanguage.html#GDataGContactLanguage--code" title="The “code” property"><span class="type">“code”</span></a> and <a class="link" href="GDataGContactLanguage.html#GDataGContactLanguage--label" title="The “label” property"><span class="type">“label”</span></a> must be <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<div class="refsect3">
<a name="gdata-gcontact-language-set-code.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>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataGContactLanguage.html" title="GDataGContactLanguage"><span class="type">GDataGContactLanguage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>code</p></td>
<td class="parameter_description"><p>the new code for the language, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-gcontact-language-get-label"></a><h3>gdata_gcontact_language_get_label ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_gcontact_language_get_label (<em class="parameter"><code><a class="link" href="GDataGContactLanguage.html" title="GDataGContactLanguage"><span class="type">GDataGContactLanguage</span></a> *self</code></em>);</pre>
<p>Gets the <a class="link" href="GDataGContactLanguage.html#GDataGContactLanguage--label" title="The “label” property"><span class="type">“label”</span></a> property.</p>
<div class="refsect3">
<a name="gdata-gcontact-language-get-label.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>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataGContactLanguage.html" title="GDataGContactLanguage"><span class="type">GDataGContactLanguage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-gcontact-language-get-label.returns"></a><h4>Returns</h4>
<p> a free-form label for the language, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-gcontact-language-set-label"></a><h3>gdata_gcontact_language_set_label ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdata_gcontact_language_set_label (<em class="parameter"><code><a class="link" href="GDataGContactLanguage.html" title="GDataGContactLanguage"><span class="type">GDataGContactLanguage</span></a> *self</code></em>,
                                   <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>);</pre>
<p>Sets the <a class="link" href="GDataGContactLanguage.html#GDataGContactLanguage--label" title="The “label” property"><span class="type">“label”</span></a> property to <em class="parameter"><code>label</code></em>
.</p>
<p>If <em class="parameter"><code>label</code></em>
 is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the label will be unset. When the <a class="link" href="GDataGContactLanguage.html" title="GDataGContactLanguage"><span class="type">GDataGContactLanguage</span></a> is used in a query, however,
exactly one of <a class="link" href="GDataGContactLanguage.html#GDataGContactLanguage--code" title="The “code” property"><span class="type">“code”</span></a> and <a class="link" href="GDataGContactLanguage.html#GDataGContactLanguage--label" title="The “label” property"><span class="type">“label”</span></a> must be <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<div class="refsect3">
<a name="gdata-gcontact-language-set-label.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>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataGContactLanguage.html" title="GDataGContactLanguage"><span class="type">GDataGContactLanguage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>label</p></td>
<td class="parameter_description"><p>the new free-form label for the language, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="GDataGContactLanguage.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GDataGContactLanguage-struct"></a><h3>GDataGContactLanguage</h3>
<pre class="programlisting">typedef struct _GDataGContactLanguage GDataGContactLanguage;</pre>
<p>All the fields in the <a class="link" href="GDataGContactLanguage.html" title="GDataGContactLanguage"><span class="type">GDataGContactLanguage</span></a> structure are private and should never be accessed directly.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataGContactLanguageClass"></a><h3>GDataGContactLanguageClass</h3>
<pre class="programlisting">typedef struct {
} GDataGContactLanguageClass;
</pre>
<p>All the fields in the <a class="link" href="GDataGContactLanguage.html#GDataGContactLanguageClass" title="GDataGContactLanguageClass"><span class="type">GDataGContactLanguageClass</span></a> structure are private and should never be accessed directly.</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="GDataGContactLanguage.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GDataGContactLanguage--code"></a><h3>The <code class="literal">“code”</code> property</h3>
<pre class="programlisting">  “code”                     <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>A code identifying the language, conforming to the IETF BCP 47 specification. It is mutually exclusive with <a class="link" href="GDataGContactLanguage.html#GDataGContactLanguage--label" title="The “label” property"><span class="type">“label”</span></a>.</p>
<p>For more information, see the</p>
<a class="ulink" href="http://code.google.com/apis/contacts/docs/3.0/reference.html#gcLanguage" target="_top">gContact specification</a>.
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataGContactLanguage--label"></a><h3>The <code class="literal">“label”</code> property</h3>
<pre class="programlisting">  “label”                    <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>A free-form string that identifies the language. It is mutually exclusive with <a class="link" href="GDataGContactLanguage.html#GDataGContactLanguage--code" title="The “code” property"><span class="type">“code”</span></a>.</p>
<p>For more information, see the</p>
<a class="ulink" href="http://code.google.com/apis/contacts/docs/3.0/reference.html#gcLanguage" target="_top">gContact specification</a>.
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.26.1</div>
</body>
</html>