<!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::SourceStyleScheme Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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 class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><b>gtksourceview</b>::<a class="el" href="classgtksourceview_1_1SourceStyleScheme.html">SourceStyleScheme</a>
</div>
</div>
<div class="contents">
<h1>gtksourceview::SourceStyleScheme Class Reference</h1><!-- doxytag: class="gtksourceview::SourceStyleScheme" --><!-- doxytag: inherits="Glib::Interface" -->
<p>Object controlling apperance of <a class="el" href="classgtksourceview_1_1SourceView.html" title="The view object.">SourceView</a>. <a href="#_details">More...</a></p>
<p><code>#include <gtksourceviewmm/sourcestylescheme.h></code></p>
<div class="dynheader">
Inheritance diagram for gtksourceview::SourceStyleScheme:</div>
<div class="dynsection">
<div class="center"><img src="classgtksourceview_1_1SourceStyleScheme__inherit__graph.png" border="0" usemap="#gtksourceview_1_1SourceStyleScheme_inherit__map" alt="Inheritance graph"/></div>
<map name="gtksourceview_1_1SourceStyleScheme_inherit__map" id="gtksourceview_1_1SourceStyleScheme_inherit__map">
<area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="79,160,196,189"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="69,83,205,112"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="77,5,197,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgtksourceview_1_1SourceStyleScheme-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a91a0f4da18127580d020bdf8d9b8737e"></a><!-- doxytag: member="gtksourceview::SourceStyleScheme::gobj" ref="a91a0f4da18127580d020bdf8d9b8737e" args="()" -->
GtkSourceStyleScheme* </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceStyleScheme.html#a91a0f4da18127580d020bdf8d9b8737e">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="aebae2e9927157f035c517d98431a6f0d"></a><!-- doxytag: member="gtksourceview::SourceStyleScheme::gobj" ref="aebae2e9927157f035c517d98431a6f0d" args="() const " -->
const GtkSourceStyleScheme* </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceStyleScheme.html#aebae2e9927157f035c517d98431a6f0d">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="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_1SourceStyleScheme.html#a4003310eb71d1a182a5fbf708fe560d4">get_id</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets scheme id. <a href="#a4003310eb71d1a182a5fbf708fe560d4"></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_1SourceStyleScheme.html#a71b0f33d327d1f546a966d9a86bda241">get_name</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets scheme name. <a href="#a71b0f33d327d1f546a966d9a86bda241"></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_1SourceStyleScheme.html#ac82250b45415172be892db44cd5f550b">get_description</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets scheme description. <a href="#ac82250b45415172be892db44cd5f550b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ArrayHandle.html">Glib::StringArrayHandle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceStyleScheme.html#af2d25e178b726ce96189a83bfa454715">get_authors</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets scheme authors. <a href="#af2d25e178b726ce96189a83bfa454715"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01203.html#ga32db3d9898c44d3b3a578b560f7758cc">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceStyleScheme.html#a21ae1d383bee638ef7ff324dcd8c3287">get_filename</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets scheme filename. <a href="#a21ae1d383bee638ef7ff324dcd8c3287"></a><br/></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>< <a class="el" href="classgtksourceview_1_1SourceStyle.html">SourceStyle</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceStyleScheme.html#a26b8b890c46dcdb76d267cc8eda49dc0">get_style</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& style_id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets style corresponding to <em>style_id</em> in scheme. <a href="#a26b8b890c46dcdb76d267cc8eda49dc0"></a><br/></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>< const <a class="el" href="classgtksourceview_1_1SourceStyle.html">SourceStyle</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceStyleScheme.html#a05f6362e58c16ae024e44807096ae596">get_style</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">Gets style corresponding to <em>style_id</em> in scheme. <a href="#a05f6362e58c16ae024e44807096ae596"></a><br/></td></tr>
<tr><td colspan="2"><h2>Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/><br/></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_1SourceStyleScheme.html">gtksourceview::SourceStyleScheme</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceStyleScheme.html#a7585b7341e9db0c82de0e967058f66d4">wrap</a> (GtkSourceStyleScheme* 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="#a7585b7341e9db0c82de0e967058f66d4"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Object controlling apperance of <a class="el" href="classgtksourceview_1_1SourceView.html" title="The view object.">SourceView</a>. </p>
<p><a class="el" href="classgtksourceview_1_1SourceStyleScheme.html" title="Object controlling apperance of SourceView.">SourceStyleScheme</a> contains all the text styles to be used in <a class="el" href="classgtksourceview_1_1SourceView.html" title="The view object.">SourceView</a> and <a class="el" href="classgtksourceview_1_1SourceBuffer.html" title="Buffer object for SourceView.">SourceBuffer</a>. For instance, it contains text styles for syntax highlighting, it may contain foreground and background color for non-highlighted text, color for the line numbers, etc.</p>
<p>Style schemes are stored in XML files. The format of a scheme file is the documented in the C library gtksourceview documentation.</p>
<dl class="since_2_2"><dt><b><a class="el" href="since__2__2.html#_since_2_2000012">Since gtksourceviewmm 2.2:</a></b></dt><dd></dd></dl>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af2d25e178b726ce96189a83bfa454715"></a><!-- doxytag: member="gtksourceview::SourceStyleScheme::get_authors" ref="af2d25e178b726ce96189a83bfa454715" 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_1ArrayHandle.html">Glib::StringArrayHandle</a> gtksourceview::SourceStyleScheme::get_authors </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets scheme authors. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Array with scheme authors.</dd></dl>
<dl class="since_2_2"><dt><b><a class="el" href="since__2__2.html#_since_2_2000016">Since gtksourceviewmm 2.2:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="ac82250b45415172be892db44cd5f550b"></a><!-- doxytag: member="gtksourceview::SourceStyleScheme::get_description" ref="ac82250b45415172be892db44cd5f550b" 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::SourceStyleScheme::get_description </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets scheme description. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Scheme description.</dd></dl>
<dl class="since_2_2"><dt><b><a class="el" href="since__2__2.html#_since_2_2000015">Since gtksourceviewmm 2.2:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a21ae1d383bee638ef7ff324dcd8c3287"></a><!-- doxytag: member="gtksourceview::SourceStyleScheme::get_filename" ref="a21ae1d383bee638ef7ff324dcd8c3287" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01203.html#ga32db3d9898c44d3b3a578b560f7758cc">std::string</a> gtksourceview::SourceStyleScheme::get_filename </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets scheme filename. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Scheme file name if the scheme was created parsing a style scheme file or empty string in the other cases.</dd></dl>
<dl class="since_2_2"><dt><b><a class="el" href="since__2__2.html#_since_2_2000017">Since gtksourceviewmm 2.2:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a4003310eb71d1a182a5fbf708fe560d4"></a><!-- doxytag: member="gtksourceview::SourceStyleScheme::get_id" ref="a4003310eb71d1a182a5fbf708fe560d4" 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::SourceStyleScheme::get_id </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets scheme id. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Scheme id.</dd></dl>
<dl class="since_2_2"><dt><b><a class="el" href="since__2__2.html#_since_2_2000013">Since gtksourceviewmm 2.2:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a71b0f33d327d1f546a966d9a86bda241"></a><!-- doxytag: member="gtksourceview::SourceStyleScheme::get_name" ref="a71b0f33d327d1f546a966d9a86bda241" 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::SourceStyleScheme::get_name </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets scheme name. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Scheme name.</dd></dl>
<dl class="since_2_2"><dt><b><a class="el" href="since__2__2.html#_since_2_2000014">Since gtksourceviewmm 2.2:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a05f6362e58c16ae024e44807096ae596"></a><!-- doxytag: member="gtksourceview::SourceStyleScheme::get_style" ref="a05f6362e58c16ae024e44807096ae596" 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_1RefPtr.html">Glib::RefPtr</a><const <a class="el" href="classgtksourceview_1_1SourceStyle.html">SourceStyle</a>> gtksourceview::SourceStyleScheme::get_style </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>Gets style corresponding to <em>style_id</em> in scheme. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>style_id</em> </td><td>Id of the style to retrieve.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Style which corresponds to <em>style_id</em> in the scheme, or empty <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a> when no style with this name found.</dd></dl>
<dl class="since_2_2"><dt><b><a class="el" href="since__2__2.html#_since_2_2000019">Since gtksourceviewmm 2.2:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a26b8b890c46dcdb76d267cc8eda49dc0"></a><!-- doxytag: member="gtksourceview::SourceStyleScheme::get_style" ref="a26b8b890c46dcdb76d267cc8eda49dc0" args="(const Glib::ustring &style_id)" -->
<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_1SourceStyle.html">SourceStyle</a>> gtksourceview::SourceStyleScheme::get_style </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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets style corresponding to <em>style_id</em> in scheme. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>style_id</em> </td><td>Id of the style to retrieve.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Style which corresponds to <em>style_id</em> in the scheme, or empty <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a> when no style with this name found.</dd></dl>
<dl class="since_2_2"><dt><b><a class="el" href="since__2__2.html#_since_2_2000018">Since gtksourceviewmm 2.2:</a></b></dt><dd></dd></dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a7585b7341e9db0c82de0e967058f66d4"></a><!-- doxytag: member="gtksourceview::SourceStyleScheme::wrap" ref="a7585b7341e9db0c82de0e967058f66d4" args="(GtkSourceStyleScheme *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_1SourceStyleScheme.html">gtksourceview::SourceStyleScheme</a> > wrap </td>
<td>(</td>
<td class="paramtype">GtkSourceStyleScheme * </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><td> </td>
</tr>
<tr>
<td></td>
<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 border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>take_copy</em> </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 style="text-align: right;"><small>Generated by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>
