<!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: highlighting.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="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">highlighting.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Syntax highlighting for the different filetypes, using the Scintilla lexers.
<a href="#details">More...</a></p>
<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="structGeanyLexerStyle.html">GeanyLexerStyle</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Fields representing the different attributes of a Scintilla lexer style. <a href="structGeanyLexerStyle.html#details">More...</a><br /></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="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a58fb93387c771e25cf7676fb9f3c5c87"><td class="memItemLeft" align="right" valign="top">typedef G_BEGIN_DECLS struct <br class="typebreak" />
<a class="el" href="structGeanyLexerStyle.html">GeanyLexerStyle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="highlighting_8h.html#a58fb93387c771e25cf7676fb9f3c5c87">GeanyLexerStyle</a></td></tr>
<tr class="memdesc:a58fb93387c771e25cf7676fb9f3c5c87"><td class="mdescLeft"> </td><td class="mdescRight">Fields representing the different attributes of a Scintilla lexer style. <a href="#a58fb93387c771e25cf7676fb9f3c5c87">More...</a><br /></td></tr>
<tr class="separator:a58fb93387c771e25cf7676fb9f3c5c87"><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:a02780f3d3d02d892f2e79ad583be0bf6"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structGeanyLexerStyle.html">GeanyLexerStyle</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="highlighting_8h.html#a02780f3d3d02d892f2e79ad583be0bf6">highlighting_get_style</a> (gint ft_id, gint style_id)</td></tr>
<tr class="memdesc:a02780f3d3d02d892f2e79ad583be0bf6"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a style <em>style_id</em> for the filetype <em>ft_id</em>. <a href="#a02780f3d3d02d892f2e79ad583be0bf6">More...</a><br /></td></tr>
<tr class="separator:a02780f3d3d02d892f2e79ad583be0bf6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a79157c3cae4a4eb3135029cffd5ff1a8"><td class="memItemLeft" align="right" valign="top">gboolean </td><td class="memItemRight" valign="bottom"><a class="el" href="highlighting_8h.html#a79157c3cae4a4eb3135029cffd5ff1a8">highlighting_is_code_style</a> (gint lexer, gint style)</td></tr>
<tr class="memdesc:a79157c3cae4a4eb3135029cffd5ff1a8"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the given style is normal code (not string, comment, preprocessor, etc). <a href="#a79157c3cae4a4eb3135029cffd5ff1a8">More...</a><br /></td></tr>
<tr class="separator:a79157c3cae4a4eb3135029cffd5ff1a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af2de7822f2fcd8bfad90041c39b0a1d1"><td class="memItemLeft" align="right" valign="top">gboolean </td><td class="memItemRight" valign="bottom"><a class="el" href="highlighting_8h.html#af2de7822f2fcd8bfad90041c39b0a1d1">highlighting_is_comment_style</a> (gint lexer, gint style)</td></tr>
<tr class="memdesc:af2de7822f2fcd8bfad90041c39b0a1d1"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the given style is a comment for the given lexer. <a href="#af2de7822f2fcd8bfad90041c39b0a1d1">More...</a><br /></td></tr>
<tr class="separator:af2de7822f2fcd8bfad90041c39b0a1d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a475c26d1bcd04f433a5b6afe3c354a0f"><td class="memItemLeft" align="right" valign="top">gboolean </td><td class="memItemRight" valign="bottom"><a class="el" href="highlighting_8h.html#a475c26d1bcd04f433a5b6afe3c354a0f">highlighting_is_string_style</a> (gint lexer, gint style)</td></tr>
<tr class="memdesc:a475c26d1bcd04f433a5b6afe3c354a0f"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the given style is a string for the given lexer. <a href="#a475c26d1bcd04f433a5b6afe3c354a0f">More...</a><br /></td></tr>
<tr class="separator:a475c26d1bcd04f433a5b6afe3c354a0f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac3b16a285f3f0cbc31de629fb04a14d0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="highlighting_8h.html#ac3b16a285f3f0cbc31de629fb04a14d0">highlighting_set_styles</a> (ScintillaObject *sci, <a class="el" href="structGeanyFiletype.html">GeanyFiletype</a> *ft)</td></tr>
<tr class="memdesc:ac3b16a285f3f0cbc31de629fb04a14d0"><td class="mdescLeft"> </td><td class="mdescRight">Sets up highlighting and other visual settings. <a href="#ac3b16a285f3f0cbc31de629fb04a14d0">More...</a><br /></td></tr>
<tr class="separator:ac3b16a285f3f0cbc31de629fb04a14d0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Syntax highlighting for the different filetypes, using the Scintilla lexers. </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a58fb93387c771e25cf7676fb9f3c5c87"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef G_BEGIN_DECLS struct <a class="el" href="structGeanyLexerStyle.html">GeanyLexerStyle</a>
<a class="el" href="structGeanyLexerStyle.html">GeanyLexerStyle</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Fields representing the different attributes of a Scintilla lexer style. </p>
<dl class="section see"><dt>See also</dt><dd>Scintilla messages <code>SCI_STYLEGETFORE</code>, etc, for use with scintilla_send_message(). </dd></dl>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a02780f3d3d02d892f2e79ad583be0bf6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structGeanyLexerStyle.html">GeanyLexerStyle</a>* highlighting_get_style </td>
<td>(</td>
<td class="paramtype">gint </td>
<td class="paramname"><em>ft_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gint </td>
<td class="paramname"><em>style_id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves a style <em>style_id</em> for the filetype <em>ft_id</em>. </p>
<p>If the style was not already initialised (e.g. by by opening a file of this type), it will be initialised. The returned pointer is owned by Geany and must not be freed. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ft_id</td><td>Filetype ID, e.g. <code>GEANY_FILETYPES_DIFF</code>. </td></tr>
<tr><td class="paramname">style_id</td><td>A Scintilla lexer style, e.g. <code>SCE_DIFF_ADDED</code>. See scintilla/include/SciLexer.h. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the style struct. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>Scintilla messages <code>SCI_STYLEGETFORE</code>, etc, for use with scintilla_send_message(). </dd></dl>
</div>
</div>
<a class="anchor" id="a79157c3cae4a4eb3135029cffd5ff1a8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gboolean highlighting_is_code_style </td>
<td>(</td>
<td class="paramtype">gint </td>
<td class="paramname"><em>lexer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gint </td>
<td class="paramname"><em>style</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks whether the given style is normal code (not string, comment, preprocessor, etc). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lexer</td><td>Scintilla lexer type (<code>SCLEX_*</code>). </td></tr>
<tr><td class="paramname">style</td><td>Scintilla style (<code>SCE_*</code>).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>TRUE</code> if the style is code, <code>FALSE</code> otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="af2de7822f2fcd8bfad90041c39b0a1d1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gboolean highlighting_is_comment_style </td>
<td>(</td>
<td class="paramtype">gint </td>
<td class="paramname"><em>lexer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gint </td>
<td class="paramname"><em>style</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks whether the given style is a comment for the given lexer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lexer</td><td>Scintilla lexer type (<code>SCLEX_*</code>). </td></tr>
<tr><td class="paramname">style</td><td>Scintilla style (<code>SCE_*</code>).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>TRUE</code> if the style is a comment, <code>FALSE</code> otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a475c26d1bcd04f433a5b6afe3c354a0f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gboolean highlighting_is_string_style </td>
<td>(</td>
<td class="paramtype">gint </td>
<td class="paramname"><em>lexer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gint </td>
<td class="paramname"><em>style</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks whether the given style is a string for the given lexer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lexer</td><td>Scintilla lexer type (<code>SCLEX_*</code>). </td></tr>
<tr><td class="paramname">style</td><td>Scintilla style (<code>SCE_*</code>).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>TRUE</code> if the style is a string, <code>FALSE</code> otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="ac3b16a285f3f0cbc31de629fb04a14d0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void highlighting_set_styles </td>
<td>(</td>
<td class="paramtype">ScintillaObject * </td>
<td class="paramname"><em>sci</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structGeanyFiletype.html">GeanyFiletype</a> * </td>
<td class="paramname"><em>ft</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets up highlighting and other visual settings. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sci</td><td>Scintilla widget. </td></tr>
<tr><td class="paramname">ft</td><td>Filetype settings to use. </td></tr>
</table>
</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
>
113
