<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkSourceMark: GtkSourceView 3 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GtkSourceView 3 Reference Manual">
<link rel="up" href="ch06.html" title="Gutter and Marks">
<link rel="prev" href="GtkSourceGutterRendererText.html" title="GtkSourceGutterRendererText">
<link rel="next" href="GtkSourceMarkAttributes.html" title="GtkSourceMarkAttributes">
<meta name="generator" content="GTK-Doc V1.28.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GtkSourceMark.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GtkSourceMark.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GtkSourceMark.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch06.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkSourceGutterRendererText.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkSourceMarkAttributes.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkSourceMark"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkSourceMark.top_of_page"></a>GtkSourceMark</span></h2>
<p>GtkSourceMark — Mark object for GtkSourceBuffer</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkSourceMark.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="returnvalue">GtkSourceMark</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkSourceMark.html#gtk-source-mark-new" title="gtk_source_mark_new ()">gtk_source_mark_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="GtkSourceMark.html#gtk-source-mark-get-category" title="gtk_source_mark_get_category ()">gtk_source_mark_get_category</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="returnvalue">GtkSourceMark</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkSourceMark.html#gtk-source-mark-next" title="gtk_source_mark_next ()">gtk_source_mark_next</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="returnvalue">GtkSourceMark</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkSourceMark.html#gtk-source-mark-prev" title="gtk_source_mark_prev ()">gtk_source_mark_prev</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSourceMark.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="GtkSourceMark.html#GtkSourceMark--category" title="The “category” property">category</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSourceMark.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GtkSourceMark.html#GtkSourceMark-struct" title="GtkSourceMark">GtkSourceMark</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSourceMark.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GtkTextMark
<span class="lineart">╰──</span> GtkSourceMark
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceMark.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <gtksourceview/gtksource.h>
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceMark.description"></a><h2>Description</h2>
<p>A <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> marks a position in the text where you want to display
additional info. It is based on <span class="type">GtkTextMark</span> and thus is still valid after
the text has changed though its position may change.</p>
<p><a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a>s are organised in categories which you have to set
when you create the mark. Each category can have a priority, a pixbuf and
other associated attributes. See <a class="link" href="GtkSourceView.html#gtk-source-view-set-mark-attributes" title="gtk_source_view_set_mark_attributes ()"><code class="function">gtk_source_view_set_mark_attributes()</code></a>.
The pixbuf will be displayed in the margin at the line where the mark
residents if the <a class="link" href="GtkSourceView.html#GtkSourceView--show-line-marks" title="The “show-line-marks” property"><span class="type">“show-line-marks”</span></a> property is set to <code class="literal">TRUE</code>. If
there are multiple marks in the same line, the pixbufs will be drawn on top
of each other. The mark with the highest priority will be drawn on top.</p>
</div>
<div class="refsect1">
<a name="GtkSourceMark.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-source-mark-new"></a><h3>gtk_source_mark_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="returnvalue">GtkSourceMark</span></a> *
gtk_source_mark_new (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *category</code></em>);</pre>
<p>Creates a text mark. Add it to a buffer using <code class="function">gtk_text_buffer_add_mark()</code>.
If name is NULL, the mark is anonymous; otherwise, the mark can be retrieved
by name using <code class="function">gtk_text_buffer_get_mark()</code>.
Normally marks are created using the utility function
<a class="link" href="GtkSourceBuffer.html#gtk-source-buffer-create-source-mark" title="gtk_source_buffer_create_source_mark ()"><code class="function">gtk_source_buffer_create_source_mark()</code></a>.</p>
<div class="refsect3">
<a name="gtk-source-mark-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>Name of the <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a>, can be NULL when not using a name</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>category</p></td>
<td class="parameter_description"><p>is used to classify marks according to common characteristics
(e.g. all the marks representing a bookmark could belong to the "bookmark"
category, or all the marks representing a compilation error could belong to
"error" category).</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-source-mark-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> that can be added using <code class="function">gtk_text_buffer_add_mark()</code>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-mark-get-category"></a><h3>gtk_source_mark_get_category ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
gtk_source_mark_get_category (<em class="parameter"><code><a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> *mark</code></em>);</pre>
<p>Returns the mark category.</p>
<div class="refsect3">
<a name="gtk-source-mark-get-category.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>mark</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-source-mark-get-category.returns"></a><h4>Returns</h4>
<p> the category of the <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-mark-next"></a><h3>gtk_source_mark_next ()</h3>
<pre class="programlisting"><a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="returnvalue">GtkSourceMark</span></a> *
gtk_source_mark_next (<em class="parameter"><code><a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> *mark</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *category</code></em>);</pre>
<p>Returns the next <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> in the buffer or <code class="literal">NULL</code> if the mark
was not added to a buffer. If there is no next mark, <code class="literal">NULL</code> will be returned.</p>
<p>If <em class="parameter"><code>category</code></em>
is <code class="literal">NULL</code>, looks for marks of any category.</p>
<div class="refsect3">
<a name="gtk-source-mark-next.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>mark</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>category</p></td>
<td class="parameter_description"><p>a string specifying the mark category, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-source-mark-next.returns"></a><h4>Returns</h4>
<p>the next <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a>, or <code class="literal">NULL</code>. </p>
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-mark-prev"></a><h3>gtk_source_mark_prev ()</h3>
<pre class="programlisting"><a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="returnvalue">GtkSourceMark</span></a> *
gtk_source_mark_prev (<em class="parameter"><code><a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> *mark</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *category</code></em>);</pre>
<p>Returns the previous <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> in the buffer or <code class="literal">NULL</code> if the mark
was not added to a buffer. If there is no previous mark, <code class="literal">NULL</code> is returned.</p>
<p>If <em class="parameter"><code>category</code></em>
is <code class="literal">NULL</code>, looks for marks of any category</p>
<div class="refsect3">
<a name="gtk-source-mark-prev.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>mark</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>category</p></td>
<td class="parameter_description"><p>a string specifying the mark category, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-source-mark-prev.returns"></a><h4>Returns</h4>
<p>the previous <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a>, or <code class="literal">NULL</code>. </p>
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceMark.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkSourceMark-struct"></a><h3>GtkSourceMark</h3>
<pre class="programlisting">typedef struct _GtkSourceMark GtkSourceMark;</pre>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceMark.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkSourceMark--category"></a><h3>The <code class="literal">“category”</code> property</h3>
<pre class="programlisting"> “category” <span class="type">gchar</span> *</pre>
<p>The category of the <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a>, classifies the mark and controls
which pixbuf is used and with which priority it is drawn.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceMark.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GtkSourceBuffer.html" title="GtkSourceBuffer"><span class="type">GtkSourceBuffer</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28.1</div>
</body>
</html>