Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtktreeview.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkTreeView
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9
  10 </para>
  11
  12 <!-- ##### SECTION See_Also ##### -->
  13 <para>
  14
  15 </para>
  16
  17 <!-- ##### ENUM GtkTreeViewDropPosition ##### -->
  18 <para>
  19
  20 </para>
  21
  22 @GTK_TREE_VIEW_DROP_BEFORE:
  23 @GTK_TREE_VIEW_DROP_AFTER:
  24 @GTK_TREE_VIEW_DROP_INTO_OR_BEFORE:
  25 @GTK_TREE_VIEW_DROP_INTO_OR_AFTER:
  26
  27 <!-- ##### STRUCT GtkTreeViewPrivate ##### -->
  28 <para>
  29
  30 </para>
  31
  32
  33 <!-- ##### STRUCT GtkTreeSelection ##### -->
  34 <para>
  35
  36 </para>
  37
  38
  39 <!-- ##### STRUCT GtkTreeSelectionClass ##### -->
  40 <para>
  41
  42 </para>
  43
  44
  45 <!-- ##### USER_FUNCTION GtkTreeViewColumnDropFunc ##### -->
  46 <para>
  47
  48 </para>
  49
  50 @tree_view:
  51 @column:
  52 @prev_column:
  53 @next_column:
  54 @data:
  55 @Returns:
  56
  57
  58 <!-- ##### USER_FUNCTION GtkTreeViewDraggableFunc ##### -->
  59 <para>
  60
  61 </para>
  62
  63 @tree_view:
  64 @context:
  65 @path:
  66 @user_data:
  67 @Returns:
  68
  69
  70 <!-- ##### USER_FUNCTION GtkTreeViewMappingFunc ##### -->
  71 <para>
  72
  73 </para>
  74
  75 @tree_view:
  76 @path:
  77 @user_data:
  78
  79
  80 <!-- ##### USER_FUNCTION GtkTreeViewDroppableFunc ##### -->
  81 <para>
  82
  83 </para>
  84
  85 @tree_view:
  86 @context:
  87 @path:
  88 @pos:
  89 @user_data:
  90 @Returns:
  91
  92
  93 <!-- ##### USER_FUNCTION GtkTreeViewSearchEqualFunc ##### -->
  94 <para>
  95
  96 </para>
  97
  98 @model:
  99 @column:
 100 @key:
 101 @iter:
 102 @search_data:
 103 @Returns:
 104
 105
 106 <!-- ##### FUNCTION gtk_tree_view_new ##### -->
 107 <para>
 108
 109 </para>
 110
 111 @Returns:
 112
 113
 114 <!-- ##### FUNCTION gtk_tree_view_new_with_model ##### -->
 115 <para>
 116
 117 </para>
 118
 119 @model:
 120 @Returns:
 121
 122
 123 <!-- ##### FUNCTION gtk_tree_view_get_model ##### -->
 124 <para>
 125
 126 </para>
 127
 128 @tree_view:
 129 @Returns:
 130
 131
 132 <!-- ##### FUNCTION gtk_tree_view_set_model ##### -->
 133 <para>
 134
 135 </para>
 136
 137 @tree_view:
 138 @model:
 139 <!-- # Unused Parameters # -->
 140 @tree_model:
 141
 142
 143 <!-- ##### FUNCTION gtk_tree_view_get_selection ##### -->
 144 <para>
 145
 146 </para>
 147
 148 @tree_view:
 149 @Returns:
 150
 151
 152 <!-- ##### FUNCTION gtk_tree_view_get_hadjustment ##### -->
 153 <para>
 154
 155 </para>
 156
 157 @tree_view:
 158 @Returns:
 159 <!-- # Unused Parameters # -->
 160 @layout:
 161
 162
 163 <!-- ##### FUNCTION gtk_tree_view_set_hadjustment ##### -->
 164 <para>
 165
 166 </para>
 167
 168 @tree_view:
 169 @adjustment:
 170 <!-- # Unused Parameters # -->
 171 @layout:
 172
 173
 174 <!-- ##### FUNCTION gtk_tree_view_get_vadjustment ##### -->
 175 <para>
 176
 177 </para>
 178
 179 @tree_view:
 180 @Returns:
 181 <!-- # Unused Parameters # -->
 182 @layout:
 183
 184
 185 <!-- ##### FUNCTION gtk_tree_view_set_vadjustment ##### -->
 186 <para>
 187
 188 </para>
 189
 190 @tree_view:
 191 @adjustment:
 192 <!-- # Unused Parameters # -->
 193 @layout:
 194
 195
 196 <!-- ##### FUNCTION gtk_tree_view_get_headers_visible ##### -->
 197 <para>
 198
 199 </para>
 200
 201 @tree_view:
 202 @Returns:
 203
 204
 205 <!-- ##### FUNCTION gtk_tree_view_set_headers_visible ##### -->
 206 <para>
 207
 208 </para>
 209
 210 @tree_view:
 211 @headers_visible:
 212
 213
 214 <!-- ##### FUNCTION gtk_tree_view_columns_autosize ##### -->
 215 <para>
 216
 217 </para>
 218
 219 @tree_view:
 220
 221
 222 <!-- ##### FUNCTION gtk_tree_view_set_headers_clickable ##### -->
 223 <para>
 224
 225 </para>
 226
 227 @tree_view:
 228 @setting:
 229 <!-- # Unused Parameters # -->
 230 @active:
 231
 232
 233 <!-- ##### FUNCTION gtk_tree_view_set_rules_hint ##### -->
 234 <para>
 235
 236 </para>
 237
 238 @tree_view:
 239 @setting:
 240
 241
 242 <!-- ##### FUNCTION gtk_tree_view_get_rules_hint ##### -->
 243 <para>
 244
 245 </para>
 246
 247 @tree_view:
 248 @Returns:
 249
 250
 251 <!-- ##### FUNCTION gtk_tree_view_append_column ##### -->
 252 <para>
 253
 254 </para>
 255
 256 @tree_view:
 257 @column:
 258 @Returns:
 259
 260
 261 <!-- ##### FUNCTION gtk_tree_view_remove_column ##### -->
 262 <para>
 263
 264 </para>
 265
 266 @tree_view:
 267 @column:
 268 @Returns:
 269
 270
 271 <!-- ##### FUNCTION gtk_tree_view_insert_column ##### -->
 272 <para>
 273
 274 </para>
 275
 276 @tree_view:
 277 @column:
 278 @position:
 279 @Returns:
 280
 281
 282 <!-- ##### FUNCTION gtk_tree_view_insert_column_with_attributes ##### -->
 283 <para>
 284
 285 </para>
 286
 287 @tree_view:
 288 @position:
 289 @title:
 290 @cell:
 291 @Varargs:
 292 @Returns:
 293
 294
 295 <!-- ##### FUNCTION gtk_tree_view_insert_column_with_data_func ##### -->
 296 <para>
 297
 298 </para>
 299
 300 @tree_view:
 301 @position:
 302 @title:
 303 @cell:
 304 @func:
 305 @data:
 306 @dnotify:
 307 @Returns:
 308
 309
 310 <!-- ##### FUNCTION gtk_tree_view_get_column ##### -->
 311 <para>
 312
 313 </para>
 314
 315 @tree_view:
 316 @n:
 317 @Returns:
 318
 319
 320 <!-- ##### FUNCTION gtk_tree_view_get_columns ##### -->
 321 <para>
 322
 323 </para>
 324
 325 @tree_view:
 326 @Returns:
 327
 328
 329 <!-- ##### FUNCTION gtk_tree_view_move_column_after ##### -->
 330 <para>
 331
 332 </para>
 333
 334 @tree_view:
 335 @column:
 336 @base_column:
 337
 338
 339 <!-- ##### FUNCTION gtk_tree_view_set_expander_column ##### -->
 340 <para>
 341
 342 </para>
 343
 344 @tree_view:
 345 @column:
 346
 347
 348 <!-- ##### FUNCTION gtk_tree_view_get_expander_column ##### -->
 349 <para>
 350
 351 </para>
 352
 353 @tree_view:
 354 @Returns:
 355
 356
 357 <!-- ##### FUNCTION gtk_tree_view_set_column_drag_function ##### -->
 358 <para>
 359
 360 </para>
 361
 362 @tree_view:
 363 @func:
 364 @user_data:
 365 @destroy:
 366
 367
 368 <!-- ##### FUNCTION gtk_tree_view_scroll_to_point ##### -->
 369 <para>
 370
 371 </para>
 372
 373 @tree_view:
 374 @tree_x:
 375 @tree_y:
 376
 377
 378 <!-- ##### FUNCTION gtk_tree_view_scroll_to_cell ##### -->
 379 <para>
 380
 381 </para>
 382
 383 @tree_view:
 384 @path:
 385 @column:
 386 @use_align:
 387 @row_align:
 388 @col_align:
 389
 390
 391 <!-- ##### FUNCTION gtk_tree_view_row_activated ##### -->
 392 <para>
 393
 394 </para>
 395
 396 @tree_view:
 397 @path:
 398 @column:
 399
 400
 401 <!-- ##### FUNCTION gtk_tree_view_expand_all ##### -->
 402 <para>
 403
 404 </para>
 405
 406 @tree_view:
 407
 408
 409 <!-- ##### FUNCTION gtk_tree_view_collapse_all ##### -->
 410 <para>
 411
 412 </para>
 413
 414 @tree_view:
 415
 416
 417 <!-- ##### FUNCTION gtk_tree_view_expand_row ##### -->
 418 <para>
 419
 420 </para>
 421
 422 @tree_view:
 423 @path:
 424 @open_all:
 425 @Returns:
 426
 427
 428 <!-- ##### FUNCTION gtk_tree_view_collapse_row ##### -->
 429 <para>
 430
 431 </para>
 432
 433 @tree_view:
 434 @path:
 435 @Returns:
 436
 437
 438 <!-- ##### FUNCTION gtk_tree_view_map_expanded_rows ##### -->
 439 <para>
 440
 441 </para>
 442
 443 @tree_view:
 444 @func:
 445 @data:
 446
 447
 448 <!-- ##### FUNCTION gtk_tree_view_row_expanded ##### -->
 449 <para>
 450
 451 </para>
 452
 453 @tree_view:
 454 @path:
 455 @Returns:
 456
 457
 458 <!-- ##### FUNCTION gtk_tree_view_set_reorderable ##### -->
 459 <para>
 460
 461 </para>
 462
 463 @tree_view:
 464 @reorderable:
 465
 466
 467 <!-- ##### FUNCTION gtk_tree_view_get_reorderable ##### -->
 468 <para>
 469
 470 </para>
 471
 472 @tree_view:
 473 @Returns:
 474
 475
 476 <!-- ##### FUNCTION gtk_tree_view_set_cursor ##### -->
 477 <para>
 478
 479 </para>
 480
 481 @tree_view:
 482 @path:
 483 @focus_column:
 484 @start_editing:
 485
 486
 487 <!-- ##### FUNCTION gtk_tree_view_get_path_at_pos ##### -->
 488 <para>
 489
 490 </para>
 491
 492 @tree_view:
 493 @window:
 494 @x:
 495 @y:
 496 @path:
 497 @column:
 498 @cell_x:
 499 @cell_y:
 500 @Returns:
 501
 502
 503 <!-- ##### FUNCTION gtk_tree_view_get_cell_area ##### -->
 504 <para>
 505
 506 </para>
 507
 508 @tree_view:
 509 @path:
 510 @column:
 511 @rect:
 512
 513
 514 <!-- ##### FUNCTION gtk_tree_view_get_background_area ##### -->
 515 <para>
 516
 517 </para>
 518
 519 @tree_view:
 520 @path:
 521 @column:
 522 @rect:
 523
 524
 525 <!-- ##### FUNCTION gtk_tree_view_get_visible_rect ##### -->
 526 <para>
 527
 528 </para>
 529
 530 @tree_view:
 531 @visible_rect:
 532
 533
 534 <!-- ##### FUNCTION gtk_tree_view_widget_to_tree_coords ##### -->
 535 <para>
 536
 537 </para>
 538
 539 @tree_view:
 540 @wx:
 541 @wy:
 542 @tx:
 543 @ty:
 544
 545
 546 <!-- ##### FUNCTION gtk_tree_view_tree_to_widget_coords ##### -->
 547 <para>
 548
 549 </para>
 550
 551 @tree_view:
 552 @tx:
 553 @ty:
 554 @wx:
 555 @wy:
 556
 557
 558 <!-- ##### FUNCTION gtk_tree_view_set_rows_drag_source ##### -->
 559 <para>
 560
 561 </para>
 562
 563 @tree_view:
 564 @start_button_mask:
 565 @targets:
 566 @n_targets:
 567 @actions:
 568 @row_draggable_func:
 569 @user_data:
 570
 571
 572 <!-- ##### FUNCTION gtk_tree_view_set_rows_drag_dest ##### -->
 573 <para>
 574
 575 </para>
 576
 577 @tree_view:
 578 @targets:
 579 @n_targets:
 580 @actions:
 581 @location_droppable_func:
 582 @user_data:
 583
 584
 585 <!-- ##### FUNCTION gtk_tree_view_unset_rows_drag_source ##### -->
 586 <para>
 587
 588 </para>
 589
 590 @tree_view:
 591
 592
 593 <!-- ##### FUNCTION gtk_tree_view_unset_rows_drag_dest ##### -->
 594 <para>
 595
 596 </para>
 597
 598 @tree_view:
 599
 600
 601 <!-- ##### FUNCTION gtk_tree_view_set_drag_dest_row ##### -->
 602 <para>
 603
 604 </para>
 605
 606 @tree_view:
 607 @path:
 608 @pos:
 609
 610
 611 <!-- ##### FUNCTION gtk_tree_view_get_drag_dest_row ##### -->
 612 <para>
 613
 614 </para>
 615
 616 @tree_view:
 617 @path:
 618 @pos:
 619
 620
 621 <!-- ##### FUNCTION gtk_tree_view_get_dest_row_at_pos ##### -->
 622 <para>
 623
 624 </para>
 625
 626 @tree_view:
 627 @drag_x:
 628 @drag_y:
 629 @path:
 630 @pos:
 631 @Returns:
 632
 633
 634 <!-- ##### FUNCTION gtk_tree_view_create_row_drag_icon ##### -->
 635 <para>
 636
 637 </para>
 638
 639 @tree_view:
 640 @path:
 641 @Returns:
 642
 643
 644 <!-- ##### FUNCTION gtk_tree_view_set_enable_search ##### -->
 645 <para>
 646
 647 </para>
 648
 649 @tree_view:
 650 @enable_search:
 651 <!-- # Unused Parameters # -->
 652 @use_search:
 653
 654
 655 <!-- ##### FUNCTION gtk_tree_view_get_enable_search ##### -->
 656 <para>
 657
 658 </para>
 659
 660 @tree_view:
 661 @Returns:
 662
 663
 664 <!-- ##### FUNCTION gtk_tree_view_get_search_column ##### -->
 665 <para>
 666
 667 </para>
 668
 669 @tree_view:
 670 @Returns:
 671
 672
 673 <!-- ##### FUNCTION gtk_tree_view_set_search_column ##### -->
 674 <para>
 675
 676 </para>
 677
 678 @tree_view:
 679 @column:
 680
 681
 682 <!-- ##### FUNCTION gtk_tree_view_get_search_equal_func ##### -->
 683 <para>
 684
 685 </para>
 686
 687 @tree_view:
 688 @Returns:
 689
 690
 691 <!-- ##### FUNCTION gtk_tree_view_set_search_equal_func ##### -->
 692 <para>
 693
 694 </para>
 695
 696 @tree_view:
 697 @search_equal_func:
 698 @search_user_data:
 699 @search_destroy:
 700 <!-- # Unused Parameters # -->
 701 @search_compare_func:
 702 @search_data:
 703
 704
 705 <!-- ##### USER_FUNCTION GtkTreeDestroyCountFunc ##### -->
 706 <para>
 707
 708 </para>
 709
 710 @tree_view:
 711 @path:
 712 @children:
 713 @user_data:
 714
 715
 716 <!-- ##### FUNCTION gtk_tree_view_set_destroy_count_func ##### -->
 717 <para>
 718
 719 </para>
 720
 721 @tree_view:
 722 @func:
 723 @data:
 724 @destroy:
 725
 726
 727 <!-- ##### SIGNAL GtkTreeView::columns-changed ##### -->
 728 <para>
 729
 730 </para>
 731
 732 @treeview: the object which received the signal.
 733
 734 <!-- ##### SIGNAL GtkTreeView::expand-collapse-cursor-row ##### -->
 735 <para>
 736
 737 </para>
 738
 739 @treeview: the object which received the signal.
 740 @arg1:
 741 @arg2:
 742 @arg3:
 743
 744 <!-- ##### SIGNAL GtkTreeView::move-cursor ##### -->
 745 <para>
 746
 747 </para>
 748
 749 @treeview: the object which received the signal.
 750 @arg1:
 751 @arg2:
 752
 753 <!-- ##### SIGNAL GtkTreeView::row-activated ##### -->
 754 <para>
 755
 756 </para>
 757
 758 @treeview: the object which received the signal.
 759 @arg1:
 760 @arg2:
 761
 762 <!-- ##### SIGNAL GtkTreeView::row-collapsed ##### -->
 763 <para>
 764
 765 </para>
 766
 767 @treeview: the object which received the signal.
 768 @arg1:
 769 @arg2:
 770
 771 <!-- ##### SIGNAL GtkTreeView::row-expanded ##### -->
 772 <para>
 773
 774 </para>
 775
 776 @treeview: the object which received the signal.
 777 @arg1:
 778 @arg2:
 779
 780 <!-- ##### SIGNAL GtkTreeView::select-cursor-parent ##### -->
 781 <para>
 782
 783 </para>
 784
 785 @treeview: the object which received the signal.
 786
 787 <!-- ##### SIGNAL GtkTreeView::select-cursor-row ##### -->
 788 <para>
 789
 790 </para>
 791
 792 @treeview: the object which received the signal.
 793
 794 <!-- ##### SIGNAL GtkTreeView::set-scroll-adjustments ##### -->
 795 <para>
 796
 797 </para>
 798
 799 @treeview: the object which received the signal.
 800 @arg1:
 801 @arg2:
 802
 803 <!-- ##### SIGNAL GtkTreeView::start-interactive-search ##### -->
 804 <para>
 805
 806 </para>
 807
 808 @treeview: the object which received the signal.
 809
 810 <!-- ##### SIGNAL GtkTreeView::test-collapse-row ##### -->
 811 <para>
 812
 813 </para>
 814
 815 @treeview: the object which received the signal.
 816 @arg1:
 817 @arg2:
 818 @Returns:
 819
 820 <!-- ##### SIGNAL GtkTreeView::test-expand-row ##### -->
 821 <para>
 822
 823 </para>
 824
 825 @treeview: the object which received the signal.
 826 @arg1:
 827 @arg2:
 828 @Returns:
 829
 830 <!-- ##### SIGNAL GtkTreeView::toggle-cursor-row ##### -->
 831 <para>
 832
 833 </para>
 834
 835 @treeview: the object which received the signal.
 836
 837 <!-- ##### ARG GtkTreeView:model ##### -->
 838 <para>
 839
 840 </para>
 841
 842 <!-- ##### ARG GtkTreeView:hadjustment ##### -->
 843 <para>
 844
 845 </para>
 846
 847 <!-- ##### ARG GtkTreeView:vadjustment ##### -->
 848 <para>
 849
 850 </para>
 851
 852 <!-- ##### ARG GtkTreeView:headers-visible ##### -->
 853 <para>
 854
 855 </para>
 856
 857 <!-- ##### ARG GtkTreeView:headers-clickable ##### -->
 858 <para>
 859
 860 </para>
 861
 862 <!-- ##### ARG GtkTreeView:expander-column ##### -->
 863 <para>
 864
 865 </para>
 866
 867 <!-- ##### ARG GtkTreeView:reorderable ##### -->
 868 <para>
 869
 870 </para>
 871
 872 <!-- ##### ARG GtkTreeView:rules-hint ##### -->
 873 <para>
 874
 875 </para>
 876
 877 <!-- ##### ARG GtkTreeView:enable-search ##### -->
 878 <para>
 879
 880 </para>
 881
 882 <!-- ##### ARG GtkTreeView:search-column ##### -->
 883 <para>
 884
 885 </para>
 886