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_get_cursor ##### -->
 381 <para>
 382
 383 </para>
 384
 385 @tree_view:
 386 @path:
 387 @focus_column:
 388
 389
 390 <!-- ##### FUNCTION gtk_tree_view_row_activated ##### -->
 391 <para>
 392
 393 </para>
 394
 395 @tree_view:
 396 @path:
 397 @column:
 398
 399
 400 <!-- ##### FUNCTION gtk_tree_view_expand_all ##### -->
 401 <para>
 402
 403 </para>
 404
 405 @tree_view:
 406
 407
 408 <!-- ##### FUNCTION gtk_tree_view_collapse_all ##### -->
 409 <para>
 410
 411 </para>
 412
 413 @tree_view:
 414
 415
 416 <!-- ##### FUNCTION gtk_tree_view_expand_row ##### -->
 417 <para>
 418
 419 </para>
 420
 421 @tree_view:
 422 @path:
 423 @open_all:
 424 @Returns:
 425
 426
 427 <!-- ##### FUNCTION gtk_tree_view_collapse_row ##### -->
 428 <para>
 429
 430 </para>
 431
 432 @tree_view:
 433 @path:
 434 @Returns:
 435
 436
 437 <!-- ##### FUNCTION gtk_tree_view_map_expanded_rows ##### -->
 438 <para>
 439
 440 </para>
 441
 442 @tree_view:
 443 @func:
 444 @data:
 445
 446
 447 <!-- ##### FUNCTION gtk_tree_view_row_expanded ##### -->
 448 <para>
 449
 450 </para>
 451
 452 @tree_view:
 453 @path:
 454 @Returns:
 455
 456
 457 <!-- ##### FUNCTION gtk_tree_view_set_reorderable ##### -->
 458 <para>
 459
 460 </para>
 461
 462 @tree_view:
 463 @reorderable:
 464
 465
 466 <!-- ##### FUNCTION gtk_tree_view_get_reorderable ##### -->
 467 <para>
 468
 469 </para>
 470
 471 @tree_view:
 472 @Returns:
 473
 474
 475 <!-- ##### FUNCTION gtk_tree_view_get_path_at_pos ##### -->
 476 <para>
 477
 478 </para>
 479
 480 @tree_view:
 481 @x:
 482 @y:
 483 @path:
 484 @column:
 485 @cell_x:
 486 @cell_y:
 487 @Returns:
 488 <!-- # Unused Parameters # -->
 489 @window:
 490
 491
 492 <!-- ##### FUNCTION gtk_tree_view_get_cell_area ##### -->
 493 <para>
 494
 495 </para>
 496
 497 @tree_view:
 498 @path:
 499 @column:
 500 @rect:
 501
 502
 503 <!-- ##### FUNCTION gtk_tree_view_get_background_area ##### -->
 504 <para>
 505
 506 </para>
 507
 508 @tree_view:
 509 @path:
 510 @column:
 511 @rect:
 512
 513
 514 <!-- ##### FUNCTION gtk_tree_view_get_visible_rect ##### -->
 515 <para>
 516
 517 </para>
 518
 519 @tree_view:
 520 @visible_rect:
 521
 522
 523 <!-- ##### FUNCTION gtk_tree_view_get_bin_window ##### -->
 524 <para>
 525
 526 </para>
 527
 528 @tree_view:
 529 @Returns:
 530
 531
 532 <!-- ##### FUNCTION gtk_tree_view_widget_to_tree_coords ##### -->
 533 <para>
 534
 535 </para>
 536
 537 @tree_view:
 538 @wx:
 539 @wy:
 540 @tx:
 541 @ty:
 542
 543
 544 <!-- ##### FUNCTION gtk_tree_view_tree_to_widget_coords ##### -->
 545 <para>
 546
 547 </para>
 548
 549 @tree_view:
 550 @tx:
 551 @ty:
 552 @wx:
 553 @wy:
 554
 555
 556 <!-- ##### FUNCTION gtk_tree_view_enable_model_drag_dest ##### -->
 557 <para>
 558
 559 </para>
 560
 561 @tree_view:
 562 @targets:
 563 @n_targets:
 564 @actions:
 565
 566
 567 <!-- ##### FUNCTION gtk_tree_view_enable_model_drag_source ##### -->
 568 <para>
 569
 570 </para>
 571
 572 @tree_view:
 573 @start_button_mask:
 574 @targets:
 575 @n_targets:
 576 @actions:
 577
 578
 579 <!-- ##### FUNCTION gtk_tree_view_unset_rows_drag_source ##### -->
 580 <para>
 581
 582 </para>
 583
 584 @tree_view:
 585
 586
 587 <!-- ##### FUNCTION gtk_tree_view_unset_rows_drag_dest ##### -->
 588 <para>
 589
 590 </para>
 591
 592 @tree_view:
 593
 594
 595 <!-- ##### FUNCTION gtk_tree_view_set_drag_dest_row ##### -->
 596 <para>
 597
 598 </para>
 599
 600 @tree_view:
 601 @path:
 602 @pos:
 603
 604
 605 <!-- ##### FUNCTION gtk_tree_view_get_drag_dest_row ##### -->
 606 <para>
 607
 608 </para>
 609
 610 @tree_view:
 611 @path:
 612 @pos:
 613
 614
 615 <!-- ##### FUNCTION gtk_tree_view_get_dest_row_at_pos ##### -->
 616 <para>
 617
 618 </para>
 619
 620 @tree_view:
 621 @drag_x:
 622 @drag_y:
 623 @path:
 624 @pos:
 625 @Returns:
 626
 627
 628 <!-- ##### FUNCTION gtk_tree_view_create_row_drag_icon ##### -->
 629 <para>
 630
 631 </para>
 632
 633 @tree_view:
 634 @path:
 635 @Returns:
 636
 637
 638 <!-- ##### FUNCTION gtk_tree_view_set_enable_search ##### -->
 639 <para>
 640
 641 </para>
 642
 643 @tree_view:
 644 @enable_search:
 645 <!-- # Unused Parameters # -->
 646 @use_search:
 647
 648
 649 <!-- ##### FUNCTION gtk_tree_view_get_enable_search ##### -->
 650 <para>
 651
 652 </para>
 653
 654 @tree_view:
 655 @Returns:
 656
 657
 658 <!-- ##### FUNCTION gtk_tree_view_get_search_column ##### -->
 659 <para>
 660
 661 </para>
 662
 663 @tree_view:
 664 @Returns:
 665
 666
 667 <!-- ##### FUNCTION gtk_tree_view_set_search_column ##### -->
 668 <para>
 669
 670 </para>
 671
 672 @tree_view:
 673 @column:
 674
 675
 676 <!-- ##### FUNCTION gtk_tree_view_get_search_equal_func ##### -->
 677 <para>
 678
 679 </para>
 680
 681 @tree_view:
 682 @Returns:
 683
 684
 685 <!-- ##### FUNCTION gtk_tree_view_set_search_equal_func ##### -->
 686 <para>
 687
 688 </para>
 689
 690 @tree_view:
 691 @search_equal_func:
 692 @search_user_data:
 693 @search_destroy:
 694 <!-- # Unused Parameters # -->
 695 @search_compare_func:
 696 @search_data:
 697
 698
 699 <!-- ##### USER_FUNCTION GtkTreeDestroyCountFunc ##### -->
 700 <para>
 701
 702 </para>
 703
 704 @tree_view:
 705 @path:
 706 @children:
 707 @user_data:
 708
 709
 710 <!-- ##### FUNCTION gtk_tree_view_set_destroy_count_func ##### -->
 711 <para>
 712
 713 </para>
 714
 715 @tree_view:
 716 @func:
 717 @data:
 718 @destroy:
 719
 720
 721 <!-- ##### SIGNAL GtkTreeView::columns-changed ##### -->
 722 <para>
 723
 724 </para>
 725
 726 @treeview: the object which received the signal.
 727
 728 <!-- ##### SIGNAL GtkTreeView::cursor-changed ##### -->
 729 <para>
 730
 731 </para>
 732
 733 @treeview: the object which received the signal.
 734
 735 <!-- ##### SIGNAL GtkTreeView::expand-collapse-cursor-row ##### -->
 736 <para>
 737
 738 </para>
 739
 740 @treeview: the object which received the signal.
 741 @arg1:
 742 @arg2:
 743 @arg3:
 744
 745 <!-- ##### SIGNAL GtkTreeView::move-cursor ##### -->
 746 <para>
 747
 748 </para>
 749
 750 @treeview: the object which received the signal.
 751 @arg1:
 752 @arg2:
 753 @Returns:
 754
 755 <!-- ##### SIGNAL GtkTreeView::row-activated ##### -->
 756 <para>
 757
 758 </para>
 759
 760 @treeview: the object which received the signal.
 761 @arg1:
 762 @arg2:
 763
 764 <!-- ##### SIGNAL GtkTreeView::row-collapsed ##### -->
 765 <para>
 766
 767 </para>
 768
 769 @treeview: the object which received the signal.
 770 @arg1:
 771 @arg2:
 772
 773 <!-- ##### SIGNAL GtkTreeView::row-expanded ##### -->
 774 <para>
 775
 776 </para>
 777
 778 @treeview: the object which received the signal.
 779 @arg1:
 780 @arg2:
 781
 782 <!-- ##### SIGNAL GtkTreeView::select-all ##### -->
 783 <para>
 784
 785 </para>
 786
 787 @treeview: the object which received the signal.
 788
 789 <!-- ##### SIGNAL GtkTreeView::select-cursor-parent ##### -->
 790 <para>
 791
 792 </para>
 793
 794 @treeview: the object which received the signal.
 795
 796 <!-- ##### SIGNAL GtkTreeView::select-cursor-row ##### -->
 797 <para>
 798
 799 </para>
 800
 801 @treeview: the object which received the signal.
 802 @arg1:
 803
 804 <!-- ##### SIGNAL GtkTreeView::set-scroll-adjustments ##### -->
 805 <para>
 806
 807 </para>
 808
 809 @treeview: the object which received the signal.
 810 @arg1:
 811 @arg2:
 812
 813 <!-- ##### SIGNAL GtkTreeView::start-interactive-search ##### -->
 814 <para>
 815
 816 </para>
 817
 818 @treeview: the object which received the signal.
 819
 820 <!-- ##### SIGNAL GtkTreeView::test-collapse-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::test-expand-row ##### -->
 831 <para>
 832
 833 </para>
 834
 835 @treeview: the object which received the signal.
 836 @arg1:
 837 @arg2:
 838 @Returns:
 839
 840 <!-- ##### SIGNAL GtkTreeView::toggle-cursor-row ##### -->
 841 <para>
 842
 843 </para>
 844
 845 @treeview: the object which received the signal.
 846
 847 <!-- ##### SIGNAL GtkTreeView::unselect-all ##### -->
 848 <para>
 849
 850 </para>
 851
 852 @treeview: the object which received the signal.
 853
 854 <!-- ##### ARG GtkTreeView:model ##### -->
 855 <para>
 856
 857 </para>
 858
 859 <!-- ##### ARG GtkTreeView:hadjustment ##### -->
 860 <para>
 861
 862 </para>
 863
 864 <!-- ##### ARG GtkTreeView:vadjustment ##### -->
 865 <para>
 866
 867 </para>
 868
 869 <!-- ##### ARG GtkTreeView:headers-visible ##### -->
 870 <para>
 871
 872 </para>
 873
 874 <!-- ##### ARG GtkTreeView:headers-clickable ##### -->
 875 <para>
 876
 877 </para>
 878
 879 <!-- ##### ARG GtkTreeView:expander-column ##### -->
 880 <para>
 881
 882 </para>
 883
 884 <!-- ##### ARG GtkTreeView:reorderable ##### -->
 885 <para>
 886
 887 </para>
 888
 889 <!-- ##### ARG GtkTreeView:rules-hint ##### -->
 890 <para>
 891
 892 </para>
 893
 894 <!-- ##### ARG GtkTreeView:enable-search ##### -->
 895 <para>
 896
 897 </para>
 898
 899 <!-- ##### ARG GtkTreeView:search-column ##### -->
 900 <para>
 901
 902 </para>
 903
 904 <!-- ##### ARG GtkTreeView:indent-expanders ##### -->
 905 <para>
 906
 907 </para>
 908
 909 <!-- ##### ARG GtkTreeView:horizontal-separator ##### -->
 910 <para>
 911
 912 </para>
 913
 914 <!-- ##### ARG GtkTreeView:expander-size ##### -->
 915 <para>
 916
 917 </para>
 918
 919 <!-- ##### ARG GtkTreeView:vertical-separator ##### -->
 920 <para>
 921
 922 </para>
 923
 924 <!-- ##### ARG GtkTreeView:allow-rules ##### -->
 925 <para>
 926
 927 </para>
 928