/usr/share/gtk-doc/html/gtksourceview-3.0/GtkSourceSpaceDrawer.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 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkSourceSpaceDrawer: 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="GtkSourceRegion.html" title="GtkSourceRegion">
<link rel="next" href="GtkSourceTag.html" title="GtkSourceTag">
<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="#GtkSourceSpaceDrawer.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GtkSourceSpaceDrawer.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GtkSourceSpaceDrawer.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="GtkSourceRegion.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkSourceTag.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkSourceSpaceDrawer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkSourceSpaceDrawer.top_of_page"></a>GtkSourceSpaceDrawer</span></h2>
<p>GtkSourceSpaceDrawer — Represent white space characters with symbols</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkSourceSpaceDrawer.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="GtkSourceSpaceDrawer.html" title="GtkSourceSpaceDrawer"><span class="returnvalue">GtkSourceSpaceDrawer</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkSourceSpaceDrawer.html#gtk-source-space-drawer-new" title="gtk_source_space_drawer_new ()">gtk_source_space_drawer_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="GtkSourceSpaceDrawer.html#gtk-source-space-drawer-set-types-for-locations" title="gtk_source_space_drawer_set_types_for_locations ()">gtk_source_space_drawer_set_types_for_locations</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceTypeFlags" title="enum GtkSourceSpaceTypeFlags"><span class="returnvalue">GtkSourceSpaceTypeFlags</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkSourceSpaceDrawer.html#gtk-source-space-drawer-get-types-for-locations" title="gtk_source_space_drawer_get_types_for_locations ()">gtk_source_space_drawer_get_types_for_locations</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="GtkSourceSpaceDrawer.html#gtk-source-space-drawer-set-matrix" title="gtk_source_space_drawer_set_matrix ()">gtk_source_space_drawer_set_matrix</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkSourceSpaceDrawer.html#gtk-source-space-drawer-get-matrix" title="gtk_source_space_drawer_get_matrix ()">gtk_source_space_drawer_get_matrix</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="GtkSourceSpaceDrawer.html#gtk-source-space-drawer-set-enable-matrix" title="gtk_source_space_drawer_set_enable_matrix ()">gtk_source_space_drawer_set_enable_matrix</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkSourceSpaceDrawer.html#gtk-source-space-drawer-get-enable-matrix" title="gtk_source_space_drawer_get_enable_matrix ()">gtk_source_space_drawer_get_enable_matrix</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="GtkSourceSpaceDrawer.html#gtk-source-space-drawer-bind-matrix-setting" title="gtk_source_space_drawer_bind_matrix_setting ()">gtk_source_space_drawer_bind_matrix_setting</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSourceSpaceDrawer.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="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceDrawer--enable-matrix" title="The “enable-matrix” property">enable-matrix</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *</td>
<td class="property_name"><a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceDrawer--matrix" title="The “matrix” property">matrix</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSourceSpaceDrawer.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="GtkSourceSpaceDrawer.html#GtkSourceSpaceDrawer-struct" title="GtkSourceSpaceDrawer">GtkSourceSpaceDrawer</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceTypeFlags" title="enum GtkSourceSpaceTypeFlags">GtkSourceSpaceTypeFlags</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceLocationFlags" title="enum GtkSourceSpaceLocationFlags">GtkSourceSpaceLocationFlags</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSourceSpaceDrawer.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GFlags</a>
<span class="lineart">├──</span> GtkSourceSpaceLocationFlags
<span class="lineart">╰──</span> GtkSourceSpaceTypeFlags
<a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> GtkSourceSpaceDrawer
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceSpaceDrawer.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <gtksourceview/gtksource.h>
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceSpaceDrawer.description"></a><h2>Description</h2>
<p><a class="link" href="GtkSourceSpaceDrawer.html" title="GtkSourceSpaceDrawer"><span class="type">GtkSourceSpaceDrawer</span></a> provides a way to visualize white spaces, by drawing
symbols.</p>
<p>Call <a class="link" href="GtkSourceView.html#gtk-source-view-get-space-drawer" title="gtk_source_view_get_space_drawer ()"><code class="function">gtk_source_view_get_space_drawer()</code></a> to get the <a class="link" href="GtkSourceSpaceDrawer.html" title="GtkSourceSpaceDrawer"><span class="type">GtkSourceSpaceDrawer</span></a>
instance of a certain <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a>.</p>
<p>By default, no white spaces are drawn because the
<a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceDrawer--enable-matrix" title="The “enable-matrix” property"><span class="type">“enable-matrix”</span></a> is <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
<p>To draw white spaces, <a class="link" href="GtkSourceSpaceDrawer.html#gtk-source-space-drawer-set-types-for-locations" title="gtk_source_space_drawer_set_types_for_locations ()"><code class="function">gtk_source_space_drawer_set_types_for_locations()</code></a> can
be called to set the <a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceDrawer--matrix" title="The “matrix” property"><span class="type">“matrix”</span></a> property (by default all
space types are enabled at all locations). Then call
<a class="link" href="GtkSourceSpaceDrawer.html#gtk-source-space-drawer-set-enable-matrix" title="gtk_source_space_drawer_set_enable_matrix ()"><code class="function">gtk_source_space_drawer_set_enable_matrix()</code></a>.</p>
<p>For a finer-grained method, there is also the GtkSourceTag's
<a class="link" href="GtkSourceTag.html#GtkSourceTag--draw-spaces" title="The “draw-spaces” property"><span class="type">“draw-spaces”</span></a> property.</p>
<div class="refsect2">
<a name="id-1.3.10.4.8.7"></a><h3>Example</h3>
<p>To draw non-breaking spaces everywhere and draw all types of trailing spaces
except newlines:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="function"><a href="GtkSourceSpaceDrawer.html#gtk-source-space-drawer-set-types-for-locations">gtk_source_space_drawer_set_types_for_locations</a></span> <span class="gtkdoc opt">(</span>space_drawer<span class="gtkdoc opt">,</span>
GTK_SOURCE_SPACE_LOCATION_ALL<span class="gtkdoc opt">,</span>
GTK_SOURCE_SPACE_TYPE_NBSP<span class="gtkdoc opt">);</span>
<span class="function"><a href="GtkSourceSpaceDrawer.html#gtk-source-space-drawer-set-types-for-locations">gtk_source_space_drawer_set_types_for_locations</a></span> <span class="gtkdoc opt">(</span>space_drawer<span class="gtkdoc opt">,</span>
GTK_SOURCE_SPACE_LOCATION_TRAILING<span class="gtkdoc opt">,</span>
GTK_SOURCE_SPACE_TYPE_ALL <span class="gtkdoc opt">&</span>
<span class="gtkdoc opt">~</span>GTK_SOURCE_SPACE_TYPE_NEWLINE<span class="gtkdoc opt">);</span>
<span class="function"><a href="GtkSourceSpaceDrawer.html#gtk-source-space-drawer-set-enable-matrix">gtk_source_space_drawer_set_enable_matrix</a></span> <span class="gtkdoc opt">(</span>space_drawer<span class="gtkdoc opt">,</span> TRUE<span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
</div>
<hr>
<div class="refsect2">
<a name="id-1.3.10.4.8.8"></a><h3>Use-case: draw unwanted white spaces</h3>
<p>A possible use-case is to draw only unwanted white spaces. Examples:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>Draw all trailing spaces.</p></li>
<li class="listitem"><p>If the indentation and alignment must be done with spaces, draw tabs.</p></li>
</ul></div>
<p>And non-breaking spaces can always be drawn, everywhere, to distinguish them
from normal spaces.</p>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceSpaceDrawer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-source-space-drawer-new"></a><h3>gtk_source_space_drawer_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkSourceSpaceDrawer.html" title="GtkSourceSpaceDrawer"><span class="returnvalue">GtkSourceSpaceDrawer</span></a> *
gtk_source_space_drawer_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="GtkSourceSpaceDrawer.html" title="GtkSourceSpaceDrawer"><span class="type">GtkSourceSpaceDrawer</span></a> object. Useful for storing space drawing
settings independently of a <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a>.</p>
<div class="refsect3">
<a name="gtk-source-space-drawer-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GtkSourceSpaceDrawer.html" title="GtkSourceSpaceDrawer"><span class="type">GtkSourceSpaceDrawer</span></a>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-24.html#api-index-3.24">3.24</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-space-drawer-set-types-for-locations"></a><h3>gtk_source_space_drawer_set_types_for_locations ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_source_space_drawer_set_types_for_locations
(<em class="parameter"><code><a class="link" href="GtkSourceSpaceDrawer.html" title="GtkSourceSpaceDrawer"><span class="type">GtkSourceSpaceDrawer</span></a> *drawer</code></em>,
<em class="parameter"><code><a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceLocationFlags" title="enum GtkSourceSpaceLocationFlags"><span class="type">GtkSourceSpaceLocationFlags</span></a> locations</code></em>,
<em class="parameter"><code><a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceTypeFlags" title="enum GtkSourceSpaceTypeFlags"><span class="type">GtkSourceSpaceTypeFlags</span></a> types</code></em>);</pre>
<p>Modifies the <a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceDrawer--matrix" title="The “matrix” property"><span class="type">“matrix”</span></a> property at the specified
<em class="parameter"><code>locations</code></em>
.</p>
<div class="refsect3">
<a name="gtk-source-space-drawer-set-types-for-locations.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>drawer</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSourceSpaceDrawer.html" title="GtkSourceSpaceDrawer"><span class="type">GtkSourceSpaceDrawer</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>locations</p></td>
<td class="parameter_description"><p>one or several <a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceLocationFlags" title="enum GtkSourceSpaceLocationFlags"><span class="type">GtkSourceSpaceLocationFlags</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>types</p></td>
<td class="parameter_description"><p>a combination of <a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceTypeFlags" title="enum GtkSourceSpaceTypeFlags"><span class="type">GtkSourceSpaceTypeFlags</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-24.html#api-index-3.24">3.24</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-space-drawer-get-types-for-locations"></a><h3>gtk_source_space_drawer_get_types_for_locations ()</h3>
<pre class="programlisting"><a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceTypeFlags" title="enum GtkSourceSpaceTypeFlags"><span class="returnvalue">GtkSourceSpaceTypeFlags</span></a>
gtk_source_space_drawer_get_types_for_locations
(<em class="parameter"><code><a class="link" href="GtkSourceSpaceDrawer.html" title="GtkSourceSpaceDrawer"><span class="type">GtkSourceSpaceDrawer</span></a> *drawer</code></em>,
<em class="parameter"><code><a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceLocationFlags" title="enum GtkSourceSpaceLocationFlags"><span class="type">GtkSourceSpaceLocationFlags</span></a> locations</code></em>);</pre>
<p>If only one location is specified, this function returns what kind of
white spaces are drawn at that location. The value is retrieved from the
<a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceDrawer--matrix" title="The “matrix” property"><span class="type">“matrix”</span></a> property.</p>
<p>If several locations are specified, this function returns the logical AND for
those locations. Which means that if a certain kind of white space is present
in the return value, then that kind of white space is drawn at all the
specified <em class="parameter"><code>locations</code></em>
.</p>
<div class="refsect3">
<a name="gtk-source-space-drawer-get-types-for-locations.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>drawer</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSourceSpaceDrawer.html" title="GtkSourceSpaceDrawer"><span class="type">GtkSourceSpaceDrawer</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>locations</p></td>
<td class="parameter_description"><p>one or several <a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceLocationFlags" title="enum GtkSourceSpaceLocationFlags"><span class="type">GtkSourceSpaceLocationFlags</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-source-space-drawer-get-types-for-locations.returns"></a><h4>Returns</h4>
<p> a combination of <a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceTypeFlags" title="enum GtkSourceSpaceTypeFlags"><span class="type">GtkSourceSpaceTypeFlags</span></a>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-24.html#api-index-3.24">3.24</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-space-drawer-set-matrix"></a><h3>gtk_source_space_drawer_set_matrix ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_source_space_drawer_set_matrix (<em class="parameter"><code><a class="link" href="GtkSourceSpaceDrawer.html" title="GtkSourceSpaceDrawer"><span class="type">GtkSourceSpaceDrawer</span></a> *drawer</code></em>,
<em class="parameter"><code><a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *matrix</code></em>);</pre>
<p>Sets a new value to the <a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceDrawer--matrix" title="The “matrix” property"><span class="type">“matrix”</span></a> property, as a
<a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>. If <em class="parameter"><code>matrix</code></em>
is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then an empty array is set.</p>
<p>If <em class="parameter"><code>matrix</code></em>
is floating, it is consumed.</p>
<p>The <a class="link" href="GtkSourceSpaceDrawer.html#gtk-source-space-drawer-set-types-for-locations" title="gtk_source_space_drawer_set_types_for_locations ()"><code class="function">gtk_source_space_drawer_set_types_for_locations()</code></a> function may be more
convenient to use.</p>
<div class="refsect3">
<a name="gtk-source-space-drawer-set-matrix.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>drawer</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSourceSpaceDrawer.html" title="GtkSourceSpaceDrawer"><span class="type">GtkSourceSpaceDrawer</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>matrix</p></td>
<td class="parameter_description"><p>the new matrix value, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Alias for transfer none, used for objects with floating refs."><span class="acronym">transfer floating</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></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-24.html#api-index-3.24">3.24</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-space-drawer-get-matrix"></a><h3>gtk_source_space_drawer_get_matrix ()</h3>
<pre class="programlisting"><a href="../glib/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
gtk_source_space_drawer_get_matrix (<em class="parameter"><code><a class="link" href="GtkSourceSpaceDrawer.html" title="GtkSourceSpaceDrawer"><span class="type">GtkSourceSpaceDrawer</span></a> *drawer</code></em>);</pre>
<p>Gets the value of the <a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceDrawer--matrix" title="The “matrix” property"><span class="type">“matrix”</span></a> property, as a <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>.
An empty array can be returned in case the matrix is a zero matrix.</p>
<p>The <a class="link" href="GtkSourceSpaceDrawer.html#gtk-source-space-drawer-get-types-for-locations" title="gtk_source_space_drawer_get_types_for_locations ()"><code class="function">gtk_source_space_drawer_get_types_for_locations()</code></a> function may be more
convenient to use.</p>
<div class="refsect3">
<a name="gtk-source-space-drawer-get-matrix.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>drawer</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSourceSpaceDrawer.html" title="GtkSourceSpaceDrawer"><span class="type">GtkSourceSpaceDrawer</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-source-space-drawer-get-matrix.returns"></a><h4>Returns</h4>
<p> the <a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceDrawer--matrix" title="The “matrix” property"><span class="type">“matrix”</span></a> value as a new floating <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>
instance.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-24.html#api-index-3.24">3.24</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-space-drawer-set-enable-matrix"></a><h3>gtk_source_space_drawer_set_enable_matrix ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_source_space_drawer_set_enable_matrix
(<em class="parameter"><code><a class="link" href="GtkSourceSpaceDrawer.html" title="GtkSourceSpaceDrawer"><span class="type">GtkSourceSpaceDrawer</span></a> *drawer</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> enable_matrix</code></em>);</pre>
<p>Sets whether the <a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceDrawer--matrix" title="The “matrix” property"><span class="type">“matrix”</span></a> property is enabled.</p>
<div class="refsect3">
<a name="gtk-source-space-drawer-set-enable-matrix.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>drawer</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSourceSpaceDrawer.html" title="GtkSourceSpaceDrawer"><span class="type">GtkSourceSpaceDrawer</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>enable_matrix</p></td>
<td class="parameter_description"><p>the new value.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-24.html#api-index-3.24">3.24</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-space-drawer-get-enable-matrix"></a><h3>gtk_source_space_drawer_get_enable_matrix ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gtk_source_space_drawer_get_enable_matrix
(<em class="parameter"><code><a class="link" href="GtkSourceSpaceDrawer.html" title="GtkSourceSpaceDrawer"><span class="type">GtkSourceSpaceDrawer</span></a> *drawer</code></em>);</pre>
<div class="refsect3">
<a name="gtk-source-space-drawer-get-enable-matrix.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>drawer</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSourceSpaceDrawer.html" title="GtkSourceSpaceDrawer"><span class="type">GtkSourceSpaceDrawer</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-source-space-drawer-get-enable-matrix.returns"></a><h4>Returns</h4>
<p> whether the <a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceDrawer--matrix" title="The “matrix” property"><span class="type">“matrix”</span></a> property is enabled.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-24.html#api-index-3.24">3.24</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-space-drawer-bind-matrix-setting"></a><h3>gtk_source_space_drawer_bind_matrix_setting ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_source_space_drawer_bind_matrix_setting
(<em class="parameter"><code><a class="link" href="GtkSourceSpaceDrawer.html" title="GtkSourceSpaceDrawer"><span class="type">GtkSourceSpaceDrawer</span></a> *drawer</code></em>,
<em class="parameter"><code><a href="../gio/GSettings.html#GSettings-struct"><span class="type">GSettings</span></a> *settings</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
<em class="parameter"><code><a href="../gio/GSettings.html#GSettingsBindFlags"><span class="type">GSettingsBindFlags</span></a> flags</code></em>);</pre>
<p>Binds the <a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceDrawer--matrix" title="The “matrix” property"><span class="type">“matrix”</span></a> property to a <a href="../gio/GSettings.html#GSettings-struct"><span class="type">GSettings</span></a> key.</p>
<p>The <a href="../gio/GSettings.html#GSettings-struct"><span class="type">GSettings</span></a> key must be of the same type as the
<a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceDrawer--matrix" title="The “matrix” property"><span class="type">“matrix”</span></a> property, that is, <code class="literal">"au"</code>.</p>
<p>The <a href="../gio/GSettings.html#g-settings-bind"><code class="function">g_settings_bind()</code></a> function cannot be used, because the default GIO
mapping functions don't support <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> properties (maybe it will be
supported by a future GIO version, in which case this function can be
deprecated).</p>
<div class="refsect3">
<a name="gtk-source-space-drawer-bind-matrix-setting.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>drawer</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSourceSpaceDrawer.html" title="GtkSourceSpaceDrawer"><span class="type">GtkSourceSpaceDrawer</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>settings</p></td>
<td class="parameter_description"><p>a <a href="../gio/GSettings.html#GSettings-struct"><span class="type">GSettings</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>the <em class="parameter"><code>settings</code></em>
key to bind.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>flags for the binding.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-24.html#api-index-3.24">3.24</a></p>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceSpaceDrawer.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkSourceSpaceDrawer-struct"></a><h3>GtkSourceSpaceDrawer</h3>
<pre class="programlisting">typedef struct _GtkSourceSpaceDrawer GtkSourceSpaceDrawer;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GtkSourceSpaceTypeFlags"></a><h3>enum GtkSourceSpaceTypeFlags</h3>
<p><a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceTypeFlags" title="enum GtkSourceSpaceTypeFlags"><span class="type">GtkSourceSpaceTypeFlags</span></a> contains flags for white space types.</p>
<div class="refsect3">
<a name="GtkSourceSpaceTypeFlags.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GTK-SOURCE-SPACE-TYPE-NONE:CAPS"></a>GTK_SOURCE_SPACE_TYPE_NONE</p></td>
<td class="enum_member_description">
<p>No flags.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GTK-SOURCE-SPACE-TYPE-SPACE:CAPS"></a>GTK_SOURCE_SPACE_TYPE_SPACE</p></td>
<td class="enum_member_description">
<p>Space character.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GTK-SOURCE-SPACE-TYPE-TAB:CAPS"></a>GTK_SOURCE_SPACE_TYPE_TAB</p></td>
<td class="enum_member_description">
<p>Tab character.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GTK-SOURCE-SPACE-TYPE-NEWLINE:CAPS"></a>GTK_SOURCE_SPACE_TYPE_NEWLINE</p></td>
<td class="enum_member_description">
<p>Line break character. If the
<a class="link" href="GtkSourceBuffer.html#GtkSourceBuffer--implicit-trailing-newline" title="The “implicit-trailing-newline” property"><span class="type">“implicit-trailing-newline”</span></a> property is <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>,
<a class="link" href="GtkSourceSpaceDrawer.html" title="GtkSourceSpaceDrawer"><span class="type">GtkSourceSpaceDrawer</span></a> also draws a line break at the end of the buffer.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GTK-SOURCE-SPACE-TYPE-NBSP:CAPS"></a>GTK_SOURCE_SPACE_TYPE_NBSP</p></td>
<td class="enum_member_description">
<p>Non-breaking space character.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GTK-SOURCE-SPACE-TYPE-ALL:CAPS"></a>GTK_SOURCE_SPACE_TYPE_ALL</p></td>
<td class="enum_member_description">
<p>All white spaces.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-24.html#api-index-3.24">3.24</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkSourceSpaceLocationFlags"></a><h3>enum GtkSourceSpaceLocationFlags</h3>
<p><a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceLocationFlags" title="enum GtkSourceSpaceLocationFlags"><span class="type">GtkSourceSpaceLocationFlags</span></a> contains flags for white space locations.</p>
<p>If a line contains only white spaces (no text), the white spaces match both
<a class="link" href="GtkSourceSpaceDrawer.html#GTK-SOURCE-SPACE-LOCATION-LEADING:CAPS"><code class="literal">GTK_SOURCE_SPACE_LOCATION_LEADING</code></a> and <a class="link" href="GtkSourceSpaceDrawer.html#GTK-SOURCE-SPACE-LOCATION-TRAILING:CAPS"><code class="literal">GTK_SOURCE_SPACE_LOCATION_TRAILING</code></a>.</p>
<div class="refsect3">
<a name="GtkSourceSpaceLocationFlags.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GTK-SOURCE-SPACE-LOCATION-NONE:CAPS"></a>GTK_SOURCE_SPACE_LOCATION_NONE</p></td>
<td class="enum_member_description">
<p>No flags.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GTK-SOURCE-SPACE-LOCATION-LEADING:CAPS"></a>GTK_SOURCE_SPACE_LOCATION_LEADING</p></td>
<td class="enum_member_description">
<p>Leading white spaces on a line, i.e. the
indentation.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GTK-SOURCE-SPACE-LOCATION-INSIDE-TEXT:CAPS"></a>GTK_SOURCE_SPACE_LOCATION_INSIDE_TEXT</p></td>
<td class="enum_member_description">
<p>White spaces inside a line of text.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GTK-SOURCE-SPACE-LOCATION-TRAILING:CAPS"></a>GTK_SOURCE_SPACE_LOCATION_TRAILING</p></td>
<td class="enum_member_description">
<p>Trailing white spaces on a line.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GTK-SOURCE-SPACE-LOCATION-ALL:CAPS"></a>GTK_SOURCE_SPACE_LOCATION_ALL</p></td>
<td class="enum_member_description">
<p>White spaces anywhere.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-24.html#api-index-3.24">3.24</a></p>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceSpaceDrawer.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkSourceSpaceDrawer--enable-matrix"></a><h3>The <code class="literal">“enable-matrix”</code> property</h3>
<pre class="programlisting"> “enable-matrix” <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether the <a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceDrawer--matrix" title="The “matrix” property"><span class="type">“matrix”</span></a> property is enabled.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="api-index-3-24.html#api-index-3.24">3.24</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkSourceSpaceDrawer--matrix"></a><h3>The <code class="literal">“matrix”</code> property</h3>
<pre class="programlisting"> “matrix” <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *</pre>
<p>The :matrix property is a <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> property to specify where and
what kind of white spaces to draw.</p>
<p>The <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> is of type <code class="literal">"au"</code>, an array of unsigned integers. Each
integer is a combination of <a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceTypeFlags" title="enum GtkSourceSpaceTypeFlags"><span class="type">GtkSourceSpaceTypeFlags</span></a>. There is one
integer for each <a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceLocationFlags" title="enum GtkSourceSpaceLocationFlags"><span class="type">GtkSourceSpaceLocationFlags</span></a>, in the same order as
they are defined in the enum (<a class="link" href="GtkSourceSpaceDrawer.html#GTK-SOURCE-SPACE-LOCATION-NONE:CAPS"><code class="literal">GTK_SOURCE_SPACE_LOCATION_NONE</code></a> and
<a class="link" href="GtkSourceSpaceDrawer.html#GTK-SOURCE-SPACE-LOCATION-ALL:CAPS"><code class="literal">GTK_SOURCE_SPACE_LOCATION_ALL</code></a> are not taken into account).</p>
<p>If the array is shorter than the number of locations, then the value
for the missing locations will be <a class="link" href="GtkSourceSpaceDrawer.html#GTK-SOURCE-SPACE-TYPE-NONE:CAPS"><code class="literal">GTK_SOURCE_SPACE_TYPE_NONE</code></a>.</p>
<p>By default, <a class="link" href="GtkSourceSpaceDrawer.html#GTK-SOURCE-SPACE-TYPE-ALL:CAPS"><code class="literal">GTK_SOURCE_SPACE_TYPE_ALL</code></a> is set for all locations.</p>
<p>Flags: Read / Write / Construct</p>
<p>Allowed values: GVariant<au></p>
<p>Default value: [uint32 15, 15, 15]</p>
<p class="since">Since: <a class="link" href="api-index-3-24.html#api-index-3.24">3.24</a></p>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceSpaceDrawer.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>
|