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