<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>Geany: GeanyDocument Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Geany
 <span id="projectnumber">1.24.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">GeanyDocument Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Structure for representing an open tab with all its properties.
<a href="structGeanyDocument.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a10ec6771840a03f3990ed1fbb8854055"><td class="memItemLeft" align="right" valign="top">gboolean </td><td class="memItemRight" valign="bottom"><a class="el" href="structGeanyDocument.html#a10ec6771840a03f3990ed1fbb8854055">changed</a></td></tr>
<tr class="memdesc:a10ec6771840a03f3990ed1fbb8854055"><td class="mdescLeft"> </td><td class="mdescRight">Whether this document has been changed since it was last saved. <a href="#a10ec6771840a03f3990ed1fbb8854055">More...</a><br /></td></tr>
<tr class="separator:a10ec6771840a03f3990ed1fbb8854055"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a99460dba14da73baccb0e992da2da2b5"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structGeanyEditor.html">GeanyEditor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structGeanyDocument.html#a99460dba14da73baccb0e992da2da2b5">editor</a></td></tr>
<tr class="memdesc:a99460dba14da73baccb0e992da2da2b5"><td class="mdescLeft"> </td><td class="mdescRight">The editor associated with the document. <a href="#a99460dba14da73baccb0e992da2da2b5">More...</a><br /></td></tr>
<tr class="separator:a99460dba14da73baccb0e992da2da2b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a67e75b23fb08a083cc1d5f61aa729342"><td class="memItemLeft" align="right" valign="top">gchar * </td><td class="memItemRight" valign="bottom"><a class="el" href="structGeanyDocument.html#a67e75b23fb08a083cc1d5f61aa729342">encoding</a></td></tr>
<tr class="memdesc:a67e75b23fb08a083cc1d5f61aa729342"><td class="mdescLeft"> </td><td class="mdescRight">The encoding of the document, must be a valid string representation of an encoding, can be retrieved with <a class="el" href="encodings_8h.html#a91d89ed4c575f252e4ac224f4fe273a5">encodings_get_charset_from_index</a>. <a href="#a67e75b23fb08a083cc1d5f61aa729342">More...</a><br /></td></tr>
<tr class="separator:a67e75b23fb08a083cc1d5f61aa729342"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a03560e88ad8427b40077cddbc5afbd43"><td class="memItemLeft" align="right" valign="top">gchar * </td><td class="memItemRight" valign="bottom"><a class="el" href="structGeanyDocument.html#a03560e88ad8427b40077cddbc5afbd43">file_name</a></td></tr>
<tr class="memdesc:a03560e88ad8427b40077cddbc5afbd43"><td class="mdescLeft"> </td><td class="mdescRight">The UTF-8 encoded file name. <a href="#a03560e88ad8427b40077cddbc5afbd43">More...</a><br /></td></tr>
<tr class="separator:a03560e88ad8427b40077cddbc5afbd43"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18635020e974f5dab568e6297f6524f7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structGeanyFiletype.html">GeanyFiletype</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structGeanyDocument.html#a18635020e974f5dab568e6297f6524f7">file_type</a></td></tr>
<tr class="memdesc:a18635020e974f5dab568e6297f6524f7"><td class="mdescLeft"> </td><td class="mdescRight">The filetype for this document, it's only a reference to one of the elements of the global filetypes array. <a href="#a18635020e974f5dab568e6297f6524f7">More...</a><br /></td></tr>
<tr class="separator:a18635020e974f5dab568e6297f6524f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4d712adc7072c5451016d46106df6c4c"><td class="memItemLeft" align="right" valign="top">gboolean </td><td class="memItemRight" valign="bottom"><a class="el" href="structGeanyDocument.html#a4d712adc7072c5451016d46106df6c4c">has_bom</a></td></tr>
<tr class="memdesc:a4d712adc7072c5451016d46106df6c4c"><td class="mdescLeft"> </td><td class="mdescRight">Internally used flag to indicate whether the file of this document has a byte-order-mark. <a href="#a4d712adc7072c5451016d46106df6c4c">More...</a><br /></td></tr>
<tr class="separator:a4d712adc7072c5451016d46106df6c4c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2c5df23966d2704c246a82f900bb3b36"><td class="memItemLeft" align="right" valign="top">gboolean </td><td class="memItemRight" valign="bottom"><a class="el" href="structGeanyDocument.html#a2c5df23966d2704c246a82f900bb3b36">has_tags</a></td></tr>
<tr class="memdesc:a2c5df23966d2704c246a82f900bb3b36"><td class="mdescLeft"> </td><td class="mdescRight">Whether this document supports source code symbols(tags) to show in the sidebar. <a href="#a2c5df23966d2704c246a82f900bb3b36">More...</a><br /></td></tr>
<tr class="separator:a2c5df23966d2704c246a82f900bb3b36"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaab532f9c0f45121cf5d095a0052ed6c"><td class="memItemLeft" align="right" valign="top">gint </td><td class="memItemRight" valign="bottom"><a class="el" href="structGeanyDocument.html#aaab532f9c0f45121cf5d095a0052ed6c">index</a></td></tr>
<tr class="memdesc:aaab532f9c0f45121cf5d095a0052ed6c"><td class="mdescLeft"> </td><td class="mdescRight">Index in the documents array. <a href="#aaab532f9c0f45121cf5d095a0052ed6c">More...</a><br /></td></tr>
<tr class="separator:aaab532f9c0f45121cf5d095a0052ed6c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a958fbaae66bfdf06d6be18f6a74a6e99"><td class="memItemLeft" align="right" valign="top">gboolean </td><td class="memItemRight" valign="bottom"><a class="el" href="structGeanyDocument.html#a958fbaae66bfdf06d6be18f6a74a6e99">is_valid</a></td></tr>
<tr class="memdesc:a958fbaae66bfdf06d6be18f6a74a6e99"><td class="mdescLeft"> </td><td class="mdescRight">General flag to represent this document is active and all properties are set correctly. <a href="#a958fbaae66bfdf06d6be18f6a74a6e99">More...</a><br /></td></tr>
<tr class="separator:a958fbaae66bfdf06d6be18f6a74a6e99"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a80568d3217a77387dd3c611d6007b9f1"><td class="memItemLeft" align="right" valign="top">gboolean </td><td class="memItemRight" valign="bottom"><a class="el" href="structGeanyDocument.html#a80568d3217a77387dd3c611d6007b9f1">readonly</a></td></tr>
<tr class="memdesc:a80568d3217a77387dd3c611d6007b9f1"><td class="mdescLeft"> </td><td class="mdescRight">Whether this document is read-only. <a href="#a80568d3217a77387dd3c611d6007b9f1">More...</a><br /></td></tr>
<tr class="separator:a80568d3217a77387dd3c611d6007b9f1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a66cf9c7c1bcea5278af56719aac29865"><td class="memItemLeft" align="right" valign="top">gchar * </td><td class="memItemRight" valign="bottom"><a class="el" href="structGeanyDocument.html#a66cf9c7c1bcea5278af56719aac29865">real_path</a></td></tr>
<tr class="memdesc:a66cf9c7c1bcea5278af56719aac29865"><td class="mdescLeft"> </td><td class="mdescRight">The link-dereferenced, locale-encoded file name. <a href="#a66cf9c7c1bcea5278af56719aac29865">More...</a><br /></td></tr>
<tr class="separator:a66cf9c7c1bcea5278af56719aac29865"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8c482c6429fa82f9b0fcc1a93fca3605"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structTMWorkObject.html">TMWorkObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structGeanyDocument.html#a8c482c6429fa82f9b0fcc1a93fca3605">tm_file</a></td></tr>
<tr class="memdesc:a8c482c6429fa82f9b0fcc1a93fca3605"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structTMWorkObject.html">TMWorkObject</a> object for this document, or <code>NULL</code>. <a href="#a8c482c6429fa82f9b0fcc1a93fca3605">More...</a><br /></td></tr>
<tr class="separator:a8c482c6429fa82f9b0fcc1a93fca3605"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Structure for representing an open tab with all its properties. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a10ec6771840a03f3990ed1fbb8854055"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gboolean GeanyDocument::changed</td>
</tr>
</table>
</div><div class="memdoc">
<p>Whether this document has been changed since it was last saved. </p>
</div>
</div>
<a class="anchor" id="a99460dba14da73baccb0e992da2da2b5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structGeanyEditor.html">GeanyEditor</a>* GeanyDocument::editor</td>
</tr>
</table>
</div><div class="memdoc">
<p>The editor associated with the document. </p>
</div>
</div>
<a class="anchor" id="a67e75b23fb08a083cc1d5f61aa729342"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gchar* GeanyDocument::encoding</td>
</tr>
</table>
</div><div class="memdoc">
<p>The encoding of the document, must be a valid string representation of an encoding, can be retrieved with <a class="el" href="encodings_8h.html#a91d89ed4c575f252e4ac224f4fe273a5">encodings_get_charset_from_index</a>. </p>
</div>
</div>
<a class="anchor" id="a03560e88ad8427b40077cddbc5afbd43"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gchar* GeanyDocument::file_name</td>
</tr>
</table>
</div><div class="memdoc">
<p>The UTF-8 encoded file name. </p>
<p>Be careful; glibc and GLib file functions expect the locale representation of the file name which can be different from this. For conversion into locale encoding, you can use <a class="el" href="utils_8h.html#a560f1208bd2ed1b6abc8a20a0f98961a">utils_get_locale_from_utf8()</a>. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="structGeanyDocument.html#a66cf9c7c1bcea5278af56719aac29865" title="The link-dereferenced, locale-encoded file name. ">real_path</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a18635020e974f5dab568e6297f6524f7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structGeanyFiletype.html">GeanyFiletype</a>* GeanyDocument::file_type</td>
</tr>
</table>
</div><div class="memdoc">
<p>The filetype for this document, it's only a reference to one of the elements of the global filetypes array. </p>
</div>
</div>
<a class="anchor" id="a4d712adc7072c5451016d46106df6c4c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gboolean GeanyDocument::has_bom</td>
</tr>
</table>
</div><div class="memdoc">
<p>Internally used flag to indicate whether the file of this document has a byte-order-mark. </p>
</div>
</div>
<a class="anchor" id="a2c5df23966d2704c246a82f900bb3b36"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gboolean GeanyDocument::has_tags</td>
</tr>
</table>
</div><div class="memdoc">
<p>Whether this document supports source code symbols(tags) to show in the sidebar. </p>
</div>
</div>
<a class="anchor" id="aaab532f9c0f45121cf5d095a0052ed6c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gint GeanyDocument::index</td>
</tr>
</table>
</div><div class="memdoc">
<p>Index in the documents array. </p>
</div>
</div>
<a class="anchor" id="a958fbaae66bfdf06d6be18f6a74a6e99"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gboolean GeanyDocument::is_valid</td>
</tr>
</table>
</div><div class="memdoc">
<p>General flag to represent this document is active and all properties are set correctly. </p>
</div>
</div>
<a class="anchor" id="a80568d3217a77387dd3c611d6007b9f1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gboolean GeanyDocument::readonly</td>
</tr>
</table>
</div><div class="memdoc">
<p>Whether this document is read-only. </p>
</div>
</div>
<a class="anchor" id="a66cf9c7c1bcea5278af56719aac29865"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gchar* GeanyDocument::real_path</td>
</tr>
</table>
</div><div class="memdoc">
<p>The link-dereferenced, locale-encoded file name. </p>
<p>If non-NULL, this indicates the file once existed on disk (not just as an unsaved document with a filename set).</p>
<dl class="section note"><dt>Note</dt><dd>This is only assigned after a successful save or open - it should not be set elsewhere. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structGeanyDocument.html#a03560e88ad8427b40077cddbc5afbd43" title="The UTF-8 encoded file name. ">file_name</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a8c482c6429fa82f9b0fcc1a93fca3605"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structTMWorkObject.html">TMWorkObject</a>* GeanyDocument::tm_file</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structTMWorkObject.html">TMWorkObject</a> object for this document, or <code>NULL</code>. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Oct 17 2014 05:13:17 for Geany by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-release
>
by-pkgid
>
0c00422fba9a46710101d04f3f3175e7
>
files
>
136
