/usr/share/gtk-doc/html/gtksourceview-3.0/GtkSourceMap.html is in libgtksourceview-3.0-doc 3.24.7-1.
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 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkSourceMap: GtkSourceView 3 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GtkSourceView 3 Reference Manual">
<link rel="up" href="ch09.html" title="Other">
<link rel="prev" href="ch09.html" title="Other">
<link rel="next" href="GtkSourceRegion.html" title="GtkSourceRegion">
<meta name="generator" content="GTK-Doc V1.27 (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="#GtkSourceMap.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GtkSourceMap.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GtkSourceMap.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GtkSourceMap.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="ch09.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch09.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkSourceRegion.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkSourceMap"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkSourceMap.top_of_page"></a>GtkSourceMap</span></h2>
<p>GtkSourceMap — Widget that displays a map for a specific <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a></p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkSourceMap.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 href="../gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkSourceMap.html#gtk-source-map-new" title="gtk_source_map_new ()">gtk_source_map_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkSourceMap.html#gtk-source-map-set-view" title="gtk_source_map_set_view ()">gtk_source_map_set_view</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="returnvalue">GtkSourceView</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkSourceMap.html#gtk-source-map-get-view" title="gtk_source_map_get_view ()">gtk_source_map_get_view</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSourceMap.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">
<a href="../pango/pango-Fonts.html#PangoFontDescription-struct"><span class="type">PangoFontDescription</span></a> *</td>
<td class="property_name"><a class="link" href="GtkSourceMap.html#GtkSourceMap--font-desc" title="The “font-desc” property">font-desc</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a> *</td>
<td class="property_name"><a class="link" href="GtkSourceMap.html#GtkSourceMap--view" title="The “view” property">view</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSourceMap.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="GtkSourceMap.html#GtkSourceMap-struct" title="GtkSourceMap">GtkSourceMap</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSourceMap.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
<span class="lineart">╰──</span> <a href="../gtk3/GtkWidget.html#GtkWidget-struct">GtkWidget</a>
<span class="lineart">╰──</span> <a href="../gtk3/GtkContainer.html#GtkContainer-struct">GtkContainer</a>
<span class="lineart">╰──</span> <a href="../gtk3/GtkTextView.html#GtkTextView-struct">GtkTextView</a>
<span class="lineart">╰──</span> <a class="link" href="GtkSourceView.html" title="GtkSourceView">GtkSourceView</a>
<span class="lineart">╰──</span> GtkSourceMap
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceMap.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkSourceMap implements
AtkImplementorIface, <a href="../gtk3/GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a> and <a href="../gtk3/GtkScrollable.html#GtkScrollable-struct">GtkScrollable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkSourceMap.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <gtksourceview/gtksource.h>
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceMap.description"></a><h2>Description</h2>
<p><a class="link" href="GtkSourceMap.html" title="GtkSourceMap"><span class="type">GtkSourceMap</span></a> is a widget that maps the content of a <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a> into
a smaller view so the user can have a quick overview of the whole document.</p>
<p>This works by connecting a <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a> to to the <a class="link" href="GtkSourceMap.html" title="GtkSourceMap"><span class="type">GtkSourceMap</span></a> using
the <a class="link" href="GtkSourceMap.html#GtkSourceMap--view" title="The “view” property"><span class="type">“view”</span></a> property or <a class="link" href="GtkSourceMap.html#gtk-source-map-set-view" title="gtk_source_map_set_view ()"><code class="function">gtk_source_map_set_view()</code></a>.</p>
<p><a class="link" href="GtkSourceMap.html" title="GtkSourceMap"><span class="type">GtkSourceMap</span></a> is a <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a> object. This means that you can add a
<a class="link" href="GtkSourceGutterRenderer.html" title="GtkSourceGutterRenderer"><span class="type">GtkSourceGutterRenderer</span></a> to a gutter in the same way you would for a
<a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a>. One example might be a <a class="link" href="GtkSourceGutterRenderer.html" title="GtkSourceGutterRenderer"><span class="type">GtkSourceGutterRenderer</span></a> that shows
which lines have changed in the document.</p>
<p>Additionally, it is desirable to match the font of the <a class="link" href="GtkSourceMap.html" title="GtkSourceMap"><span class="type">GtkSourceMap</span></a> and
the <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a> used for editing. Therefore, <a class="link" href="GtkSourceMap.html#GtkSourceMap--font-desc" title="The “font-desc” property"><span class="type">“font-desc”</span></a>
should be used to set the target font. You will need to adjust this to the
desired font size for the map. A 1pt font generally seems to be an
appropriate font size. "Monospace 1" is the default. See
<a href="../pango/pango-Fonts.html#pango-font-description-set-size"><code class="function">pango_font_description_set_size()</code></a> for how to alter the size of an existing
<a href="../pango/pango-Fonts.html#PangoFontDescription-struct"><span class="type">PangoFontDescription</span></a>.</p>
</div>
<div class="refsect1">
<a name="GtkSourceMap.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-source-map-new"></a><h3>gtk_source_map_new ()</h3>
<pre class="programlisting"><a href="../gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
gtk_source_map_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="GtkSourceMap.html" title="GtkSourceMap"><span class="type">GtkSourceMap</span></a>.</p>
<div class="refsect3">
<a name="gtk-source-map-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GtkSourceMap.html" title="GtkSourceMap"><span class="type">GtkSourceMap</span></a>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-18.html#api-index-3.18">3.18</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-map-set-view"></a><h3>gtk_source_map_set_view ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_source_map_set_view (<em class="parameter"><code><a class="link" href="GtkSourceMap.html" title="GtkSourceMap"><span class="type">GtkSourceMap</span></a> *map</code></em>,
<em class="parameter"><code><a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a> *view</code></em>);</pre>
<p>Sets the view that <em class="parameter"><code>map</code></em>
will be doing the mapping to.</p>
<div class="refsect3">
<a name="gtk-source-map-set-view.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>map</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSourceMap.html" title="GtkSourceMap"><span class="type">GtkSourceMap</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>view</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-18.html#api-index-3.18">3.18</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-map-get-view"></a><h3>gtk_source_map_get_view ()</h3>
<pre class="programlisting"><a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="returnvalue">GtkSourceView</span></a> *
gtk_source_map_get_view (<em class="parameter"><code><a class="link" href="GtkSourceMap.html" title="GtkSourceMap"><span class="type">GtkSourceMap</span></a> *map</code></em>);</pre>
<p>Gets the <a class="link" href="GtkSourceMap.html#GtkSourceMap--view" title="The “view” property"><span class="type">“view”</span></a> property, which is the view this widget is mapping.</p>
<div class="refsect3">
<a name="gtk-source-map-get-view.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>map</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSourceMap.html" title="GtkSourceMap"><span class="type">GtkSourceMap</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-source-map-get-view.returns"></a><h4>Returns</h4>
<p>a <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<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></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-18.html#api-index-3.18">3.18</a></p>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceMap.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkSourceMap-struct"></a><h3>GtkSourceMap</h3>
<pre class="programlisting">typedef struct _GtkSourceMap GtkSourceMap;</pre>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceMap.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkSourceMap--font-desc"></a><h3>The <code class="literal">“font-desc”</code> property</h3>
<pre class="programlisting"> “font-desc” <a href="../pango/pango-Fonts.html#PangoFontDescription-struct"><span class="type">PangoFontDescription</span></a> *</pre>
<p>The Pango font description to use.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkSourceMap--view"></a><h3>The <code class="literal">“view”</code> property</h3>
<pre class="programlisting"> “view” <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a> *</pre>
<p>The view this widget is mapping.</p>
<p>Flags: Read / Write</p>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceMap.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|