<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>libgtksourceviewmm: gtksourceview::SourceTag Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="namespacegtksourceview.html">gtksourceview</a>::<a class="el" href="classgtksourceview_1_1SourceTag.html">SourceTag</a></div>
<h1>gtksourceview::SourceTag Class Reference</h1><!-- doxytag: class="gtksourceview::SourceTag" -->An attribute that can be applied to a range of text.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="sourcetag_8h-source.html">sourcetag.h</a>></code>
<p>
<a href="classgtksourceview_1_1SourceTag-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classgtksourceview_1_1SourceTag.html">SourceTag</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceTag.html#0f0f818528b51afaf5af3b0f50474b3d">CppObjectType</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef SourceTag_Class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceTag.html#42adf4db5976df09b1dfb577f05ffe23">CppClassType</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="sourcetag_8h.html#cbc1638a8b19b42dfc026827559aa0c1">GtkSourceTag</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceTag.html#a05aef745d16fcbfd1b15285bf541665">BaseObjectType</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="sourcetag_8h.html#ab05e8c40c39182bd0b63451fe853d8e">GtkSourceTagClass</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceTag.html#d38bb477ede095da0451770c617a0d3c">BaseClassType</a></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceTag.html#9fdcbdc0aadff86bd9b3f4ec74b1e6f2">~SourceTag</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sourcetag_8h.html#cbc1638a8b19b42dfc026827559aa0c1">GtkSourceTag</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceTag.html#0669c4e6e37ca327d65da5cec26b7d6f">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#0669c4e6e37ca327d65da5cec26b7d6f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="sourcetag_8h.html#cbc1638a8b19b42dfc026827559aa0c1">GtkSourceTag</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceTag.html#141c75f715c0fdd7296ba1652721951d">gobj</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#141c75f715c0fdd7296ba1652721951d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sourcetag_8h.html#cbc1638a8b19b42dfc026827559aa0c1">GtkSourceTag</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceTag.html#ae374c479aea9d3c9b7e60ee3a771b05">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. <a href="#ae374c479aea9d3c9b7e60ee3a771b05"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">Glib::ustring </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceTag.html#997d3549c3b7ae4fc0918da9dbfcbde5">get_id</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">getter of the tag ID. <a href="#997d3549c3b7ae4fc0918da9dbfcbde5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classgtksourceview_1_1SourceTagStyle.html">SourceTagStyle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceTag.html#c5fd77085d2a43eb416458249d1f46d9">get_style</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">getter of the tag style. <a href="#c5fd77085d2a43eb416458249d1f46d9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceTag.html#8456a44ffc267736980eb02999f8e5d0">set_style</a> (const <a class="el" href="classgtksourceview_1_1SourceTagStyle.html">SourceTagStyle</a> &a_style)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">setter of the tag style. <a href="#8456a44ffc267736980eb02999f8e5d0"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static GType </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceTag.html#8f57853e084e28e221a0d93e02f5330b">get_type</a> () G_GNUC_CONST</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static GType </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceTag.html#67eebfbeb08234dfdb7db714a5c6df68">get_base_type</a> () G_GNUC_CONST</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static Glib::RefPtr< <a class="el" href="classgtksourceview_1_1SourceTag.html">SourceTag</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceTag.html#d214f07db6b1f6b507dc38de82e5e70f">create_syntax_tag</a> (const Glib::ustring &a_id, const Glib::ustring &a_name, const Glib::ustring &a_pat_start, const Glib::ustring &a_pat_end)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">create a syntax tag. <a href="#d214f07db6b1f6b507dc38de82e5e70f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static Glib::RefPtr< <a class="el" href="classgtksourceview_1_1SourceTag.html">SourceTag</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceTag.html#8ded6351f67bc6941c19625c3ebbfee1">create_pattern_tag</a> (const Glib::ustring &a_id, const Glib::ustring &a_name, const Glib::ustring &a_pattern)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">create a pattern tag. <a href="#8ded6351f67bc6941c19625c3ebbfee1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static Glib::RefPtr< <a class="el" href="classgtksourceview_1_1SourceTag.html">SourceTag</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceTag.html#4ca609d34d194d26412104059d9cae5b">create_keyword_list_tag</a> (const Glib::ustring &a_id, const Glib::ustring &a_name, const Glib::SListHandle< const Glib::ustring > &a_keywords, bool a_case_sensitive=true, bool a_match_empty_string_at_beginning=true, bool a_match_empty_string_at_end=true, const Glib::ustring &a_beginning_regex="", const Glib::ustring &a_end_regex="")</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">create a tag for a list of keywords. <a href="#4ca609d34d194d26412104059d9cae5b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static Glib::RefPtr< <a class="el" href="classgtksourceview_1_1SourceTag.html">SourceTag</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceTag.html#aa06b32ac1b857935741a9cf27728269">create_line_comment_tag_new</a> (const Glib::ustring &a_id, const Glib::ustring &a_name, const Glib::ustring &a_pattern_start)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">create a tag for a comment. <a href="#aa06b32ac1b857935741a9cf27728269"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static Glib::RefPtr< <a class="el" href="classgtksourceview_1_1SourceTag.html">SourceTag</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceTag.html#18569e69f4458c7affe7839fbab9adc6">create_string_tag_new</a> (const Glib::ustring &a_id, const Glib::ustring &a_name, const Glib::ustring &a_pattern_start, const Glib::ustring &a_pattern_end, bool a_end_at_line_end=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">create a tag for a string delimited by two patterns. <a href="#18569e69f4458c7affe7839fbab9adc6"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceTag.html#3d53a2912affe28a60d2dc0335de9686">SourceTag</a> (const Glib::ConstructParams &construct_params)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceTag.html#46ba17c2515f1c3cf76fa86fc1269ce9">SourceTag</a> (<a class="el" href="sourcetag_8h.html#cbc1638a8b19b42dfc026827559aa0c1">GtkSourceTag</a> *castitem)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceTag.html#01f5a3de29531b738e112f790ca572e5">SourceTag</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceTag.html#f314b4e1b81a8f54420df2bc460a6b3c">SourceTag_Class</a></td></tr>
<tr><td colspan="2"><br><h2>Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">Glib::RefPtr< <a class="el" href="classgtksourceview_1_1SourceTag.html">gtksourceview::SourceTag</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceTag.html#c94fb8eea91f26c2c840115a3fd48b14">wrap</a> (<a class="el" href="sourcetag_8h.html#cbc1638a8b19b42dfc026827559aa0c1">GtkSourceTag</a> *object, bool take_copy=false)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An attribute that can be applied to a range of text.
<p>
A tag is a an attribute that can be applied to a range of text One can associate style information to a given Tag. For example, a tag might be called "bold" and might make the text inside the tag bold. GtkSourceView uses <a class="el" href="classgtksourceview_1_1SourceTag.html">SourceTag</a> to perform syntax highlighting.
<p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="0f0f818528b51afaf5af3b0f50474b3d"></a><!-- doxytag: member="gtksourceview::SourceTag::CppObjectType" ref="0f0f818528b51afaf5af3b0f50474b3d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classgtksourceview_1_1SourceTag.html">SourceTag</a> <a class="el" href="classgtksourceview_1_1SourceTag.html">gtksourceview::SourceTag::CppObjectType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="42adf4db5976df09b1dfb577f05ffe23"></a><!-- doxytag: member="gtksourceview::SourceTag::CppClassType" ref="42adf4db5976df09b1dfb577f05ffe23" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef SourceTag_Class <a class="el" href="classgtksourceview_1_1SourceTag.html#42adf4db5976df09b1dfb577f05ffe23">gtksourceview::SourceTag::CppClassType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="a05aef745d16fcbfd1b15285bf541665"></a><!-- doxytag: member="gtksourceview::SourceTag::BaseObjectType" ref="a05aef745d16fcbfd1b15285bf541665" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="sourcetag_8h.html#cbc1638a8b19b42dfc026827559aa0c1">GtkSourceTag</a> <a class="el" href="classgtksourceview_1_1SourceTag.html#a05aef745d16fcbfd1b15285bf541665">gtksourceview::SourceTag::BaseObjectType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="d38bb477ede095da0451770c617a0d3c"></a><!-- doxytag: member="gtksourceview::SourceTag::BaseClassType" ref="d38bb477ede095da0451770c617a0d3c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="sourcetag_8h.html#ab05e8c40c39182bd0b63451fe853d8e">GtkSourceTagClass</a> <a class="el" href="classgtksourceview_1_1SourceTag.html#d38bb477ede095da0451770c617a0d3c">gtksourceview::SourceTag::BaseClassType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="3d53a2912affe28a60d2dc0335de9686"></a><!-- doxytag: member="gtksourceview::SourceTag::SourceTag" ref="3d53a2912affe28a60d2dc0335de9686" args="(const Glib::ConstructParams &construct_params)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gtksourceview::SourceTag::SourceTag </td>
<td>(</td>
<td class="paramtype">const Glib::ConstructParams & </td>
<td class="paramname"> <em>construct_params</em> </td>
<td> ) </td>
<td width="100%"><code> [explicit, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="46ba17c2515f1c3cf76fa86fc1269ce9"></a><!-- doxytag: member="gtksourceview::SourceTag::SourceTag" ref="46ba17c2515f1c3cf76fa86fc1269ce9" args="(GtkSourceTag *castitem)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gtksourceview::SourceTag::SourceTag </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sourcetag_8h.html#cbc1638a8b19b42dfc026827559aa0c1">GtkSourceTag</a> * </td>
<td class="paramname"> <em>castitem</em> </td>
<td> ) </td>
<td width="100%"><code> [explicit, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="9fdcbdc0aadff86bd9b3f4ec74b1e6f2"></a><!-- doxytag: member="gtksourceview::SourceTag::~SourceTag" ref="9fdcbdc0aadff86bd9b3f4ec74b1e6f2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual gtksourceview::SourceTag::~SourceTag </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="01f5a3de29531b738e112f790ca572e5"></a><!-- doxytag: member="gtksourceview::SourceTag::SourceTag" ref="01f5a3de29531b738e112f790ca572e5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gtksourceview::SourceTag::SourceTag </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="8f57853e084e28e221a0d93e02f5330b"></a><!-- doxytag: member="gtksourceview::SourceTag::get_type" ref="8f57853e084e28e221a0d93e02f5330b" args="() G_GNUC_CONST" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static GType gtksourceview::SourceTag::get_type </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="67eebfbeb08234dfdb7db714a5c6df68"></a><!-- doxytag: member="gtksourceview::SourceTag::get_base_type" ref="67eebfbeb08234dfdb7db714a5c6df68" args="() G_GNUC_CONST" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static GType gtksourceview::SourceTag::get_base_type </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="0669c4e6e37ca327d65da5cec26b7d6f"></a><!-- doxytag: member="gtksourceview::SourceTag::gobj" ref="0669c4e6e37ca327d65da5cec26b7d6f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sourcetag_8h.html#cbc1638a8b19b42dfc026827559aa0c1">GtkSourceTag</a>* gtksourceview::SourceTag::gobj </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provides access to the underlying C GObject.
<p>
</div>
</div><p>
<a class="anchor" name="141c75f715c0fdd7296ba1652721951d"></a><!-- doxytag: member="gtksourceview::SourceTag::gobj" ref="141c75f715c0fdd7296ba1652721951d" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="sourcetag_8h.html#cbc1638a8b19b42dfc026827559aa0c1">GtkSourceTag</a>* gtksourceview::SourceTag::gobj </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provides access to the underlying C GObject.
<p>
</div>
</div><p>
<a class="anchor" name="ae374c479aea9d3c9b7e60ee3a771b05"></a><!-- doxytag: member="gtksourceview::SourceTag::gobj_copy" ref="ae374c479aea9d3c9b7e60ee3a771b05" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sourcetag_8h.html#cbc1638a8b19b42dfc026827559aa0c1">GtkSourceTag</a>* gtksourceview::SourceTag::gobj_copy </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
<p>
</div>
</div><p>
<a class="anchor" name="d214f07db6b1f6b507dc38de82e5e70f"></a><!-- doxytag: member="gtksourceview::SourceTag::create_syntax_tag" ref="d214f07db6b1f6b507dc38de82e5e70f" args="(const Glib::ustring &a_id, const Glib::ustring &a_name, const Glib::ustring &a_pat_start, const Glib::ustring &a_pat_end)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static Glib::RefPtr<<a class="el" href="classgtksourceview_1_1SourceTag.html">SourceTag</a>> gtksourceview::SourceTag::create_syntax_tag </td>
<td>(</td>
<td class="paramtype">const Glib::ustring & </td>
<td class="paramname"> <em>a_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Glib::ustring & </td>
<td class="paramname"> <em>a_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Glib::ustring & </td>
<td class="paramname"> <em>a_pat_start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Glib::ustring & </td>
<td class="paramname"> <em>a_pat_end</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
create a syntax tag.
<p>
A syntax tag is a tag that applies to a region of text. The region is identified by a starting pattern and an ending pattern. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>a_id</em> </td><td>the ID of the tag. That ID must be unique accross all the tag IDs. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>a_name</em> </td><td>the name of the tag. Can be translatable. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>a_pat_start</em> </td><td>the regular expression pattern that describes the beginning of the region the tag applied to. See <a class="el" href="patternpage.html">Grammar of SourceTag related patterns</a> for more about the syntax. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>a_pat_end</em> </td><td>the pattern that describes the end of the region. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the newly created <a class="el" href="classgtksourceview_1_1SourceTag.html">SourceTag</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="8ded6351f67bc6941c19625c3ebbfee1"></a><!-- doxytag: member="gtksourceview::SourceTag::create_pattern_tag" ref="8ded6351f67bc6941c19625c3ebbfee1" args="(const Glib::ustring &a_id, const Glib::ustring &a_name, const Glib::ustring &a_pattern)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static Glib::RefPtr<<a class="el" href="classgtksourceview_1_1SourceTag.html">SourceTag</a>> gtksourceview::SourceTag::create_pattern_tag </td>
<td>(</td>
<td class="paramtype">const Glib::ustring & </td>
<td class="paramname"> <em>a_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Glib::ustring & </td>
<td class="paramname"> <em>a_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Glib::ustring & </td>
<td class="paramname"> <em>a_pattern</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
create a pattern tag.
<p>
A pattern tag is a tag that applies to a word (keyword, or term). In this case The word is represented by a regular expression pattern. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>a_id</em> </td><td>the id of the tag. Must be unique accross all the pattter ids. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>a_name</em> </td><td>the name of the tag. Is a translatable string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>a_pattern</em> </td><td>the word pattern. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="4ca609d34d194d26412104059d9cae5b"></a><!-- doxytag: member="gtksourceview::SourceTag::create_keyword_list_tag" ref="4ca609d34d194d26412104059d9cae5b" args="(const Glib::ustring &a_id, const Glib::ustring &a_name, const Glib::SListHandle< const Glib::ustring > &a_keywords, bool a_case_sensitive=true, bool a_match_empty_string_at_beginning=true, bool a_match_empty_string_at_end=true, const Glib::ustring &a_beginning_regex="", const Glib::ustring &a_end_regex="")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static Glib::RefPtr<<a class="el" href="classgtksourceview_1_1SourceTag.html">SourceTag</a>> gtksourceview::SourceTag::create_keyword_list_tag </td>
<td>(</td>
<td class="paramtype">const Glib::ustring & </td>
<td class="paramname"> <em>a_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Glib::ustring & </td>
<td class="paramname"> <em>a_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Glib::SListHandle< const Glib::ustring > & </td>
<td class="paramname"> <em>a_keywords</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>a_case_sensitive</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>a_match_empty_string_at_beginning</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>a_match_empty_string_at_end</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Glib::ustring & </td>
<td class="paramname"> <em>a_beginning_regex</em> = <code>""</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Glib::ustring & </td>
<td class="paramname"> <em>a_end_regex</em> = <code>""</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
create a tag for a list of keywords.
<p>
This is a more user friendly wrapper to <a class="el" href="classgtksourceview_1_1SourceTag.html#8ded6351f67bc6941c19625c3ebbfee1">SourceTag::create_pattern_tag()</a> . <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>a_id</em> </td><td>the ID of the tag. Must be unique accross all tag IDs. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>a_name</em> </td><td>the name of the tag. Can be a translated string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>a_keywords</em> </td><td>the list of keyword the tag applies to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>a_case_sensitive</em> </td><td>wether the tag should match the keywords in a case sentive context or not. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>a_match_empty_string_at_beginning</em> </td><td>whether the tag should match an empty string at the beginning of keywords or not. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>a_match_empty_string_at_end</em> </td><td>wether the tag should match the an empty string at the end of keywords or not. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>a_beginning_regex</em> </td><td>a regex that that describes a pattern that can be present at the beginning of each keyword. If you don't understand what this is, just let it be. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>a_end_regex</em> </td><td>same as a_beginning_regex but applies for a pattern at the end the keywords. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the newly created <a class="el" href="classgtksourceview_1_1SourceTag.html">SourceTag</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="aa06b32ac1b857935741a9cf27728269"></a><!-- doxytag: member="gtksourceview::SourceTag::create_line_comment_tag_new" ref="aa06b32ac1b857935741a9cf27728269" args="(const Glib::ustring &a_id, const Glib::ustring &a_name, const Glib::ustring &a_pattern_start)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static Glib::RefPtr<<a class="el" href="classgtksourceview_1_1SourceTag.html">SourceTag</a>> gtksourceview::SourceTag::create_line_comment_tag_new </td>
<td>(</td>
<td class="paramtype">const Glib::ustring & </td>
<td class="paramname"> <em>a_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Glib::ustring & </td>
<td class="paramname"> <em>a_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Glib::ustring & </td>
<td class="paramname"> <em>a_pattern_start</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
create a tag for a comment.
<p>
This is a user friendly way to create a syntax tag for a one liner comment. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>a_id</em> </td><td>the ID of the of the tag. Must be unique accross all tag IDs. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>a_name</em> </td><td>the name of the tag. Can be a translated string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>a_pattern_start</em> </td><td>the pattern of the beginning of the commented line. the tag will applied to the region located between by a_patter_start and the end of line. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the newly created <a class="el" href="classgtksourceview_1_1SourceTag.html">SourceTag</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="18569e69f4458c7affe7839fbab9adc6"></a><!-- doxytag: member="gtksourceview::SourceTag::create_string_tag_new" ref="18569e69f4458c7affe7839fbab9adc6" args="(const Glib::ustring &a_id, const Glib::ustring &a_name, const Glib::ustring &a_pattern_start, const Glib::ustring &a_pattern_end, bool a_end_at_line_end=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static Glib::RefPtr<<a class="el" href="classgtksourceview_1_1SourceTag.html">SourceTag</a>> gtksourceview::SourceTag::create_string_tag_new </td>
<td>(</td>
<td class="paramtype">const Glib::ustring & </td>
<td class="paramname"> <em>a_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Glib::ustring & </td>
<td class="paramname"> <em>a_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Glib::ustring & </td>
<td class="paramname"> <em>a_pattern_start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Glib::ustring & </td>
<td class="paramname"> <em>a_pattern_end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>a_end_at_line_end</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
create a tag for a string delimited by two patterns.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>a_id</em> </td><td>the ID of the tag. Must be unique accross all tag IDs. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>a_name</em> </td><td>the name of the tag. Can be a translated string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>a_pattern_start</em> </td><td>the starting pattern of the string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>a_pattern_end</em> </td><td>the ending pattern of the string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>a_end_at_line_end</em> </td><td>whether the ending pattern should be suffixed by an end of line character. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="997d3549c3b7ae4fc0918da9dbfcbde5"></a><!-- doxytag: member="gtksourceview::SourceTag::get_id" ref="997d3549c3b7ae4fc0918da9dbfcbde5" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Glib::ustring gtksourceview::SourceTag::get_id </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
getter of the tag ID.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the ID </dd></dl>
</div>
</div><p>
<a class="anchor" name="c5fd77085d2a43eb416458249d1f46d9"></a><!-- doxytag: member="gtksourceview::SourceTag::get_style" ref="c5fd77085d2a43eb416458249d1f46d9" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgtksourceview_1_1SourceTagStyle.html">SourceTagStyle</a> gtksourceview::SourceTag::get_style </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
getter of the tag style.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the style </dd></dl>
</div>
</div><p>
<a class="anchor" name="8456a44ffc267736980eb02999f8e5d0"></a><!-- doxytag: member="gtksourceview::SourceTag::set_style" ref="8456a44ffc267736980eb02999f8e5d0" args="(const SourceTagStyle &a_style)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gtksourceview::SourceTag::set_style </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgtksourceview_1_1SourceTagStyle.html">SourceTagStyle</a> & </td>
<td class="paramname"> <em>a_style</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
setter of the tag style.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>a_style</em> </td><td>the new style </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="f314b4e1b81a8f54420df2bc460a6b3c"></a><!-- doxytag: member="gtksourceview::SourceTag::SourceTag_Class" ref="f314b4e1b81a8f54420df2bc460a6b3c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class SourceTag_Class<code> [friend]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="c94fb8eea91f26c2c840115a3fd48b14"></a><!-- doxytag: member="gtksourceview::SourceTag::wrap" ref="c94fb8eea91f26c2c840115a3fd48b14" args="(GtkSourceTag *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Glib::RefPtr< <a class="el" href="classgtksourceview_1_1SourceTag.html">gtksourceview::SourceTag</a> > wrap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sourcetag_8h.html#cbc1638a8b19b42dfc026827559aa0c1">GtkSourceTag</a> * </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 width="100%"><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><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>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="sourcetag_8h-source.html">sourcetag.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue May 1 21:29:15 2007 for libgtksourceviewmm by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>
