/usr/share/gtk-doc/html/gtksourceview-3.0/GtkSourceMark.html is in libgtksourceview-3.0-doc 3.4.1-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 | <!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</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GtkSourceView 3 Reference Manual">
<link rel="up" href="rn01.html" title="API reference">
<link rel="prev" href="gtksourceview-3.0-GtkSourceGutterRendererPixbuf.html" title="GtkSourceGutterRendererPixbuf">
<link rel="next" href="GtkSourceMarkAttributes.html" title="GtkSourceMarkAttributes">
<meta name="generator" content="GTK-Doc V1.18.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="2">
<tr valign="middle">
<td><a accesskey="p" href="gtksourceview-3.0-GtkSourceGutterRendererPixbuf.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="rn01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GtkSourceView 3 Reference Manual</th>
<td><a accesskey="n" href="GtkSourceMarkAttributes.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GtkSourceMark.synopsis" class="shortcut">Top</a>
|
<a href="#GtkSourceMark.description" class="shortcut">Description</a>
|
<a href="#GtkSourceMark.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GtkSourceMark.properties" class="shortcut">Properties</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 <a class="link" href="GtkSourceBuffer.html" title="GtkSourceBuffer"><span class="type">GtkSourceBuffer</span></a></p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GtkSourceMark.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <gtksourceview/gtksourcemark.h>
struct <a class="link" href="GtkSourceMark.html#GtkSourceMark-struct" title="struct GtkSourceMark">GtkSourceMark</a>;
<a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="returnvalue">GtkSourceMark</span></a> * <a class="link" href="GtkSourceMark.html#gtk-source-mark-new" title="gtk_source_mark_new ()">gtk_source_mark_new</a> (<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>);
const <span class="returnvalue">gchar</span> * <a class="link" href="GtkSourceMark.html#gtk-source-mark-get-category" title="gtk_source_mark_get_category ()">gtk_source_mark_get_category</a> (<em class="parameter"><code><a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a> *mark</code></em>);
<a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="returnvalue">GtkSourceMark</span></a> * <a class="link" href="GtkSourceMark.html#gtk-source-mark-next" title="gtk_source_mark_next ()">gtk_source_mark_next</a> (<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>);
<a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="returnvalue">GtkSourceMark</span></a> * <a class="link" href="GtkSourceMark.html#gtk-source-mark-prev" title="gtk_source_mark_prev ()">gtk_source_mark_prev</a> (<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>
</div>
<div class="refsect1">
<a name="GtkSourceMark.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GtkTextMark
+----GtkSourceMark
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceMark.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GtkSourceMark.html#GtkSourceMark--category" title='The "category" property'>category</a>" <span class="type">gchar</span>* : Read / Write / Construct Only
</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 pixbuf and a priority
associated using <span class="type">gtk_source_view_set_mark_category_pixbuf</span> and
<span class="type">gtk_source_view_set_mark_category_priority</span>. The pixbuf will be displayed in
the margin at the line where the mark residents if the
<span class="type">"show-line-marks"</span> property is set to TRUE. 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.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GtkSourceMark-struct"></a><h3>struct GtkSourceMark</h3>
<pre class="programlisting">struct GtkSourceMark;</pre>
</div>
<hr>
<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
<code class="function">gtk_source_buffer_create_mark()</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>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</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>category</code></em> :</span></p></td>
<td>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).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>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>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.2</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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mark</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the category of the <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.2</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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mark</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>category</code></em> :</span></p></td>
<td>a string specifying the mark category, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the next <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a>, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.2</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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mark</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>category</code></em> :</span></p></td>
<td>a string specifying the mark category, or <code class="literal">NULL</code>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the previous <a class="link" href="GtkSourceMark.html" title="GtkSourceMark"><span class="type">GtkSourceMark</span></a>, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.2</p>
</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>* : Read / Write / Construct Only</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>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceMark.see-also"></a><h2>See Also</h2>
<a class="link" href="GtkSourceBuffer.html" title="GtkSourceBuffer"><span class="type">GtkSourceBuffer</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18.1</div>
</body>
</html>
|