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

   1 <!-- ##### SECTION Title ##### -->
   2 GtkTreeViewColumn
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A visible column in a GtkTreeView widget
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The GtkTreeViewColumn object represents a visible column in a #GtkTreeView widget.
  10 It allows to set properties of the column header, and functions as a holding pen for
  11 the cell renderers which determine how the data in the column is displayed.
  12 </para>
  13
  14 <para>
  15 Please refer to the <link linkend="TreeWidget">tree widget conceptual overview</link>
  16 for an overview of all the objects and data types related to the tree widget and how
  17 they work together.
  18 </para>
  19
  20 <!-- ##### SECTION See_Also ##### -->
  21 <para>
  22 #GtkTreeView, #GtkTreeSelection, #GtkTreeDnd, #GtkTreeMode, #GtkTreeSortable, #GtkTreeModelSort, #GtkListStore, #GtkTreeStore, #GtkCellRenderer, #GtkCellEditable, #GtkCellRendererPixbuf, #GtkCellRendererText, #GtkCellRendererToggle
  23
  24 </para>
  25
  26 <!-- ##### SECTION Stability_Level ##### -->
  27
  28
  29 <!-- ##### ENUM GtkTreeViewColumnSizing ##### -->
  30 <para>
  31 The sizing method the column uses to determine its width.  Please note
  32 that @GTK_TREE_VIEW_COLUMN_AUTOSIZE are inefficient for large views, and
  33 can make columns appear choppy.
  34 </para>
  35
  36 @GTK_TREE_VIEW_COLUMN_GROW_ONLY: Columns only get bigger in reaction to changes in the model
  37 @GTK_TREE_VIEW_COLUMN_AUTOSIZE: Columns resize to be the optimal size everytime the model changes.
  38 @GTK_TREE_VIEW_COLUMN_FIXED: Columns are a fixed numbers of pixels wide.
  39
  40 <!-- ##### USER_FUNCTION GtkTreeCellDataFunc ##### -->
  41 <para>
  42 A function to set the properties of a cell instead of just using the
  43 straight mapping between the cell and the model.  This is useful for
  44 customizing the cell renderer.  For example, a function might get an
  45 integer from the @tree_model, and render it to the "text" attribute of
  46 "cell" by converting it to its written equivilent.  This is set by
  47 calling gtk_tree_view_column_set_cell_data_func()
  48 </para>
  49
  50 @tree_column: A #GtkTreeColumn
  51 @cell: The #GtkCellRenderer that is being rendered by @tree_column
  52 @tree_model: The #GtkTreeModel being rendered
  53 @iter: A #GtkTreeIter of the current row rendered
  54 @data: user data
  55
  56
  57 <!-- ##### STRUCT GtkTreeViewColumn ##### -->
  58 <para>
  59
  60 </para>
  61
  62
  63 <!-- ##### SIGNAL GtkTreeViewColumn::clicked ##### -->
  64 <para>
  65
  66 </para>
  67
  68 @treeviewcolumn: the object which received the signal.
  69
  70 <!-- ##### ARG GtkTreeViewColumn:alignment ##### -->
  71 <para>
  72
  73 </para>
  74
  75 <!-- ##### ARG GtkTreeViewColumn:clickable ##### -->
  76 <para>
  77
  78 </para>
  79
  80 <!-- ##### ARG GtkTreeViewColumn:expand ##### -->
  81 <para>
  82
  83 </para>
  84
  85 <!-- ##### ARG GtkTreeViewColumn:fixed-width ##### -->
  86 <para>
  87
  88 </para>
  89
  90 <!-- ##### ARG GtkTreeViewColumn:max-width ##### -->
  91 <para>
  92
  93 </para>
  94
  95 <!-- ##### ARG GtkTreeViewColumn:min-width ##### -->
  96 <para>
  97
  98 </para>
  99
 100 <!-- ##### ARG GtkTreeViewColumn:reorderable ##### -->
 101 <para>
 102
 103 </para>
 104
 105 <!-- ##### ARG GtkTreeViewColumn:resizable ##### -->
 106 <para>
 107
 108 </para>
 109
 110 <!-- ##### ARG GtkTreeViewColumn:sizing ##### -->
 111 <para>
 112
 113 </para>
 114
 115 <!-- ##### ARG GtkTreeViewColumn:sort-column-id ##### -->
 116 <para>
 117
 118 </para>
 119
 120 <!-- ##### ARG GtkTreeViewColumn:sort-indicator ##### -->
 121 <para>
 122
 123 </para>
 124
 125 <!-- ##### ARG GtkTreeViewColumn:sort-order ##### -->
 126 <para>
 127
 128 </para>
 129
 130 <!-- ##### ARG GtkTreeViewColumn:spacing ##### -->
 131 <para>
 132
 133 </para>
 134
 135 <!-- ##### ARG GtkTreeViewColumn:title ##### -->
 136 <para>
 137
 138 </para>
 139
 140 <!-- ##### ARG GtkTreeViewColumn:visible ##### -->
 141 <para>
 142
 143 </para>
 144
 145 <!-- ##### ARG GtkTreeViewColumn:widget ##### -->
 146 <para>
 147
 148 </para>
 149
 150 <!-- ##### ARG GtkTreeViewColumn:width ##### -->
 151 <para>
 152
 153 </para>
 154
 155 <!-- ##### FUNCTION gtk_tree_view_column_new ##### -->
 156 <para>
 157
 158 </para>
 159
 160 @Returns:
 161
 162
 163 <!-- ##### FUNCTION gtk_tree_view_column_new_with_attributes ##### -->
 164 <para>
 165
 166 </para>
 167
 168 @title:
 169 @cell:
 170 @Varargs:
 171 @Returns:
 172
 173
 174 <!-- ##### FUNCTION gtk_tree_view_column_pack_start ##### -->
 175 <para>
 176
 177 </para>
 178
 179 @tree_column:
 180 @cell:
 181 @expand:
 182
 183
 184 <!-- ##### FUNCTION gtk_tree_view_column_pack_end ##### -->
 185 <para>
 186
 187 </para>
 188
 189 @tree_column:
 190 @cell:
 191 @expand:
 192
 193
 194 <!-- ##### FUNCTION gtk_tree_view_column_clear ##### -->
 195 <para>
 196
 197 </para>
 198
 199 @tree_column:
 200
 201
 202 <!-- ##### FUNCTION gtk_tree_view_column_add_attribute ##### -->
 203 <para>
 204
 205 </para>
 206
 207 @tree_column:
 208 @cell_renderer:
 209 @attribute:
 210 @column:
 211
 212
 213 <!-- ##### FUNCTION gtk_tree_view_column_set_attributes ##### -->
 214 <para>
 215
 216 </para>
 217
 218 @tree_column:
 219 @cell_renderer:
 220 @Varargs:
 221
 222
 223 <!-- ##### FUNCTION gtk_tree_view_column_set_cell_data_func ##### -->
 224 <para>
 225
 226 </para>
 227
 228 @tree_column:
 229 @cell_renderer:
 230 @func:
 231 @func_data:
 232 @destroy:
 233
 234
 235 <!-- ##### FUNCTION gtk_tree_view_column_clear_attributes ##### -->
 236 <para>
 237
 238 </para>
 239
 240 @tree_column:
 241 @cell_renderer:
 242
 243
 244 <!-- ##### FUNCTION gtk_tree_view_column_set_spacing ##### -->
 245 <para>
 246
 247 </para>
 248
 249 @tree_column:
 250 @spacing:
 251
 252
 253 <!-- ##### FUNCTION gtk_tree_view_column_get_spacing ##### -->
 254 <para>
 255
 256 </para>
 257
 258 @tree_column:
 259 @Returns:
 260
 261
 262 <!-- ##### FUNCTION gtk_tree_view_column_set_visible ##### -->
 263 <para>
 264
 265 </para>
 266
 267 @tree_column:
 268 @visible:
 269
 270
 271 <!-- ##### FUNCTION gtk_tree_view_column_get_visible ##### -->
 272 <para>
 273
 274 </para>
 275
 276 @tree_column:
 277 @Returns:
 278
 279
 280 <!-- ##### FUNCTION gtk_tree_view_column_set_resizable ##### -->
 281 <para>
 282
 283 </para>
 284
 285 @tree_column:
 286 @resizable:
 287
 288
 289 <!-- ##### FUNCTION gtk_tree_view_column_get_resizable ##### -->
 290 <para>
 291
 292 </para>
 293
 294 @tree_column:
 295 @Returns:
 296
 297
 298 <!-- ##### FUNCTION gtk_tree_view_column_set_sizing ##### -->
 299 <para>
 300
 301 </para>
 302
 303 @tree_column:
 304 @type:
 305
 306
 307 <!-- ##### FUNCTION gtk_tree_view_column_get_sizing ##### -->
 308 <para>
 309
 310 </para>
 311
 312 @tree_column:
 313 @Returns:
 314
 315
 316 <!-- ##### FUNCTION gtk_tree_view_column_get_width ##### -->
 317 <para>
 318
 319 </para>
 320
 321 @tree_column:
 322 @Returns:
 323
 324
 325 <!-- ##### FUNCTION gtk_tree_view_column_get_fixed_width ##### -->
 326 <para>
 327
 328 </para>
 329
 330 @tree_column:
 331 @Returns:
 332
 333
 334 <!-- ##### FUNCTION gtk_tree_view_column_set_fixed_width ##### -->
 335 <para>
 336
 337 </para>
 338
 339 @tree_column:
 340 @fixed_width:
 341
 342
 343 <!-- ##### FUNCTION gtk_tree_view_column_set_min_width ##### -->
 344 <para>
 345
 346 </para>
 347
 348 @tree_column:
 349 @min_width:
 350
 351
 352 <!-- ##### FUNCTION gtk_tree_view_column_get_min_width ##### -->
 353 <para>
 354
 355 </para>
 356
 357 @tree_column:
 358 @Returns:
 359
 360
 361 <!-- ##### FUNCTION gtk_tree_view_column_set_max_width ##### -->
 362 <para>
 363
 364 </para>
 365
 366 @tree_column:
 367 @max_width:
 368
 369
 370 <!-- ##### FUNCTION gtk_tree_view_column_get_max_width ##### -->
 371 <para>
 372
 373 </para>
 374
 375 @tree_column:
 376 @Returns:
 377
 378
 379 <!-- ##### FUNCTION gtk_tree_view_column_clicked ##### -->
 380 <para>
 381
 382 </para>
 383
 384 @tree_column:
 385
 386
 387 <!-- ##### FUNCTION gtk_tree_view_column_set_title ##### -->
 388 <para>
 389
 390 </para>
 391
 392 @tree_column:
 393 @title:
 394
 395
 396 <!-- ##### FUNCTION gtk_tree_view_column_get_title ##### -->
 397 <para>
 398
 399 </para>
 400
 401 @tree_column:
 402 @Returns:
 403
 404
 405 <!-- ##### FUNCTION gtk_tree_view_column_set_expand ##### -->
 406 <para>
 407
 408 </para>
 409
 410 @tree_column:
 411 @expand:
 412
 413
 414 <!-- ##### FUNCTION gtk_tree_view_column_get_expand ##### -->
 415 <para>
 416
 417 </para>
 418
 419 @tree_column:
 420 @Returns:
 421
 422
 423 <!-- ##### FUNCTION gtk_tree_view_column_set_clickable ##### -->
 424 <para>
 425
 426 </para>
 427
 428 @tree_column:
 429 @clickable:
 430
 431
 432 <!-- ##### FUNCTION gtk_tree_view_column_get_clickable ##### -->
 433 <para>
 434
 435 </para>
 436
 437 @tree_column:
 438 @Returns:
 439
 440
 441 <!-- ##### FUNCTION gtk_tree_view_column_set_widget ##### -->
 442 <para>
 443
 444 </para>
 445
 446 @tree_column:
 447 @widget:
 448
 449
 450 <!-- ##### FUNCTION gtk_tree_view_column_get_widget ##### -->
 451 <para>
 452
 453 </para>
 454
 455 @tree_column:
 456 @Returns:
 457
 458
 459 <!-- ##### FUNCTION gtk_tree_view_column_set_alignment ##### -->
 460 <para>
 461
 462 </para>
 463
 464 @tree_column:
 465 @xalign:
 466
 467
 468 <!-- ##### FUNCTION gtk_tree_view_column_get_alignment ##### -->
 469 <para>
 470
 471 </para>
 472
 473 @tree_column:
 474 @Returns:
 475
 476
 477 <!-- ##### FUNCTION gtk_tree_view_column_set_reorderable ##### -->
 478 <para>
 479
 480 </para>
 481
 482 @tree_column:
 483 @reorderable:
 484
 485
 486 <!-- ##### FUNCTION gtk_tree_view_column_get_reorderable ##### -->
 487 <para>
 488
 489 </para>
 490
 491 @tree_column:
 492 @Returns:
 493
 494
 495 <!-- ##### FUNCTION gtk_tree_view_column_set_sort_column_id ##### -->
 496 <para>
 497
 498 </para>
 499
 500 @tree_column:
 501 @sort_column_id:
 502
 503
 504 <!-- ##### FUNCTION gtk_tree_view_column_get_sort_column_id ##### -->
 505 <para>
 506
 507 </para>
 508
 509 @tree_column:
 510 @Returns:
 511
 512
 513 <!-- ##### FUNCTION gtk_tree_view_column_set_sort_indicator ##### -->
 514 <para>
 515
 516 </para>
 517
 518 @tree_column:
 519 @setting:
 520
 521
 522 <!-- ##### FUNCTION gtk_tree_view_column_get_sort_indicator ##### -->
 523 <para>
 524
 525 </para>
 526
 527 @tree_column:
 528 @Returns:
 529
 530
 531 <!-- ##### FUNCTION gtk_tree_view_column_set_sort_order ##### -->
 532 <para>
 533
 534 </para>
 535
 536 @tree_column:
 537 @order:
 538
 539
 540 <!-- ##### FUNCTION gtk_tree_view_column_get_sort_order ##### -->
 541 <para>
 542
 543 </para>
 544
 545 @tree_column:
 546 @Returns:
 547
 548
 549 <!-- ##### FUNCTION gtk_tree_view_column_cell_set_cell_data ##### -->
 550 <para>
 551
 552 </para>
 553
 554 @tree_column:
 555 @tree_model:
 556 @iter:
 557 @is_expander:
 558 @is_expanded:
 559
 560
 561 <!-- ##### FUNCTION gtk_tree_view_column_cell_get_size ##### -->
 562 <para>
 563
 564 </para>
 565
 566 @tree_column:
 567 @cell_area:
 568 @x_offset:
 569 @y_offset:
 570 @width:
 571 @height:
 572
 573
 574 <!-- ##### FUNCTION gtk_tree_view_column_cell_get_position ##### -->
 575 <para>
 576
 577 </para>
 578
 579 @tree_column:
 580 @cell_renderer:
 581 @start_pos:
 582 @width:
 583 @Returns:
 584
 585
 586 <!-- ##### FUNCTION gtk_tree_view_column_cell_is_visible ##### -->
 587 <para>
 588
 589 </para>
 590
 591 @tree_column:
 592 @Returns:
 593
 594
 595 <!-- ##### FUNCTION gtk_tree_view_column_focus_cell ##### -->
 596 <para>
 597
 598 </para>
 599
 600 @tree_column:
 601 @cell:
 602
 603
 604 <!-- ##### FUNCTION gtk_tree_view_column_queue_resize ##### -->
 605 <para>
 606
 607 </para>
 608
 609 @tree_column:
 610
 611
 612 <!-- ##### FUNCTION gtk_tree_view_column_get_tree_view ##### -->
 613 <para>
 614
 615 </para>
 616
 617 @tree_column:
 618 @Returns:
 619
 620