/usr/share/gtk-doc/html/libgwydraw/GwySelection.html is in libgwyddion20-doc 2.44-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 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GwySelection: Gwyddion Drawing Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Gwyddion Drawing Library Reference Manual">
<link rel="up" href="index.html" title="Gwyddion Drawing Library Reference Manual">
<link rel="prev" href="libgwydraw-gwypixfield.html" title="gwypixfield">
<link rel="next" href="libgwydraw-gwydraw.html" title="gwydraw">
<meta name="generator" content="GTK-Doc V1.19 (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="#GwySelection.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GwySelection.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GwySelection.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GwySelection.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#GwySelection.signals" class="shortcut">Signals</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><img src="up-insensitive.png" width="16" height="16" border="0"></td>
<td><a accesskey="p" href="libgwydraw-gwypixfield.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgwydraw-gwydraw.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GwySelection"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GwySelection.top_of_page"></a>GwySelection</span></h2>
<p>GwySelection — Data selection base class</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GwySelection.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="GwySelection.html#GwySelectionFilterFunc" title="GwySelectionFilterFunc ()">*GwySelectionFilterFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="GwySelection.html#gwy-selection-duplicate" title="gwy_selection_duplicate()">gwy_selection_duplicate</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="GwySelection.html#gwy-selection-get-object-size" title="gwy_selection_get_object_size ()">gwy_selection_get_object_size</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="GwySelection.html#gwy-selection-clear" title="gwy_selection_clear ()">gwy_selection_clear</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GwySelection.html#gwy-selection-get-object" title="gwy_selection_get_object ()">gwy_selection_get_object</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="GwySelection.html#gwy-selection-set-object" title="gwy_selection_set_object ()">gwy_selection_set_object</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="GwySelection.html#gwy-selection-delete-object" title="gwy_selection_delete_object ()">gwy_selection_delete_object</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="GwySelection.html#gwy-selection-get-data" title="gwy_selection_get_data ()">gwy_selection_get_data</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="GwySelection.html#gwy-selection-set-data" title="gwy_selection_set_data ()">gwy_selection_set_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="GwySelection.html#gwy-selection-get-max-objects" title="gwy_selection_get_max_objects ()">gwy_selection_get_max_objects</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="GwySelection.html#gwy-selection-set-max-objects" title="gwy_selection_set_max_objects ()">gwy_selection_set_max_objects</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GwySelection.html#gwy-selection-is-full" title="gwy_selection_is_full ()">gwy_selection_is_full</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="GwySelection.html#gwy-selection-crop" title="gwy_selection_crop ()">gwy_selection_crop</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="GwySelection.html#gwy-selection-move" title="gwy_selection_move ()">gwy_selection_move</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="GwySelection.html#gwy-selection-filter" title="gwy_selection_filter ()">gwy_selection_filter</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="GwySelection.html#gwy-selection-changed" title="gwy_selection_changed ()">gwy_selection_changed</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="GwySelection.html#gwy-selection-finished" title="gwy_selection_finished ()">gwy_selection_finished</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GwySelection.properties"></a><h2>Properties</h2>
<div class="informaltable"><table 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="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
<td class="property_name"><a class="link" href="GwySelection.html#GwySelection--max-objects" title="The “max-objects” property">max-objects</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
<td class="property_name"><a class="link" href="GwySelection.html#GwySelection--object-size" title="The “object-size” property">object-size</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GwySelection.signals"></a><h2>Signals</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GwySelection.html#GwySelection-changed" title="The “changed” signal">changed</a></td>
<td class="signal_flags"><a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GwySelection.html#GwySelection-finished" title="The “finished” signal">finished</a></td>
<td class="signal_flags"><a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GwySelection.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GwySelection.html#GwySelection-struct" title="struct GwySelection">GwySelection</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GwySelection.html#GwySelectionClass" title="struct GwySelectionClass">GwySelectionClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GwySelection.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
<span class="lineart">╰──</span> GwySelection
</pre>
</div>
<div class="refsect1">
<a name="GwySelection.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GwySelection implements
<a href="../libgwyddion/GwySerializable.html">GwySerializable</a>.</p>
</div>
<div class="refsect1">
<a name="GwySelection.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libdraw/gwydraw.h>
</pre>
</div>
<div class="refsect1">
<a name="GwySelection.description"></a><h2>Description</h2>
<p><a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a> is an abstract class representing data selections. Particular
selection types are defined by vector layer modules.</p>
<p>Selections behave as flat arrays of coordinates. They are however logically
split into selection objects (points, lines, rectangles), characteristic for
each selection type. For example, to describe a horizontal line one needs
only one coordinate, for a point two coordinates are needed, rectangle or
arbitrary line need four. <a class="link" href="GwySelection.html#gwy-selection-get-object-size" title="gwy_selection_get_object_size ()"><code class="function">gwy_selection_get_object_size()</code></a> can be used to
generically determine the number of coordinates used to describe a one
selection object.</p>
<p>The number of selection objects in a selection can vary,
<a class="link" href="GwySelection.html#gwy-selection-set-max-objects" title="gwy_selection_set_max_objects ()"><code class="function">gwy_selection_set_max_objects()</code></a> sets the maximum possible number. Functions
for getting and setting individual selection objects
(<a class="link" href="GwySelection.html#gwy-selection-get-object" title="gwy_selection_get_object ()"><code class="function">gwy_selection_get_object()</code></a>, <a class="link" href="GwySelection.html#gwy-selection-set-object" title="gwy_selection_set_object ()"><code class="function">gwy_selection_set_object()</code></a>) or complete
selection (<a class="link" href="GwySelection.html#gwy-selection-get-data" title="gwy_selection_get_data ()"><code class="function">gwy_selection_get_data()</code></a>, <a class="link" href="GwySelection.html#gwy-selection-set-data" title="gwy_selection_set_data ()"><code class="function">gwy_selection_set_data()</code></a>) are
available. The method <a class="link" href="GwySelection.html#gwy-selection-set-data" title="gwy_selection_set_data ()"><code class="function">gwy_selection_set_data()</code></a> with <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> second argument
is also used to determine the number of selected object.</p>
</div>
<div class="refsect1">
<a name="GwySelection.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="GwySelectionFilterFunc"></a><h3>GwySelectionFilterFunc ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
<span class="c_punctuation">(</span>*GwySelectionFilterFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a> *selection</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
<p>Type of selection filtering function.</p>
<div class="refsect3">
<a name="id-1.7.11.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>selection</p></td>
<td class="parameter_description"><p>A selection.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>Index of object to consider.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>User data passed to <a class="link" href="GwySelection.html#gwy-selection-filter" title="gwy_selection_filter ()"><code class="function">gwy_selection_filter()</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.11.2.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for objects that should be kept, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> for objects that
should be removed.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-16.html#api-index-2.16">2.16</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-selection-duplicate"></a><h3>gwy_selection_duplicate()</h3>
<pre class="programlisting">#define gwy_selection_duplicate(selection)</pre>
<p>Convenience macro doing <a href="../libgwyddion/GwySerializable.html#gwy-serializable-duplicate"><code class="function">gwy_serializable_duplicate()</code></a> with all the necessary
typecasting.</p>
<div class="refsect3">
<a name="id-1.7.11.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>selection</p></td>
<td class="parameter_description"><p>An selection to duplicate.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-selection-get-object-size"></a><h3>gwy_selection_get_object_size ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
gwy_selection_get_object_size (<em class="parameter"><code><a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a> *selection</code></em>);</pre>
<p>Gets the number of coordinates that make up a one selection object.</p>
<div class="refsect3">
<a name="id-1.7.11.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>selection</p></td>
<td class="parameter_description"><p>A selection.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.11.4.6"></a><h4>Returns</h4>
<p> The number of coordinates in one selection object.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-selection-clear"></a><h3>gwy_selection_clear ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_selection_clear (<em class="parameter"><code><a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a> *selection</code></em>);</pre>
<p>Clears a selection.</p>
<div class="refsect3">
<a name="id-1.7.11.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>selection</p></td>
<td class="parameter_description"><p>A selection.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-selection-get-object"></a><h3>gwy_selection_get_object ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gwy_selection_get_object (<em class="parameter"><code><a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a> *selection</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *data</code></em>);</pre>
<p>Gets one selection object.</p>
<div class="refsect3">
<a name="id-1.7.11.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>selection</p></td>
<td class="parameter_description"><p>A selection.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>Index of object to get.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>Array to store selection object data to. Object data is an
array of coordinates whose precise meaning is defined by particular
selection types.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.11.6.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if there was such an object and <em class="parameter"><code>data</code></em>
was filled.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-selection-set-object"></a><h3>gwy_selection_set_object ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
gwy_selection_set_object (<em class="parameter"><code><a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a> *selection</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *data</code></em>);</pre>
<p>Sets one selection object.</p>
<p>This method can be also used to append objects (if the maximum number is
not exceeded). Since there cannot be holes in the object list, <em class="parameter"><code>i</code></em>
must be
then equal to either the number of selected objects or special value -1
meaning append to end.</p>
<div class="refsect3">
<a name="id-1.7.11.7.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>selection</p></td>
<td class="parameter_description"><p>A selection.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>Index of object to set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>Object selection data. It's an array of coordinates whose precise
meaning is defined by particular selection types.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.11.7.7"></a><h4>Returns</h4>
<p> The index of actually set object (useful namely when <em class="parameter"><code>i</code></em>
is -1).</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-selection-delete-object"></a><h3>gwy_selection_delete_object ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_selection_delete_object (<em class="parameter"><code><a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a> *selection</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);</pre>
<p>Deletes a one selection object.</p>
<p>Since there cannot be holes in the object list, the rest of selection
objects is moved to close the gap.</p>
<div class="refsect3">
<a name="id-1.7.11.8.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>selection</p></td>
<td class="parameter_description"><p>A selection.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>Index of object to delete.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-selection-get-data"></a><h3>gwy_selection_get_data ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
gwy_selection_get_data (<em class="parameter"><code><a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a> *selection</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *data</code></em>);</pre>
<p>Gets selection data.</p>
<div class="refsect3">
<a name="id-1.7.11.9.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>selection</p></td>
<td class="parameter_description"><p>A selection.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>Array to store selection data to. Selection data is an
array of coordinates whose precise meaning is defined by particular
selection types. It may be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.11.9.6"></a><h4>Returns</h4>
<p> The number of selected objects. This is *not* the required size
of <em class="parameter"><code>data</code></em>
, which must be at least <a class="link" href="GwySelection.html#gwy-selection-get-object-size" title="gwy_selection_get_object_size ()"><code class="function">gwy_selection_get_object_size()</code></a>
times larger.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-selection-set-data"></a><h3>gwy_selection_set_data ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_selection_set_data (<em class="parameter"><code><a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a> *selection</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> nselected</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *data</code></em>);</pre>
<p>Sets selection data.</p>
<div class="refsect3">
<a name="id-1.7.11.10.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>selection</p></td>
<td class="parameter_description"><p>A selection.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>nselected</p></td>
<td class="parameter_description"><p>The number of selected objects.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>Selection data, that is an array <em class="parameter"><code>nselected</code></em>
*
<a class="link" href="GwySelection.html#gwy-selection-get-object-size" title="gwy_selection_get_object_size ()"><code class="function">gwy_selection_get_object_size()</code></a> long with selected object
coordinates.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-selection-get-max-objects"></a><h3>gwy_selection_get_max_objects ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
gwy_selection_get_max_objects (<em class="parameter"><code><a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a> *selection</code></em>);</pre>
<p>Gets the maximum number of selected objects.</p>
<div class="refsect3">
<a name="id-1.7.11.11.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>selection</p></td>
<td class="parameter_description"><p>A selection.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.11.11.6"></a><h4>Returns</h4>
<p> The maximum number of selected objects;</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-selection-set-max-objects"></a><h3>gwy_selection_set_max_objects ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_selection_set_max_objects (<em class="parameter"><code><a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a> *selection</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> max_objects</code></em>);</pre>
<p>Sets the maximum number of objects allowed to select.</p>
<p>When selection reaches this number of selected objects, it emits
"finished" signal.</p>
<div class="refsect3">
<a name="id-1.7.11.12.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>selection</p></td>
<td class="parameter_description"><p>A selection.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>max_objects</p></td>
<td class="parameter_description"><p>The maximum number of objects allowed to select. Note
particular selection types may allow only specific values.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-selection-is-full"></a><h3>gwy_selection_is_full ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gwy_selection_is_full (<em class="parameter"><code><a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a> *selection</code></em>);</pre>
<p>Checks whether the maximum number of objects is selected.</p>
<div class="refsect3">
<a name="id-1.7.11.13.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>selection</p></td>
<td class="parameter_description"><p>A selection.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.11.13.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> when the maximum possible number of objects is selected,
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-selection-crop"></a><h3>gwy_selection_crop ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_selection_crop (<em class="parameter"><code><a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a> *selection</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> xmin</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> ymin</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> xmax</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> ymax</code></em>);</pre>
<p>Limits objects in a selection to a rectangle.</p>
<p>Objects that are fully outside specified rectangle are removed. Objects
partially outside may be removed or cut, depending on what makes sense for
the specific selection type. If the selection class does not implement this
method then all objects are removed.</p>
<div class="refsect3">
<a name="id-1.7.11.14.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>selection</p></td>
<td class="parameter_description"><p>A selection.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>xmin</p></td>
<td class="parameter_description"><p>Minimum x-coordinate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ymin</p></td>
<td class="parameter_description"><p>Minimum y-coordinate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>xmax</p></td>
<td class="parameter_description"><p>Maximum x-coordinate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ymax</p></td>
<td class="parameter_description"><p>Maximum y-coordinate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-16.html#api-index-2.16">2.16</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-selection-move"></a><h3>gwy_selection_move ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_selection_move (<em class="parameter"><code><a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a> *selection</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> vx</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> vy</code></em>);</pre>
<p>Moves entire selection in plane by given vector.</p>
<p>If a selection class does not implement this operation the selection remains
unchanged. Bult-in selection classes generally implement this operation if
it is meaningful. For some, such as GwySelectionLattice, it is not
meaningful and moving GwySelectionLattice thus does not do anything.</p>
<div class="refsect3">
<a name="id-1.7.11.15.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>selection</p></td>
<td class="parameter_description"><p>A selection.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>vx</p></td>
<td class="parameter_description"><p>Value to add to all x-coordinates.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>vy</p></td>
<td class="parameter_description"><p>Value to add to all y-coordinates.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-43.html#api-index-2.43">2.43</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-selection-filter"></a><h3>gwy_selection_filter ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_selection_filter (<em class="parameter"><code><a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a> *selection</code></em>,
<em class="parameter"><code><a class="link" href="GwySelection.html#GwySelectionFilterFunc" title="GwySelectionFilterFunc ()"><span class="type">GwySelectionFilterFunc</span></a> filter</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
<p>Removes selection objects matching certain criteria.</p>
<div class="refsect3">
<a name="id-1.7.11.16.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>selection</p></td>
<td class="parameter_description"><p>A selection.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filter</p></td>
<td class="parameter_description"><p>Function returning <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for objects that should be kept, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
for objects that should be removed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>User data passed to <em class="parameter"><code>filter</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-16.html#api-index-2.16">2.16</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-selection-changed"></a><h3>gwy_selection_changed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_selection_changed (<em class="parameter"><code><a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a> *selection</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);</pre>
<p>Emits "changed" signal on a selection.</p>
<div class="refsect3">
<a name="id-1.7.11.17.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>selection</p></td>
<td class="parameter_description"><p>A selection.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>Index of object that changed. Use -1 when not applicable, e.g., when
complete selection was changed, cleared, or truncated.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-selection-finished"></a><h3>gwy_selection_finished ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_selection_finished (<em class="parameter"><code><a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a> *selection</code></em>);</pre>
<p>Emits "finished" signal on a selection.</p>
<div class="refsect3">
<a name="id-1.7.11.18.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>selection</p></td>
<td class="parameter_description"><p>A selection.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GwySelection.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GwySelection-struct"></a><h3>struct GwySelection</h3>
<pre class="programlisting">struct GwySelection;</pre>
<p>The <a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a> struct describes an abstract selection as a collection
of coordinates. It should not be accessed directly except selection
class implementation.</p>
<div class="refsect3">
<a name="id-1.7.12.2.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GwySelectionClass"></a><h3>struct GwySelectionClass</h3>
<pre class="programlisting">struct GwySelectionClass {
guint object_size;
/* Virtual table */
void (*clear)(GwySelection *selection);
gboolean(*get_object)(GwySelection *selection,
gint i,
gdouble *data);
gint (*set_object)(GwySelection *selection,
gint i,
const gdouble *data);
void (*delete_object)(GwySelection *selection,
gint i);
gint (*get_data)(GwySelection *selection,
gdouble *data);
void (*set_data)(GwySelection *selection,
gint nselected,
const gdouble *data);
void (*set_max_objects)(GwySelection *selection,
guint max_objects);
/* Signals */
void (*changed)(GwySelection *selection,
gint i);
void (*finished)(GwySelection *selection);
};
</pre>
<p>The virtual methods and data memebers of <a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a>s.</p>
<p>Typically, the only field subclasses set in their class init method is
<em class="parameter"><code>object_size</code></em>
. The methods are implemented generically in <a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a>
and need not be overriden.</p>
<div class="refsect3">
<a name="id-1.7.12.3.6"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="GwySelectionClass.object-size"></a>object_size</code></em>;</p></td>
<td class="struct_member_description"><p>The number of coordinates that form one selection object.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GwySelectionClass.clear"></a>clear</code></em> ()</p></td>
<td class="struct_member_description"><p>The <a class="link" href="GwySelection.html#gwy-selection-clear" title="gwy_selection_clear ()"><code class="function">gwy_selection_clear()</code></a> virtual method.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GwySelectionClass.get-object"></a>get_object</code></em> ()</p></td>
<td class="struct_member_description"><p>The <a class="link" href="GwySelection.html#gwy-selection-get-object" title="gwy_selection_get_object ()"><code class="function">gwy_selection_get_object()</code></a> virtual method.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GwySelectionClass.set-object"></a>set_object</code></em> ()</p></td>
<td class="struct_member_description"><p>The <a class="link" href="GwySelection.html#gwy-selection-set-object" title="gwy_selection_set_object ()"><code class="function">gwy_selection_set_object()</code></a> virtual method.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GwySelectionClass.delete-object"></a>delete_object</code></em> ()</p></td>
<td class="struct_member_description"><p>The <a class="link" href="GwySelection.html#gwy-selection-delete-object" title="gwy_selection_delete_object ()"><code class="function">gwy_selection_delete_object()</code></a> virtual method.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GwySelectionClass.get-data"></a>get_data</code></em> ()</p></td>
<td class="struct_member_description"><p>The <a class="link" href="GwySelection.html#gwy-selection-get-data" title="gwy_selection_get_data ()"><code class="function">gwy_selection_get_data()</code></a> virtual method.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GwySelectionClass.set-data"></a>set_data</code></em> ()</p></td>
<td class="struct_member_description"><p>The <a class="link" href="GwySelection.html#gwy-selection-set-data" title="gwy_selection_set_data ()"><code class="function">gwy_selection_set_data()</code></a> virtual method.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GwySelectionClass.set-max-objects"></a>set_max_objects</code></em> ()</p></td>
<td class="struct_member_description"><p>The <a class="link" href="GwySelection.html#gwy-selection-set-max-objects" title="gwy_selection_set_max_objects ()"><code class="function">gwy_selection_set_max_objects()</code></a> virtual method.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GwySelectionClass.changed"></a>changed</code></em> ()</p></td>
<td class="struct_member_description"><p>The "changed" signal virtual method.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GwySelectionClass.finished"></a>finished</code></em> ()</p></td>
<td class="struct_member_description"><p>The "finished" signal virtual method.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GwySelection.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GwySelection--max-objects"></a><h3>The <code class="literal">“max-objects”</code> property</h3>
<pre class="programlisting"> “max-objects” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
<p>Maximum number of objects that can be selected.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: <= 65536</p>
<p>Default value: 1</p>
</div>
<hr>
<div class="refsect2">
<a name="GwySelection--object-size"></a><h3>The <code class="literal">“object-size”</code> property</h3>
<pre class="programlisting"> “object-size” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
<p>Number of coordinates in one selection object.</p>
<p>Flags: Read</p>
<p>Allowed values: <= 1024</p>
<p>Default value: 0</p>
</div>
</div>
<div class="refsect1">
<a name="GwySelection.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GwySelection-changed"></a><h3>The <code class="literal">“changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a> *gwyselection,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> arg1,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The ::changed signal is emitted whenever selection changes.</p>
<div class="refsect3">
<a name="id-1.7.14.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>gwyselection</p></td>
<td class="parameter_description"><p>The <a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a> which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg1</p></td>
<td class="parameter_description"><p>Changed object position hint. If the value is nonnegative, only
this object has changed. If it's negative, the selection has
to be treated as completely changed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GwySelection-finished"></a><h3>The <code class="literal">“finished”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a> *gwyselection,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The ::finished signal is emitted when selection is finished.</p>
<p>What exactly finished means is defined by corresponding
<a href="../libgwydgets/GwyVectorLayer.html"><span class="type">GwyVectorLayer</span></a>, but normally it involves user stopped changing
a selection object. Selections never emit this signal themselves.</p>
<div class="refsect3">
<a name="id-1.7.14.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>gwyselection</p></td>
<td class="parameter_description"><p>The <a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a> which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p>
</div>
</div>
<div class="refsect1">
<a name="GwySelection.see-also"></a><h2>See Also</h2>
<p><a href="../libgwydgets/GwyVectorLayer.html"><span class="type">GwyVectorLayer</span></a> -- uses <a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a> for selections,
<a href="../libgwydgets/GwyGraphArea.html"><span class="type">GwyGraphArea</span></a> -- uses <a class="link" href="GwySelection.html" title="GwySelection"><span class="type">GwySelection</span></a> for selections</p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.19</div>
</body>
</html>
|