<!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: msgwindow.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.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><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="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">msgwindow.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Message window functions (status, compiler, messages windows).
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ad8078cfab1f7b51e9bc21006eddb9dda"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="msgwindow_8h.html#ad8078cfab1f7b51e9bc21006eddb9dda">MessageWindowTabNum</a> { <br />
  <a class="el" href="msgwindow_8h.html#ad8078cfab1f7b51e9bc21006eddb9ddaa57922cc9bcf45c4dd49add4fe18271f2">MSG_STATUS</a> = 0,
<a class="el" href="msgwindow_8h.html#ad8078cfab1f7b51e9bc21006eddb9ddaa078da822434c42f8f3e38ee3d5cad620">MSG_COMPILER</a>,
<a class="el" href="msgwindow_8h.html#ad8078cfab1f7b51e9bc21006eddb9ddaab0a37403bebbd992912497e3b532fe38">MSG_MESSAGE</a>,
<a class="el" href="msgwindow_8h.html#ad8078cfab1f7b51e9bc21006eddb9ddaad298fcdffd362d1ed75fec3940a6bed0">MSG_SCRATCH</a>,
<br />
  <a class="el" href="msgwindow_8h.html#ad8078cfab1f7b51e9bc21006eddb9ddaa2f74c2c619446b62d86b9b70b2b6c176">MSG_VTE</a>
