<!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.5"/>
<title>Geany: tm_workspace.h File 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.23.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<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><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_907687f7c764111b7539bc23e763d98c.html">tagmanager</a></li><li class="navelem"><a class="el" href="dir_fbaa723b1f8a3eea6f197d82c57d4088.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">tm_workspace.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structTMWorkspace.html">TMWorkspace</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ac5a83f7fe6aaa1537ebdf6a6bac56e67"><td class="memItemLeft" align="right" valign="top">gboolean </td><td class="memItemRight" valign="bottom"><a class="el" href="tm__workspace_8h.html#ac5a83f7fe6aaa1537ebdf6a6bac56e67">tm_workspace_add_object</a> (<a class="el" href="structTMWorkObject.html">TMWorkObject</a> *work_object)</td></tr>
<tr class="separator:ac5a83f7fe6aaa1537ebdf6a6bac56e67"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac0e790d1ee56e637da3e572d13514c35"><td class="memItemLeft" align="right" valign="top">gboolean </td><td class="memItemRight" valign="bottom"><a class="el" href="tm__workspace_8h.html#ac0e790d1ee56e637da3e572d13514c35">tm_workspace_remove_object</a> (<a class="el" href="structTMWorkObject.html">TMWorkObject</a> *work_object, gboolean do_free, gboolean update)</td></tr>
<tr class="separator:ac0e790d1ee56e637da3e572d13514c35"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="structTMWorkspace.html">TMWorkspace</a> structure is meant to be used as a singleton to store application wide tag information.</p>
<p>The workspace is intended to contain a list of global tags and a set of work objects (projects or individual files). You need not use the workspace, though, to use tag manager, unless you need things like global tags and a place to store all current open projects and individual files. <a class="el" href="structTMWorkspace.html">TMWorkspace</a> is derived from <a class="el" href="structTMWorkObject.html">TMWorkObject</a>. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ac5a83f7fe6aaa1537ebdf6a6bac56e67"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gboolean tm_workspace_add_object </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structTMWorkObject.html">TMWorkObject</a> * </td>
<td class="paramname"><em>work_object</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a work object (source file or project) to the workspace. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">work_object</td><td>The work object to add to the project. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE on success, FALSE on failure (e.g. object already exixts). </dd></dl>
</div>
</div>
<a class="anchor" id="ac0e790d1ee56e637da3e572d13514c35"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gboolean tm_workspace_remove_object </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structTMWorkObject.html">TMWorkObject</a> * </td>
<td class="paramname"><em>work_object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gboolean </td>
<td class="paramname"><em>do_free</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gboolean </td>
<td class="paramname"><em>update</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes a member object from the workspace if it exists. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">work_object</td><td>Pointer to the work object to be removed. </td></tr>
<tr><td class="paramname">do_free</td><td>Whether the work object is to be freed as well. </td></tr>
<tr><td class="paramname">update</td><td>Whether to update workspace objects. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE on success, FALSE on failure (e.g. the work object does not exist). </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Oct 18 2013 23:44:59 for Geany by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
