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>GDataDocumentsText: 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="ch16.html" title="Google Documents/Drive API">
<link rel="prev" href="GDataDocumentsSpreadsheet.html" title="GDataDocumentsSpreadsheet">
<link rel="next" href="GDataDocumentsMetadata.html" title="GDataDocumentsMetadata">
<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="#GDataDocumentsText.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GDataDocumentsText.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GDataDocumentsText.implemented-interfaces" class="shortcut">Implemented Interfaces</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="ch16.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GDataDocumentsSpreadsheet.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GDataDocumentsMetadata.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GDataDocumentsText"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GDataDocumentsText.top_of_page"></a>GDataDocumentsText</span></h2>
<p>GDataDocumentsText — GData Documents text object</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GDataDocumentsText.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="GDataDocumentsText.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="GDataDocumentsText.html" title="GDataDocumentsText"><span class="returnvalue">GDataDocumentsText</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataDocumentsText.html#gdata-documents-text-new" title="gdata_documents_text_new ()">gdata_documents_text_new</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataDocumentsText.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="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataDocumentsText.html#GDATA-DOCUMENTS-TEXT-DOC:CAPS" title="GDATA_DOCUMENTS_TEXT_DOC">GDATA_DOCUMENTS_TEXT_DOC</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataDocumentsText.html#GDATA-DOCUMENTS-TEXT-HTML:CAPS" title="GDATA_DOCUMENTS_TEXT_HTML">GDATA_DOCUMENTS_TEXT_HTML</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataDocumentsText.html#GDATA-DOCUMENTS-TEXT-JPEG:CAPS" title="GDATA_DOCUMENTS_TEXT_JPEG">GDATA_DOCUMENTS_TEXT_JPEG</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataDocumentsText.html#GDATA-DOCUMENTS-TEXT-ODT:CAPS" title="GDATA_DOCUMENTS_TEXT_ODT">GDATA_DOCUMENTS_TEXT_ODT</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataDocumentsText.html#GDATA-DOCUMENTS-TEXT-PDF:CAPS" title="GDATA_DOCUMENTS_TEXT_PDF">GDATA_DOCUMENTS_TEXT_PDF</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataDocumentsText.html#GDATA-DOCUMENTS-TEXT-PNG:CAPS" title="GDATA_DOCUMENTS_TEXT_PNG">GDATA_DOCUMENTS_TEXT_PNG</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataDocumentsText.html#GDATA-DOCUMENTS-TEXT-RTF:CAPS" title="GDATA_DOCUMENTS_TEXT_RTF">GDATA_DOCUMENTS_TEXT_RTF</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataDocumentsText.html#GDATA-DOCUMENTS-TEXT-TXT:CAPS" title="GDATA_DOCUMENTS_TEXT_TXT">GDATA_DOCUMENTS_TEXT_TXT</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GDataDocumentsText.html#GDATA-DOCUMENTS-TEXT-ZIP:CAPS" title="GDATA_DOCUMENTS_TEXT_ZIP">GDATA_DOCUMENTS_TEXT_ZIP</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataDocumentsText.html#GDataDocumentsText-struct" title="GDataDocumentsText">GDataDocumentsText</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataDocumentsText.html#GDataDocumentsTextClass" title="GDataDocumentsTextClass">GDataDocumentsTextClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataDocumentsText.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> <a class="link" href="GDataEntry.html" title="GDataEntry">GDataEntry</a>
            <span class="lineart">╰──</span> <a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry">GDataDocumentsEntry</a>
                <span class="lineart">╰──</span> <a class="link" href="GDataDocumentsDocument.html" title="GDataDocumentsDocument">GDataDocumentsDocument</a>
                    <span class="lineart">╰──</span> GDataDocumentsText
</pre>
</div>
<div class="refsect1">
<a name="GDataDocumentsText.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GDataDocumentsText implements
 <a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler">GDataAccessHandler</a>.</p>
</div>
<div class="refsect1">
<a name="GDataDocumentsText.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gdata/services/documents/gdata-documents-text.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GDataDocumentsText.description"></a><h2>Description</h2>
<p><a class="link" href="GDataDocumentsText.html" title="GDataDocumentsText"><span class="type">GDataDocumentsText</span></a> is a subclass of <a class="link" href="GDataDocumentsDocument.html" title="GDataDocumentsDocument"><span class="type">GDataDocumentsDocument</span></a> to represent a text document from Google Documents.</p>
<p>For more details of Google Drive's GData API, see the</p>
<a class="ulink" href="https://developers.google.com/drive/v2/web/about-sdk" target="_top">online documentation</a>.

