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