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