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

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