</div>
<div class="refsect1">
<a name="GDataDocumentsText.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gdata-documents-text-new"></a><h3>gdata_documents_text_new ()</h3>
<pre class="programlisting"><a class="link" href="GDataDocumentsText.html" title="GDataDocumentsText"><span class="returnvalue">GDataDocumentsText</span></a> *
gdata_documents_text_new (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);</pre>
<p>Creates a new <a class="link" href="GDataDocumentsText.html" title="GDataDocumentsText"><span class="type">GDataDocumentsText</span></a> with the given entry ID (<a class="link" href="GDataEntry.html#GDataEntry--id" title="The “id” property"><span class="type">“id”</span></a>).</p>
<div class="refsect3">
<a name="gdata-documents-text-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>id</p></td>
<td class="parameter_description"><p>the entry's ID (not the document ID of the text document), 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-documents-text-new.returns"></a><h4>Returns</h4>
<p>a new <a class="link" href="GDataDocumentsText.html" title="GDataDocumentsText"><span class="type">GDataDocumentsText</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.4.0">0.4.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="GDataDocumentsText.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GDATA-DOCUMENTS-TEXT-DOC:CAPS"></a><h3>GDATA_DOCUMENTS_TEXT_DOC</h3>
<pre class="programlisting">#define GDATA_DOCUMENTS_TEXT_DOC "doc"
</pre>
<p>The export format for Microsoft Word (DOC) format.</p>
<p>For more information, see the</p>
<a class="ulink" href="https://developers.google.com/google-apps/documents-list/#valid_download_formats_for_text_documents" target="_top">
GData protocol specification</a>.
<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-DOCUMENTS-TEXT-HTML:CAPS"></a><h3>GDATA_DOCUMENTS_TEXT_HTML</h3>
<pre class="programlisting">#define GDATA_DOCUMENTS_TEXT_HTML "html"
</pre>
<p>The export format for HyperText Markup Language (HTML) format.</p>
<p>For more information, see the</p>
<a class="ulink" href="https://developers.google.com/google-apps/documents-list/#valid_download_formats_for_text_documents" target="_top">
GData protocol specification</a>.
<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-DOCUMENTS-TEXT-JPEG:CAPS"></a><h3>GDATA_DOCUMENTS_TEXT_JPEG</h3>
<pre class="programlisting">#define GDATA_DOCUMENTS_TEXT_JPEG "jpeg"
</pre>
<p>The export format for JPEG image format.</p>
<p>For more information, see the</p>
<a class="ulink" href="https://developers.google.com/google-apps/documents-list/#valid_download_formats_for_text_documents" target="_top">
GData protocol specification</a>.
<p class="since">Since: <a class="link" href="ix15.html#api-index-0.13.0">0.13.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDATA-DOCUMENTS-TEXT-ODT:CAPS"></a><h3>GDATA_DOCUMENTS_TEXT_ODT</h3>
<pre class="programlisting">#define GDATA_DOCUMENTS_TEXT_ODT "odt"
</pre>
<p>The export format for OpenDocument Text (ODT) format.</p>
<p>For more information, see the</p>
<a class="ulink" href="https://developers.google.com/google-apps/documents-list/#valid_download_formats_for_text_documents" target="_top">
GData protocol specification</a>.
<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-DOCUMENTS-TEXT-PDF:CAPS"></a><h3>GDATA_DOCUMENTS_TEXT_PDF</h3>
<pre class="programlisting">#define GDATA_DOCUMENTS_TEXT_PDF "pdf"
</pre>
<p>The export format for Portable Document Format (PDF).</p>
<p>For more information, see the</p>
<a class="ulink" href="https://developers.google.com/google-apps/documents-list/#valid_download_formats_for_text_documents" target="_top">
GData protocol specification</a>.
<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-DOCUMENTS-TEXT-PNG:CAPS"></a><h3>GDATA_DOCUMENTS_TEXT_PNG</h3>
<pre class="programlisting">#define GDATA_DOCUMENTS_TEXT_PNG "png"
</pre>
<p>The export format for Portable Network Graphics (PNG) image format.</p>
<p>For more information, see the</p>
<a class="ulink" href="https://developers.google.com/google-apps/documents-list/#valid_download_formats_for_text_documents" target="_top">
GData protocol specification</a>.
<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-DOCUMENTS-TEXT-RTF:CAPS"></a><h3>GDATA_DOCUMENTS_TEXT_RTF</h3>
<pre class="programlisting">#define GDATA_DOCUMENTS_TEXT_RTF "rtf"
</pre>
<p>The export format for Rich Text Format (RTF).</p>
<p>For more information, see the</p>
<a class="ulink" href="https://developers.google.com/google-apps/documents-list/#valid_download_formats_for_text_documents" target="_top">
GData protocol specification</a>.
<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-DOCUMENTS-TEXT-TXT:CAPS"></a><h3>GDATA_DOCUMENTS_TEXT_TXT</h3>
<pre class="programlisting">#define GDATA_DOCUMENTS_TEXT_TXT "txt"
</pre>
<p>The export format for plain text format.</p>
<p>For more information, see the</p>
<a class="ulink" href="https://developers.google.com/google-apps/documents-list/#valid_download_formats_for_text_documents" target="_top">
GData protocol specification</a>.
<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-DOCUMENTS-TEXT-ZIP:CAPS"></a><h3>GDATA_DOCUMENTS_TEXT_ZIP</h3>
<pre class="programlisting">#define GDATA_DOCUMENTS_TEXT_ZIP "zip"
</pre>
<p>The export format for a ZIP archive containing images and exported HTML.</p>
<p>For more information, see the</p>
<a class="ulink" href="https://developers.google.com/google-apps/documents-list/#valid_download_formats_for_text_documents" target="_top">
GData protocol specification</a>.
<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="GDataDocumentsText-struct"></a><h3>GDataDocumentsText</h3>
<pre class="programlisting">typedef struct _GDataDocumentsText GDataDocumentsText;</pre>
<p>All the fields in the <a class="link" href="GDataDocumentsText.html" title="GDataDocumentsText"><span class="type">GDataDocumentsText</span></a> structure are private and should never be accessed directly.</p>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.4.0">0.4.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataDocumentsTextClass"></a><h3>GDataDocumentsTextClass</h3>
<pre class="programlisting">typedef struct {
} GDataDocumentsTextClass;
</pre>
<p>All the fields in the <a class="link" href="GDataDocumentsText.html#GDataDocumentsTextClass" title="GDataDocumentsTextClass"><span class="type">GDataDocumentsTextClass</span></a> structure are private and should never be accessed directly.</p>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.4.0">0.4.0</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.26.1</div>
</body>
</html>