<!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: build.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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">build.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Interface to the Build menu functionality.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a9f2e53abd038f30fbbf61bcda6fd61f5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f2e53abd038f30fbbf61bcda6fd61f5"></a>
typedef enum <a class="el" href="build_8h.html#a623590d230ed46f3a320b7fec4eb9cfe">GeanyBuildCmdEntries</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#a9f2e53abd038f30fbbf61bcda6fd61f5">GeanyBuildCmdEntries</a></td></tr>
<tr class="memdesc:a9f2e53abd038f30fbbf61bcda6fd61f5"><td class="mdescLeft"> </td><td class="mdescRight">The entries of a command for a menu item. <br/></td></tr>
<tr class="separator:a9f2e53abd038f30fbbf61bcda6fd61f5"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a623590d230ed46f3a320b7fec4eb9cfe"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#a623590d230ed46f3a320b7fec4eb9cfe">GeanyBuildCmdEntries</a> </td></tr>
<tr class="memdesc:a623590d230ed46f3a320b7fec4eb9cfe"><td class="mdescLeft"> </td><td class="mdescRight">The entries of a command for a menu item. <br/></td></tr>
<tr class="separator:a623590d230ed46f3a320b7fec4eb9cfe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1ce1c4edd573d8156743035413e180cf"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#a1ce1c4edd573d8156743035413e180cf">GeanyBuildGroup</a> </td></tr>
<tr class="memdesc:a1ce1c4edd573d8156743035413e180cf"><td class="mdescLeft"> </td><td class="mdescRight">Groups of Build menu items. <a href="build_8h.html#a1ce1c4edd573d8156743035413e180cf">More...</a><br/></td></tr>
<tr class="separator:a1ce1c4edd573d8156743035413e180cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acc0dd4ea4f755515e20e2083481e0265"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#acc0dd4ea4f755515e20e2083481e0265">GeanyBuildSource</a> </td></tr>
<tr class="memdesc:acc0dd4ea4f755515e20e2083481e0265"><td class="mdescLeft"> </td><td class="mdescRight">Build menu item sources in increasing priority. <br/></td></tr>
<tr class="separator:acc0dd4ea4f755515e20e2083481e0265"><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:a5ec9c4862ea49fd4beee93698a444d44"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#a5ec9c4862ea49fd4beee93698a444d44">build_activate_menu_item</a> (const <a class="el" href="build_8h.html#a1ce1c4edd573d8156743035413e180cf">GeanyBuildGroup</a> grp, const guint cmd)</td></tr>
<tr class="memdesc:a5ec9c4862ea49fd4beee93698a444d44"><td class="mdescLeft"> </td><td class="mdescRight">Activate the menu item. <a href="#a5ec9c4862ea49fd4beee93698a444d44">More...</a><br/></td></tr>
<tr class="separator:a5ec9c4862ea49fd4beee93698a444d44"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a55b7c19002f7c8cd97bbc9a65946522a"><td class="memItemLeft" align="right" valign="top">const gchar * </td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#a55b7c19002f7c8cd97bbc9a65946522a">build_get_current_menu_item</a> (const <a class="el" href="build_8h.html#a1ce1c4edd573d8156743035413e180cf">GeanyBuildGroup</a> grp, const guint cmd, const <a class="el" href="build_8h.html#a623590d230ed46f3a320b7fec4eb9cfe">GeanyBuildCmdEntries</a> field)</td></tr>
<tr class="memdesc:a55b7c19002f7c8cd97bbc9a65946522a"><td class="mdescLeft"> </td><td class="mdescRight">Get the string for the menu item field. <a href="#a55b7c19002f7c8cd97bbc9a65946522a">More...</a><br/></td></tr>
<tr class="separator:a55b7c19002f7c8cd97bbc9a65946522a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a262587f317932166c9d56cff34a5cd9a"><td class="memItemLeft" align="right" valign="top">guint </td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#a262587f317932166c9d56cff34a5cd9a">build_get_group_count</a> (const <a class="el" href="build_8h.html#a1ce1c4edd573d8156743035413e180cf">GeanyBuildGroup</a> grp)</td></tr>
<tr class="memdesc:a262587f317932166c9d56cff34a5cd9a"><td class="mdescLeft"> </td><td class="mdescRight">Get the count of commands for the group. <a href="#a262587f317932166c9d56cff34a5cd9a">More...</a><br/></td></tr>
<tr class="separator:a262587f317932166c9d56cff34a5cd9a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf3cfba380b57e1ec3d622c4a5fa69cb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#acf3cfba380b57e1ec3d622c4a5fa69cb">build_remove_menu_item</a> (const <a class="el" href="build_8h.html#acc0dd4ea4f755515e20e2083481e0265">GeanyBuildSource</a> src, const <a class="el" href="build_8h.html#a1ce1c4edd573d8156743035413e180cf">GeanyBuildGroup</a> grp, const gint cmd)</td></tr>
<tr class="memdesc:acf3cfba380b57e1ec3d622c4a5fa69cb"><td class="mdescLeft"> </td><td class="mdescRight">Remove the specified Build menu item. <a href="#acf3cfba380b57e1ec3d622c4a5fa69cb">More...</a><br/></td></tr>
<tr class="separator:acf3cfba380b57e1ec3d622c4a5fa69cb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad4ac1ae6f64a61e4491662ecac7abde4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#ad4ac1ae6f64a61e4491662ecac7abde4">build_set_menu_item</a> (const <a class="el" href="build_8h.html#acc0dd4ea4f755515e20e2083481e0265">GeanyBuildSource</a> src, const <a class="el" href="build_8h.html#a1ce1c4edd573d8156743035413e180cf">GeanyBuildGroup</a> grp, const guint cmd, const <a class="el" href="build_8h.html#a623590d230ed46f3a320b7fec4eb9cfe">GeanyBuildCmdEntries</a> field, const gchar *value)</td></tr>
<tr class="memdesc:ad4ac1ae6f64a61e4491662ecac7abde4"><td class="mdescLeft"> </td><td class="mdescRight">Set the string for the menu item field. <a href="#ad4ac1ae6f64a61e4491662ecac7abde4">More...</a><br/></td></tr>
<tr class="separator:ad4ac1ae6f64a61e4491662ecac7abde4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Interface to the Build menu functionality. </p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="a1ce1c4edd573d8156743035413e180cf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="build_8h.html#a1ce1c4edd573d8156743035413e180cf">GeanyBuildGroup</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Groups of Build menu items. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a5ec9c4862ea49fd4beee93698a444d44"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void build_activate_menu_item </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="build_8h.html#a1ce1c4edd573d8156743035413e180cf">GeanyBuildGroup</a> </td>
<td class="paramname"><em>grp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const guint </td>
<td class="paramname"><em>cmd</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Activate the menu item. </p>
<p>Activate the menu item specified by <em>grp</em> and <em>cmd</em>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">grp</td><td>the group of the specified menu item. </td></tr>
<tr><td class="paramname">cmd</td><td>the index of the command within the group. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a55b7c19002f7c8cd97bbc9a65946522a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const gchar* build_get_current_menu_item </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="build_8h.html#a1ce1c4edd573d8156743035413e180cf">GeanyBuildGroup</a> </td>
<td class="paramname"><em>grp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const guint </td>
<td class="paramname"><em>cmd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="build_8h.html#a623590d230ed46f3a320b7fec4eb9cfe">GeanyBuildCmdEntries</a> </td>
<td class="paramname"><em>fld</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the string for the menu item field. </p>
<p>Get the current highest priority command specified by <em>grp</em> and <em>cmd</em>. This is the one that the menu item will use if activated.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">grp</td><td>the group of the specified menu item. </td></tr>
<tr><td class="paramname">cmd</td><td>the index of the command within the group. </td></tr>
<tr><td class="paramname">fld</td><td>the field to return</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the constant string or <em>NULL</em> if it doesn't exist. This is a pointer to an internal structure and must not be freed. </dd></dl>
</div>
</div>
<a class="anchor" id="a262587f317932166c9d56cff34a5cd9a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">guint build_get_group_count </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="build_8h.html#a1ce1c4edd573d8156743035413e180cf">GeanyBuildGroup</a> </td>
<td class="paramname"><em>grp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the count of commands for the group. </p>
<p>Get the number of commands in the group specified by <em>grp</em>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">grp</td><td>the group of the specified menu item.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a count of the number of commands in the group </dd></dl>
</div>
</div>
<a class="anchor" id="acf3cfba380b57e1ec3d622c4a5fa69cb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void build_remove_menu_item </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="build_8h.html#acc0dd4ea4f755515e20e2083481e0265">GeanyBuildSource</a> </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="build_8h.html#a1ce1c4edd573d8156743035413e180cf">GeanyBuildGroup</a> </td>
<td class="paramname"><em>grp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const gint </td>
<td class="paramname"><em>cmd</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove the specified Build menu item. </p>
<p>Makes the specified menu item configuration no longer exist. This is different to setting fields to blank because the menu item will be deleted from the configuration file on saving (except the system filetypes settings </p>
<dl class="section see"><dt>See Also</dt><dd>Build Menu Configuration section of the Manual).</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src</td><td>the source of the menu item to remove. </td></tr>
<tr><td class="paramname">grp</td><td>the group of the command to remove. </td></tr>
<tr><td class="paramname">cmd</td><td>the index (from 0) of the command within the group. A negative value will remove the whole group.</td></tr>
</table>
</dd>
</dl>
<p>If any parameter is out of range does nothing.</p>
<p>Updates the menu. </p>
</div>
</div>
<a class="anchor" id="ad4ac1ae6f64a61e4491662ecac7abde4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void build_set_menu_item </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="build_8h.html#acc0dd4ea4f755515e20e2083481e0265">GeanyBuildSource</a> </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="build_8h.html#a1ce1c4edd573d8156743035413e180cf">GeanyBuildGroup</a> </td>
<td class="paramname"><em>grp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const guint </td>
<td class="paramname"><em>cmd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="build_8h.html#a623590d230ed46f3a320b7fec4eb9cfe">GeanyBuildCmdEntries</a> </td>
<td class="paramname"><em>fld</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const gchar * </td>
<td class="paramname"><em>val</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the string for the menu item field. </p>
<p>Set the specified field of the command specified by <em>src</em>, <em>grp</em> and <em>cmd</em>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src</td><td>the source of the menu item </td></tr>
<tr><td class="paramname">grp</td><td>the group of the specified menu item. </td></tr>
<tr><td class="paramname">cmd</td><td>the index of the menu item within the group. </td></tr>
<tr><td class="paramname">fld</td><td>the field in the menu item command to set </td></tr>
<tr><td class="paramname">val</td><td>the value to set the field to, is copied </td></tr>
</table>
</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>
