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