<!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"/> <title>gtksourceviewmm: gtksourceview::SourceLanguage Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">gtksourceviewmm  <span id="projectnumber">2.10.3</span> </div> </td> </tr> </tbody> </table> </div> <!-- Generated by Doxygen 1.7.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="modules.html"><span>Modules</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><b>gtksourceview</b> </li> <li class="navelem"><a class="el" href="classgtksourceview_1_1SourceLanguage.html">SourceLanguage</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#related">Related Functions</a> </div> <div class="headertitle"> <div class="title">gtksourceview::SourceLanguage Class Reference</div> </div> </div> <div class="contents"> <!-- doxytag: class="gtksourceview::SourceLanguage" --><!-- doxytag: inherits="Glib::Object" --> <p>Object representing a syntax highlighted language. <a href="classgtksourceview_1_1SourceLanguage.html#details">More...</a></p> <p><code>#include <gtksourceviewmm/sourcelanguage.h></code></p> <div class="dynheader"> Inheritance diagram for gtksourceview::SourceLanguage:</div> <div class="dyncontent"> <div class="center"><img src="classgtksourceview_1_1SourceLanguage__inherit__graph.png" border="0" usemap="#gtksourceview_1_1SourceLanguage_inherit__map" alt="Inheritance graph"/></div> <map name="gtksourceview_1_1SourceLanguage_inherit__map" id="gtksourceview_1_1SourceLanguage_inherit__map"> <area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="71,155,165,181"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="55,80,181,107"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="61,5,176,32"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classgtksourceview_1_1SourceLanguage-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e746a1d6d2c80956926d7e7133f62fb"></a><!-- doxytag: member="gtksourceview::SourceLanguage::gobj" ref="a7e746a1d6d2c80956926d7e7133f62fb" args="()" --> GtkSourceLanguage* </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceLanguage.html#a7e746a1d6d2c80956926d7e7133f62fb">gobj</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae4f4a88f8ffc71d9d81263038af03fbf"></a><!-- doxytag: member="gtksourceview::SourceLanguage::gobj" ref="ae4f4a88f8ffc71d9d81263038af03fbf" args="() const " --> const GtkSourceLanguage* </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceLanguage.html#ae4f4a88f8ffc71d9d81263038af03fbf">gobj</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3fcfc805f708a12a17491d0d20d3f045"></a><!-- doxytag: member="gtksourceview::SourceLanguage::gobj_copy" ref="a3fcfc805f708a12a17491d0d20d3f045" args="()" --> GtkSourceLanguage* </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceLanguage.html#a3fcfc805f708a12a17491d0d20d3f045">gobj_copy</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceLanguage.html#a015b63badf64e582cd5cee3bccb301bc">get_id</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the ID of a language. <a href="#a015b63badf64e582cd5cee3bccb301bc"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceLanguage.html#a61a765f022102d85b1a22c494c880c7b">get_name</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the localized name of the language. <a href="#a61a765f022102d85b1a22c494c880c7b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceLanguage.html#af0ae3b5ba93a6e96310e15c8dfb8eb36">get_section</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the localized section of the language. <a href="#af0ae3b5ba93a6e96310e15c8dfb8eb36"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">gboolean </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceLanguage.html#a00cde74a959f7f0a5338a25e61a3869a">get_hidden</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the language should be hidden from the user. <a href="#a00cde74a959f7f0a5338a25e61a3869a"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/group__ContHandles.html#ga8e243b697be740f5f7d4b578ae50db41">Glib::StringArrayHandle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceLanguage.html#a9bb0d1af484fe63eca4a54757e6aeaaf">get_mime_types</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the mime types associated to this language. <a href="#a9bb0d1af484fe63eca4a54757e6aeaaf"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/group__ContHandles.html#ga8e243b697be740f5f7d4b578ae50db41">Glib::StringArrayHandle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceLanguage.html#a5adbeca8e4286e22bd85c61f15f749b2">get_globs</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the globs associated to this language. <a href="#a5adbeca8e4286e22bd85c61f15f749b2"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/group__ContHandles.html#ga8e243b697be740f5f7d4b578ae50db41">Glib::StringArrayHandle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceLanguage.html#ad2b747d854e466847792893d37ea5720">get_style_ids</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the ids of the styles defined by this language. <a href="#ad2b747d854e466847792893d37ea5720"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceLanguage.html#ad4c576c2cd58206f4c0436eb5c186b31">get_style_name</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& style_id) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the style with ID <em>style_id</em> defined by this language. <a href="#ad4c576c2cd58206f4c0436eb5c186b31"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceLanguage.html#ad618911c7f377f31a62b1e24e670d9b1">get_metadata</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& name) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns metadata of a language. <a href="#ad618911c7f377f31a62b1e24e670d9b1"></a><br/></td></tr> <tr><td colspan="2"><h2><a name="related"></a> Related Functions</h2></td></tr> <tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p> </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><br class="typebreak"/> < <a class="el" href="classgtksourceview_1_1SourceLanguage.html">gtksourceview::SourceLanguage</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceLanguage.html#ae11dacbb731f6f145b06c64a74194760">wrap</a> (GtkSourceLanguage* object, bool take_copy=false)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#ae11dacbb731f6f145b06c64a74194760"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Object representing a syntax highlighted language. </p> <p><a class="el" href="classgtksourceview_1_1SourceLanguage.html" title="Object representing a syntax highlighted language.">SourceLanguage</a> encapsulates syntax and highlighting styles for a particular language. Use <a class="el" href="classgtksourceview_1_1SourceLanguageManager.html" title="Class which provides access to SourceLanguages.">SourceLanguageManager</a> to obtain a <a class="el" href="classgtksourceview_1_1SourceLanguage.html" title="Object representing a syntax highlighted language.">SourceLanguage</a> instance, and <a class="el" href="classgtksourceview_1_1SourceBuffer.html#aa71e89d8a148cf0667e36295b0431d14" title="Associate a SourceLanguage with the source buffer.">SourceBuffer::set_language()</a> to apply it to a <a class="el" href="classgtksourceview_1_1SourceBuffer.html" title="Buffer object for SourceView.">SourceBuffer</a>. </p> </div><hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a5adbeca8e4286e22bd85c61f15f749b2"></a><!-- doxytag: member="gtksourceview::SourceLanguage::get_globs" ref="a5adbeca8e4286e22bd85c61f15f749b2" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/group__ContHandles.html#ga8e243b697be740f5f7d4b578ae50db41">Glib::StringArrayHandle</a> gtksourceview::SourceLanguage::get_globs </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns the globs associated to this language. </p> <p>This is just a utility wrapper around <a class="el" href="classgtksourceview_1_1SourceLanguage.html#ad618911c7f377f31a62b1e24e670d9b1" title="Returns metadata of a language.">get_metadata()</a> to retrieve the "globs" metadata property and split it into an array.</p> <dl class="return"><dt><b>Returns:</b></dt><dd>An array containing the globs. </dd></dl> </div> </div> <a class="anchor" id="a00cde74a959f7f0a5338a25e61a3869a"></a><!-- doxytag: member="gtksourceview::SourceLanguage::get_hidden" ref="a00cde74a959f7f0a5338a25e61a3869a" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gboolean gtksourceview::SourceLanguage::get_hidden </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns whether the language should be hidden from the user. </p> <dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the language should be hidden, <code>false</code> otherwise. </dd></dl> </div> </div> <a class="anchor" id="a015b63badf64e582cd5cee3bccb301bc"></a><!-- doxytag: member="gtksourceview::SourceLanguage::get_id" ref="a015b63badf64e582cd5cee3bccb301bc" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> gtksourceview::SourceLanguage::get_id </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns the ID of a language. </p> <p>The ID is not locale-dependent.</p> <dl class="return"><dt><b>Returns:</b></dt><dd>The ID of a language. </dd></dl> </div> </div> <a class="anchor" id="ad618911c7f377f31a62b1e24e670d9b1"></a><!-- doxytag: member="gtksourceview::SourceLanguage::get_metadata" ref="ad618911c7f377f31a62b1e24e670d9b1" args="(const Glib::ustring &name) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> gtksourceview::SourceLanguage::get_metadata </td> <td>(</td> <td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td> <td class="paramname"><em>name</em></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns metadata of a language. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">name</td><td>Metadata property name.</td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>Value of property <em>name</em> stored in the metadata of language or empty string if language doesn't contain that metadata property. </dd></dl> </div> </div> <a class="anchor" id="a9bb0d1af484fe63eca4a54757e6aeaaf"></a><!-- doxytag: member="gtksourceview::SourceLanguage::get_mime_types" ref="a9bb0d1af484fe63eca4a54757e6aeaaf" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/group__ContHandles.html#ga8e243b697be740f5f7d4b578ae50db41">Glib::StringArrayHandle</a> gtksourceview::SourceLanguage::get_mime_types </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns the mime types associated to this language. </p> <p>This is just a utility wrapper around <a class="el" href="classgtksourceview_1_1SourceLanguage.html#ad618911c7f377f31a62b1e24e670d9b1" title="Returns metadata of a language.">get_metadata()</a> to retrieve the "mimetypes" metadata property and split it into an array.</p> <dl class="return"><dt><b>Returns:</b></dt><dd>An array containing the mime types. </dd></dl> </div> </div> <a class="anchor" id="a61a765f022102d85b1a22c494c880c7b"></a><!-- doxytag: member="gtksourceview::SourceLanguage::get_name" ref="a61a765f022102d85b1a22c494c880c7b" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> gtksourceview::SourceLanguage::get_name </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns the localized name of the language. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>The name of a language. </dd></dl> </div> </div> <a class="anchor" id="af0ae3b5ba93a6e96310e15c8dfb8eb36"></a><!-- doxytag: member="gtksourceview::SourceLanguage::get_section" ref="af0ae3b5ba93a6e96310e15c8dfb8eb36" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> gtksourceview::SourceLanguage::get_section </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns the localized section of the language. </p> <p>Each language belong to a section (ex. HTML belogs to the Markup section).</p> <dl class="return"><dt><b>Returns:</b></dt><dd>The section of a language. </dd></dl> </div> </div> <a class="anchor" id="ad2b747d854e466847792893d37ea5720"></a><!-- doxytag: member="gtksourceview::SourceLanguage::get_style_ids" ref="ad2b747d854e466847792893d37ea5720" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/group__ContHandles.html#ga8e243b697be740f5f7d4b578ae50db41">Glib::StringArrayHandle</a> gtksourceview::SourceLanguage::get_style_ids </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns the ids of the styles defined by this language. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>An array containing ids of the styles defined by this language. </dd></dl> </div> </div> <a class="anchor" id="ad4c576c2cd58206f4c0436eb5c186b31"></a><!-- doxytag: member="gtksourceview::SourceLanguage::get_style_name" ref="ad4c576c2cd58206f4c0436eb5c186b31" args="(const Glib::ustring &style_id) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> gtksourceview::SourceLanguage::get_style_name </td> <td>(</td> <td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td> <td class="paramname"><em>style_id</em></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns the name of the style with ID <em>style_id</em> defined by this language. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">style_id</td><td>A style ID.</td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>The name of the style with ID <em>style_id</em> defined by this language or empty string if the style has no name or there is no style with ID <em>style_id</em> defined by this language. </dd></dl> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="ae11dacbb731f6f145b06c64a74194760"></a><!-- doxytag: member="gtksourceview::SourceLanguage::wrap" ref="ae11dacbb731f6f145b06c64a74194760" args="(GtkSourceLanguage *object, bool take_copy=false)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classgtksourceview_1_1SourceLanguage.html">gtksourceview::SourceLanguage</a> > wrap </td> <td>(</td> <td class="paramtype">GtkSourceLanguage * </td> <td class="paramname"><em>object</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>take_copy</em> = <code>false</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [related]</code></td> </tr> </table> </div> <div class="memdoc"> <p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">object</td><td>The C instance. </td></tr> <tr><td class="paramname">take_copy</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl> </div> </div> </div> <hr class="footer"/><address class="footer"><small> Generated on Tue May 15 2012 21:27:04 for gtksourceviewmm by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.7.5 </small></address> </body> </html>