<br />
}</td></tr>
<tr class="memdesc:ad8078cfab1f7b51e9bc21006eddb9dda"><td class="mdescLeft"> </td><td class="mdescRight">Indices of the notebooks in the messages window. <a href="msgwindow_8h.html#ad8078cfab1f7b51e9bc21006eddb9dda">More...</a><br /></td></tr>
<tr class="separator:ad8078cfab1f7b51e9bc21006eddb9dda"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:add70814ffb0a6c236c564afb452032df"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="msgwindow_8h.html#add70814ffb0a6c236c564afb452032df">MsgColors</a> { <a class="el" href="msgwindow_8h.html#add70814ffb0a6c236c564afb452032dfa592503b9434c1e751a92f3fc536d7950">COLOR_RED</a>,
<a class="el" href="msgwindow_8h.html#add70814ffb0a6c236c564afb452032dfa414edf96389aa436f960923360467010">COLOR_DARK_RED</a>,
<a class="el" href="msgwindow_8h.html#add70814ffb0a6c236c564afb452032dfa2a9daf215a30f1c539ead18c66380fc1">COLOR_BLACK</a>,
<a class="el" href="msgwindow_8h.html#add70814ffb0a6c236c564afb452032dfa1340428efccb140dcbdb71aa6176f696">COLOR_BLUE</a>
}</td></tr>
<tr class="memdesc:add70814ffb0a6c236c564afb452032df"><td class="mdescLeft"> </td><td class="mdescRight">Various colors for use in the compiler and messages treeviews when adding messages. <a href="msgwindow_8h.html#add70814ffb0a6c236c564afb452032df">More...</a><br /></td></tr>
<tr class="separator:add70814ffb0a6c236c564afb452032df"><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:a1f13c50792a6773873d813217807e2f2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="msgwindow_8h.html#a1f13c50792a6773873d813217807e2f2">msgwin_clear_tab</a> (gint tabnum)</td></tr>
<tr class="memdesc:a1f13c50792a6773873d813217807e2f2"><td class="mdescLeft"> </td><td class="mdescRight">Removes all messages from a tab specified by <em>tabnum</em> in the messages window. <a href="#a1f13c50792a6773873d813217807e2f2">More...</a><br /></td></tr>
<tr class="separator:a1f13c50792a6773873d813217807e2f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee76de9357b2abf8c15a0af10d8157a8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="msgwindow_8h.html#aee76de9357b2abf8c15a0af10d8157a8">msgwin_compiler_add</a> (gint msg_color, const gchar *format,...)</td></tr>
<tr class="memdesc:aee76de9357b2abf8c15a0af10d8157a8"><td class="mdescLeft"> </td><td class="mdescRight">Adds a new message in the compiler tab treeview in the messages window. <a href="#aee76de9357b2abf8c15a0af10d8157a8">More...</a><br /></td></tr>
<tr class="separator:aee76de9357b2abf8c15a0af10d8157a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a90a1a349312c1aece2f85773ee8d6ec1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="msgwindow_8h.html#a90a1a349312c1aece2f85773ee8d6ec1">msgwin_msg_add</a> (gint msg_color, gint line, <a class="el" href="structGeanyDocument.html">GeanyDocument</a> *doc, const gchar *format,...)</td></tr>
<tr class="memdesc:a90a1a349312c1aece2f85773ee8d6ec1"><td class="mdescLeft"> </td><td class="mdescRight">Adds a new message in the messages tab treeview in the messages window. <a href="#a90a1a349312c1aece2f85773ee8d6ec1">More...</a><br /></td></tr>
<tr class="separator:a90a1a349312c1aece2f85773ee8d6ec1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a55bc3c9bc70ebc43dec873178975c485"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="msgwindow_8h.html#a55bc3c9bc70ebc43dec873178975c485">msgwin_set_messages_dir</a> (const gchar *messages_dir)</td></tr>
<tr class="memdesc:a55bc3c9bc70ebc43dec873178975c485"><td class="mdescLeft"> </td><td class="mdescRight">Sets the Messages path for opening any parsed filenames without absolute path from message lines. <a href="#a55bc3c9bc70ebc43dec873178975c485">More...</a><br /></td></tr>
<tr class="separator:a55bc3c9bc70ebc43dec873178975c485"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa4cd8a07a3124d61eea475ee99ab0fda"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="msgwindow_8h.html#aa4cd8a07a3124d61eea475ee99ab0fda">msgwin_status_add</a> (const gchar *format,...)</td></tr>
<tr class="memdesc:aa4cd8a07a3124d61eea475ee99ab0fda"><td class="mdescLeft"> </td><td class="mdescRight">Logs a status message <em>without</em> setting the status bar. <a href="#aa4cd8a07a3124d61eea475ee99ab0fda">More...</a><br /></td></tr>
<tr class="separator:aa4cd8a07a3124d61eea475ee99ab0fda"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a02859456b46de13572585ee41518aeaa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="msgwindow_8h.html#a02859456b46de13572585ee41518aeaa">msgwin_switch_tab</a> (gint tabnum, gboolean show)</td></tr>
<tr class="memdesc:a02859456b46de13572585ee41518aeaa"><td class="mdescLeft"> </td><td class="mdescRight">Switches to the given notebook tab of the messages window and shows the messages window if it was previously hidden and <em>show</em> is set to <code>TRUE</code>. <a href="#a02859456b46de13572585ee41518aeaa">More...</a><br /></td></tr>
<tr class="separator:a02859456b46de13572585ee41518aeaa"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Message window functions (status, compiler, messages windows). </p>
<p>Also compiler error message parsing and grep file and line parsing.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structGeanyMainWidgets.html#a5aca450d37d008ca529980ce26bb8df6" title="Message Window notebook. ">GeanyMainWidgets::message_window_notebook</a> to append a new notebook page. </dd></dl>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ad8078cfab1f7b51e9bc21006eddb9dda"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="msgwindow_8h.html#ad8078cfab1f7b51e9bc21006eddb9dda">MessageWindowTabNum</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Indices of the notebooks in the messages window. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ad8078cfab1f7b51e9bc21006eddb9ddaa57922cc9bcf45c4dd49add4fe18271f2"></a>MSG_STATUS </td><td class="fielddoc">
<p>Index of the status message tab. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ad8078cfab1f7b51e9bc21006eddb9ddaa078da822434c42f8f3e38ee3d5cad620"></a>MSG_COMPILER </td><td class="fielddoc">
<p>Index of the compiler tab. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ad8078cfab1f7b51e9bc21006eddb9ddaab0a37403bebbd992912497e3b532fe38"></a>MSG_MESSAGE </td><td class="fielddoc">
<p>Index of the messages tab. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ad8078cfab1f7b51e9bc21006eddb9ddaad298fcdffd362d1ed75fec3940a6bed0"></a>MSG_SCRATCH </td><td class="fielddoc">
<p>Index of the scratch tab. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ad8078cfab1f7b51e9bc21006eddb9ddaa2f74c2c619446b62d86b9b70b2b6c176"></a>MSG_VTE </td><td class="fielddoc">
<p>Index of the VTE tab. </p>
</td></tr>
</table>
</div>
</div>
<a class="anchor" id="add70814ffb0a6c236c564afb452032df"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="msgwindow_8h.html#add70814ffb0a6c236c564afb452032df">MsgColors</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Various colors for use in the compiler and messages treeviews when adding messages. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="add70814ffb0a6c236c564afb452032dfa592503b9434c1e751a92f3fc536d7950"></a>COLOR_RED </td><td class="fielddoc">
<p>Color red. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="add70814ffb0a6c236c564afb452032dfa414edf96389aa436f960923360467010"></a>COLOR_DARK_RED </td><td class="fielddoc">
<p>Color dark red. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="add70814ffb0a6c236c564afb452032dfa2a9daf215a30f1c539ead18c66380fc1"></a>COLOR_BLACK </td><td class="fielddoc">
<p>Color black. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="add70814ffb0a6c236c564afb452032dfa1340428efccb140dcbdb71aa6176f696"></a>COLOR_BLUE </td><td class="fielddoc">
<p>Color blue. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a1f13c50792a6773873d813217807e2f2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void msgwin_clear_tab </td>
<td>(</td>
<td class="paramtype">gint </td>
<td class="paramname"><em>tabnum</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes all messages from a tab specified by <em>tabnum</em> in the messages window. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tabnum</td><td>An index of a tab in the messages window which should be cleared. Valid values are <code>MSG_STATUS</code>, <code>MSG_COMPILER</code> and <code>MSG_MESSAGE</code>.</td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>0.15 </dd></dl>
</div>
</div>
<a class="anchor" id="aee76de9357b2abf8c15a0af10d8157a8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void msgwin_compiler_add </td>
<td>(</td>
<td class="paramtype">gint </td>
<td class="paramname"><em>msg_color</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const gchar * </td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a new message in the compiler tab treeview in the messages window. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg_color</td><td>A color to be used for the text. It must be an element of <a class="el" href="msgwindow_8h.html#add70814ffb0a6c236c564afb452032df" title="Various colors for use in the compiler and messages treeviews when adding messages. ">MsgColors</a>. </td></tr>
<tr><td class="paramname">format</td><td><code>printf()-style</code> format string. </td></tr>
<tr><td class="paramname">...</td><td>Arguments for the <code>format</code> string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a90a1a349312c1aece2f85773ee8d6ec1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void msgwin_msg_add </td>
<td>(</td>
<td class="paramtype">gint </td>
<td class="paramname"><em>msg_color</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gint </td>
<td class="paramname"><em>line</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structGeanyDocument.html">GeanyDocument</a> * </td>
<td class="paramname"><em>doc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const gchar * </td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a new message in the messages tab treeview in the messages window. </p>
<p>If <em>line</em> and <em>doc</em> are set, clicking on this line jumps into the file which is specified by <em>doc</em> into the line specified with <em>line</em>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg_color</td><td>A color to be used for the text. It must be an element of <a class="el" href="msgwindow_8h.html#add70814ffb0a6c236c564afb452032df" title="Various colors for use in the compiler and messages treeviews when adding messages. ">MsgColors</a>. </td></tr>
<tr><td class="paramname">line</td><td>The document's line where the message belongs to. Set to <code>-1</code> to ignore. </td></tr>
<tr><td class="paramname">doc</td><td>The document. Set to <code>NULL</code> to ignore. </td></tr>
<tr><td class="paramname">format</td><td><code>printf()-style</code> format string. </td></tr>
<tr><td class="paramname">...</td><td>Arguments for the <code>format</code> string.</td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>0.15 </dd></dl>
</div>
</div>
<a class="anchor" id="a55bc3c9bc70ebc43dec873178975c485"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void msgwin_set_messages_dir </td>
<td>(</td>
<td class="paramtype">const gchar * </td>
<td class="paramname"><em>messages_dir</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the Messages path for opening any parsed filenames without absolute path from message lines. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">messages_dir</td><td>The directory. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa4cd8a07a3124d61eea475ee99ab0fda"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void msgwin_status_add </td>
<td>(</td>
<td class="paramtype">const gchar * </td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Logs a status message <em>without</em> setting the status bar. </p>
<p>(Use <a class="el" href="ui__utils_8h.html#aa0948006d2f45a2a2a6b7da40169b8ac" title="Displays text on the statusbar. ">ui_set_statusbar()</a> to display text on the statusbar)</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">format</td><td><code>printf()-style</code> format string. </td></tr>
<tr><td class="paramname">...</td><td>Arguments for the <code>format</code> string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a02859456b46de13572585ee41518aeaa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void msgwin_switch_tab </td>
<td>(</td>
<td class="paramtype">gint </td>
<td class="paramname"><em>tabnum</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gboolean </td>
<td class="paramname"><em>show</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Switches to the given notebook tab of the messages window and shows the messages window if it was previously hidden and <em>show</em> is set to <code>TRUE</code>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tabnum</td><td>An index of a tab in the messages window. Valid values are all elements of <a class="el" href="msgwindow_8h.html#ad8078cfab1f7b51e9bc21006eddb9dda" title="Indices of the notebooks in the messages window. ">MessageWindowTabNum</a>. </td></tr>
<tr><td class="paramname">show</td><td>Whether to show the messages window at all if it was hidden before.</td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>0.15 </dd></dl>
</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
>
119
