gtkcelllayout.c 30.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/* gtkcelllayout.c
 * Copyright (C) 2003  Kristian Rietveld  <kris@gtk.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
16 17
 */

18
/**
Matthias Clasen's avatar
Matthias Clasen committed
19 20 21
 * GtkCellLayout:
 *
 * An interface for packing cells
22 23
 *
 * #GtkCellLayout is an interface to be implemented by all objects which
Matthias Clasen's avatar
Matthias Clasen committed
24 25
 * want to provide a #GtkTreeViewColumn like API for packing cells,
 * setting attributes and data funcs.
26
 *
Matthias Clasen's avatar
Matthias Clasen committed
27 28
 * One of the notable features provided by implementations of 
 * GtkCellLayout are attributes. Attributes let you set the properties
29
 * in flexible ways. They can just be set to constant values like regular
30 31
 * properties. But they can also be mapped to a column of the underlying
 * tree model with gtk_cell_layout_set_attributes(), which means that the value
Matthias Clasen's avatar
Matthias Clasen committed
32 33 34 35 36
 * of the attribute can change from cell to cell as they are rendered by
 * the cell renderer. Finally, it is possible to specify a function with
 * gtk_cell_layout_set_cell_data_func() that is called to determine the
 * value of the attribute for each cell that is rendered.
 *
37
 * # GtkCellLayouts as GtkBuildable
38
 *
39
 * Implementations of GtkCellLayout which also implement the GtkBuildable
40
 * interface (#GtkCellView, #GtkIconView, #GtkComboBox,
41
 * #GtkEntryCompletion, #GtkTreeViewColumn) accept GtkCellRenderer objects
42 43 44 45 46
 * as <child> elements in UI definitions. They support a custom <attributes>
 * element for their children, which can contain multiple <attribute>
 * elements. Each <attribute> element has a name attribute which specifies
 * a property of the cell renderer; the content of the element is the
 * attribute value.
47
 *
Matthias Clasen's avatar
Matthias Clasen committed
48
 * This is an example of a UI definition fragment specifying attributes:
49
 * |[
50 51 52 53 54 55 56 57
 * <object class="GtkCellView">
 *   <child>
 *     <object class="GtkCellRendererText"/>
 *     <attributes>
 *       <attribute name="text">0</attribute>
 *     </attributes>
 *   </child>"
 * </object>
58
 * ]|
59
 *
60
 * Furthermore for implementations of GtkCellLayout that use a #GtkCellArea
Matthias Clasen's avatar
Matthias Clasen committed
61
 * to lay out cells (all GtkCellLayouts in GTK use a GtkCellArea)
62 63 64
 * [cell properties][cell-properties] can also be defined in the format by
 * specifying the custom <cell-packing> attribute which can contain multiple
 * <property> elements defined in the normal way.
Matthias Clasen's avatar
Matthias Clasen committed
65 66
 *
 * Here is a UI definition fragment specifying cell properties:
67
 *
68
 * |[
69 70 71 72 73 74 75 76 77
 * <object class="GtkTreeViewColumn">
 *   <child>
 *     <object class="GtkCellRendererText"/>
 *     <cell-packing>
 *       <property name="align">True</property>
 *       <property name="expand">False</property>
 *     </cell-packing>
 *   </child>"
 * </object>
78
 * ]|
79
 *
80
 * # Subclassing GtkCellLayout implementations
Matthias Clasen's avatar
Matthias Clasen committed
81
 *
82 83 84 85 86
 * When subclassing a widget that implements #GtkCellLayout like
 * #GtkIconView or #GtkComboBox, there are some considerations related
 * to the fact that these widgets internally use a #GtkCellArea.
 * The cell area is exposed as a construct-only property by these
 * widgets. This means that it is possible to e.g. do
87
 *
88
 * |[<!-- language="C" -->
89
 * combo = g_object_new (GTK_TYPE_COMBO_BOX, "cell-area", my_cell_area, NULL);
90
 * ]|
91
 *
92
 * to use a custom cell area with a combo box. But construct properties
93
 * are only initialized after instance init()
94
 * functions have run, which means that using functions which rely on
95
 * the existence of the cell area in your subclass’ init() function will
96 97 98
 * cause the default cell area to be instantiated. In this case, a provided
 * construct property value will be ignored (with a warning, to alert
 * you to the problem).
99
 *
100
 * |[<!-- language="C" -->
101 102 103 104 105 106
 * static void
 * my_combo_box_init (MyComboBox *b)
 * {
 *   GtkCellRenderer *cell;
 *
 *   cell = gtk_cell_renderer_pixbuf_new ();
107 108
 *   // The following call causes the default cell area for combo boxes,
 *   // a GtkCellAreaBox, to be instantiated
109 110 111 112 113 114 115
 *   gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (b), cell, FALSE);
 *   ...
 * }
 *
 * GtkWidget *
 * my_combo_box_new (GtkCellArea *area)
 * {
116
 *   // This call is going to cause a warning about area being ignored
117 118
 *   return g_object_new (MY_TYPE_COMBO_BOX, "cell-area", area, NULL);
 * }
119
 * ]|
120
 *
121 122 123 124 125
 * If supporting alternative cell areas with your derived widget is
 * not important, then this does not have to concern you. If you want
 * to support alternative cell areas, you can do so by moving the
 * problematic calls out of init() and into a constructor()
 * for your class.
126 127
 */

128
#include "config.h"
Johan Dahlin's avatar
Johan Dahlin committed
129 130
#include <string.h>
#include <stdlib.h>
131
#include <errno.h>
Kristian Rietveld's avatar
Kristian Rietveld committed
132
#include "gtkcelllayout.h"
133
#include "gtkbuilderprivate.h"
Matthias Clasen's avatar
Matthias Clasen committed
134
#include "gtkintl.h"
135

136
#define warn_no_cell_area(func)					\
137
  g_critical ("%s: Called but no GtkCellArea is available yet", func)
138

139 140
typedef GtkCellLayoutIface GtkCellLayoutInterface;
G_DEFINE_INTERFACE (GtkCellLayout, gtk_cell_layout, G_TYPE_OBJECT);
141

142 143 144 145 146 147 148 149 150
static void   gtk_cell_layout_default_pack_start         (GtkCellLayout         *cell_layout,
							  GtkCellRenderer       *cell,
							  gboolean               expand);
static void   gtk_cell_layout_default_pack_end           (GtkCellLayout         *cell_layout,
							  GtkCellRenderer       *cell,
							  gboolean               expand);
static void   gtk_cell_layout_default_clear              (GtkCellLayout         *cell_layout);
static void   gtk_cell_layout_default_add_attribute      (GtkCellLayout         *cell_layout,
							  GtkCellRenderer       *cell,
Benjamin Otte's avatar
Benjamin Otte committed
151
							  const char            *attribute,
Benjamin Otte's avatar
Benjamin Otte committed
152
							  int                    column);
153 154 155 156 157 158 159 160 161
static void   gtk_cell_layout_default_set_cell_data_func (GtkCellLayout         *cell_layout,
							  GtkCellRenderer       *cell,
							  GtkCellLayoutDataFunc  func,
							  gpointer               func_data,
							  GDestroyNotify         destroy);
static void   gtk_cell_layout_default_clear_attributes   (GtkCellLayout         *cell_layout,
							  GtkCellRenderer       *cell);
static void   gtk_cell_layout_default_reorder            (GtkCellLayout         *cell_layout,
							  GtkCellRenderer       *cell,
Benjamin Otte's avatar
Benjamin Otte committed
162
							  int                    position);
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
static GList *gtk_cell_layout_default_get_cells          (GtkCellLayout         *cell_layout);


static void
gtk_cell_layout_default_init (GtkCellLayoutIface *iface)
{
  iface->pack_start         = gtk_cell_layout_default_pack_start;
  iface->pack_end           = gtk_cell_layout_default_pack_end;
  iface->clear              = gtk_cell_layout_default_clear;
  iface->add_attribute      = gtk_cell_layout_default_add_attribute;
  iface->set_cell_data_func = gtk_cell_layout_default_set_cell_data_func;
  iface->clear_attributes   = gtk_cell_layout_default_clear_attributes;
  iface->reorder            = gtk_cell_layout_default_reorder;
  iface->get_cells          = gtk_cell_layout_default_get_cells;
}

/* Default implementation is to fall back on an underlying cell area */
static void
gtk_cell_layout_default_pack_start (GtkCellLayout         *cell_layout,
				    GtkCellRenderer       *cell,
				    gboolean               expand)
{
  GtkCellLayoutIface *iface;
  GtkCellArea        *area;

  iface = GTK_CELL_LAYOUT_GET_IFACE (cell_layout);

  if (iface->get_area)
    {
      area = iface->get_area (cell_layout);

194 195 196 197
      if (area)
	gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (area), cell, expand);
      else
	warn_no_cell_area ("GtkCellLayoutIface->pack_start()");
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
    }
}

static void
gtk_cell_layout_default_pack_end (GtkCellLayout         *cell_layout,
				  GtkCellRenderer       *cell,
				  gboolean               expand)
{
  GtkCellLayoutIface *iface;
  GtkCellArea        *area;

  iface = GTK_CELL_LAYOUT_GET_IFACE (cell_layout);

  if (iface->get_area)
    {
      area = iface->get_area (cell_layout);

215 216 217 218
      if (area)
	gtk_cell_layout_pack_end (GTK_CELL_LAYOUT (area), cell, expand);
      else
	warn_no_cell_area ("GtkCellLayoutIface->pack_end()");
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
    }
}

static void
gtk_cell_layout_default_clear (GtkCellLayout *cell_layout)
{
  GtkCellLayoutIface *iface;
  GtkCellArea        *area;

  iface = GTK_CELL_LAYOUT_GET_IFACE (cell_layout);

  if (iface->get_area)
    {
      area = iface->get_area (cell_layout);

234 235 236 237
      if (area)
	gtk_cell_layout_clear (GTK_CELL_LAYOUT (area));
      else
	warn_no_cell_area ("GtkCellLayoutIface->clear()");
238 239
    }
}
240

241
static void
242 243
gtk_cell_layout_default_add_attribute (GtkCellLayout         *cell_layout,
				       GtkCellRenderer       *cell,
Benjamin Otte's avatar
Benjamin Otte committed
244
				       const char            *attribute,
Benjamin Otte's avatar
Benjamin Otte committed
245
				       int                    column)
246
{
247 248 249 250 251 252 253 254 255
  GtkCellLayoutIface *iface;
  GtkCellArea        *area;

  iface = GTK_CELL_LAYOUT_GET_IFACE (cell_layout);

  if (iface->get_area)
    {
      area = iface->get_area (cell_layout);

256 257 258 259
      if (area)
	gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (area), cell, attribute, column);
      else
	warn_no_cell_area ("GtkCellLayoutIface->add_attribute()");
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
    }
}

static void
gtk_cell_layout_default_set_cell_data_func (GtkCellLayout         *cell_layout,
					    GtkCellRenderer       *cell,
					    GtkCellLayoutDataFunc  func,
					    gpointer               func_data,
					    GDestroyNotify         destroy)
{
  GtkCellLayoutIface *iface;
  GtkCellArea        *area;

  iface = GTK_CELL_LAYOUT_GET_IFACE (cell_layout);

  if (iface->get_area)
    {
      area = iface->get_area (cell_layout);

279 280 281 282 283 284
      if (area)
	_gtk_cell_area_set_cell_data_func_with_proxy (area, cell, 
						      (GFunc)func, func_data, destroy, 
						      cell_layout);
      else
	warn_no_cell_area ("GtkCellLayoutIface->set_cell_data_func()");
285
    }
286 287
}

288 289 290 291 292 293 294 295 296 297 298 299 300
static void
gtk_cell_layout_default_clear_attributes (GtkCellLayout         *cell_layout,
					  GtkCellRenderer       *cell)
{
  GtkCellLayoutIface *iface;
  GtkCellArea        *area;

  iface = GTK_CELL_LAYOUT_GET_IFACE (cell_layout);

  if (iface->get_area)
    {
      area = iface->get_area (cell_layout);

301 302 303 304
      if (area)
	gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (area), cell);
      else
	warn_no_cell_area ("GtkCellLayoutIface->clear_attributes()");
305 306 307 308 309 310
    }
}

static void
gtk_cell_layout_default_reorder (GtkCellLayout         *cell_layout,
				 GtkCellRenderer       *cell,
Benjamin Otte's avatar
Benjamin Otte committed
311
				 int                    position)
312 313 314 315 316 317 318 319 320 321
{
  GtkCellLayoutIface *iface;
  GtkCellArea        *area;

  iface = GTK_CELL_LAYOUT_GET_IFACE (cell_layout);

  if (iface->get_area)
    {
      area = iface->get_area (cell_layout);

322 323 324 325
      if (area)
	gtk_cell_layout_reorder (GTK_CELL_LAYOUT (area), cell, position);
      else
	warn_no_cell_area ("GtkCellLayoutIface->reorder()");
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
    }
}

static GList *
gtk_cell_layout_default_get_cells (GtkCellLayout *cell_layout)
{
  GtkCellLayoutIface *iface;
  GtkCellArea        *area;

  iface = GTK_CELL_LAYOUT_GET_IFACE (cell_layout);

  if (iface->get_area)
    {
      area = iface->get_area (cell_layout);

341 342 343 344
      if (area)
	return gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (area));
      else
	warn_no_cell_area ("GtkCellLayoutIface->get_cells()");
345 346 347 348 349
    }
  return NULL;
}


350 351
/**
 * gtk_cell_layout_pack_start:
352 353 354
 * @cell_layout: a #GtkCellLayout
 * @cell: a #GtkCellRenderer
 * @expand: %TRUE if @cell is to be given extra space allocated to @cell_layout
355 356 357 358 359
 *
 * Packs the @cell into the beginning of @cell_layout. If @expand is %FALSE,
 * then the @cell is allocated no more space than it needs. Any unused space
 * is divided evenly between cells for which @expand is %TRUE.
 *
360
 * Note that reusing the same cell renderer is not supported.
361
 */
362 363 364 365 366 367 368 369
void
gtk_cell_layout_pack_start (GtkCellLayout   *cell_layout,
                            GtkCellRenderer *cell,
                            gboolean         expand)
{
  g_return_if_fail (GTK_IS_CELL_LAYOUT (cell_layout));
  g_return_if_fail (GTK_IS_CELL_RENDERER (cell));

370
  GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->pack_start (cell_layout, cell, expand);
371 372
}

373 374
/**
 * gtk_cell_layout_pack_end:
375 376 377
 * @cell_layout: a #GtkCellLayout
 * @cell: a #GtkCellRenderer
 * @expand: %TRUE if @cell is to be given extra space allocated to @cell_layout
378 379 380 381 382
 *
 * Adds the @cell to the end of @cell_layout. If @expand is %FALSE, then the
 * @cell is allocated no more space than it needs. Any unused space is
 * divided evenly between cells for which @expand is %TRUE.
 *
383
 * Note that reusing the same cell renderer is not supported.
384
 */
385 386 387 388 389 390 391 392
void
gtk_cell_layout_pack_end (GtkCellLayout   *cell_layout,
                          GtkCellRenderer *cell,
                          gboolean         expand)
{
  g_return_if_fail (GTK_IS_CELL_LAYOUT (cell_layout));
  g_return_if_fail (GTK_IS_CELL_RENDERER (cell));

393
  GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->pack_end (cell_layout, cell, expand);
394 395
}

396 397
/**
 * gtk_cell_layout_clear:
398
 * @cell_layout: a #GtkCellLayout
399
 *
400 401
 * Unsets all the mappings on all renderers on @cell_layout and
 * removes all renderers from @cell_layout.
402
 */
403 404 405 406 407
void
gtk_cell_layout_clear (GtkCellLayout *cell_layout)
{
  g_return_if_fail (GTK_IS_CELL_LAYOUT (cell_layout));

408
  GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->clear (cell_layout);
409 410 411 412 413 414 415
}

static void
gtk_cell_layout_set_attributesv (GtkCellLayout   *cell_layout,
                                 GtkCellRenderer *cell,
                                 va_list          args)
{
Benjamin Otte's avatar
Benjamin Otte committed
416
  char *attribute;
Benjamin Otte's avatar
Benjamin Otte committed
417
  int column;
418

Benjamin Otte's avatar
Benjamin Otte committed
419
  attribute = va_arg (args, char *);
420

421
  gtk_cell_layout_clear_attributes (cell_layout, cell);
422 423 424

  while (attribute != NULL)
    {
Benjamin Otte's avatar
Benjamin Otte committed
425
      column = va_arg (args, int);
426 427

      gtk_cell_layout_add_attribute (cell_layout, cell, attribute, column);
428

Benjamin Otte's avatar
Benjamin Otte committed
429
      attribute = va_arg (args, char *);
430 431 432
    }
}

433 434
/**
 * gtk_cell_layout_set_attributes:
435 436
 * @cell_layout: a #GtkCellLayout
 * @cell: a #GtkCellRenderer
Matthias Clasen's avatar
Matthias Clasen committed
437
 * @...: a %NULL-terminated list of attributes
438 439
 *
 * Sets the attributes in list as the attributes of @cell_layout.
440
 *
441 442 443
 * The attributes should be in attribute/column order, as in
 * gtk_cell_layout_add_attribute(). All existing attributes are
 * removed, and replaced with the new attributes.
444
 */
445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
void
gtk_cell_layout_set_attributes (GtkCellLayout   *cell_layout,
                                GtkCellRenderer *cell,
                                ...)
{
  va_list args;

  g_return_if_fail (GTK_IS_CELL_LAYOUT (cell_layout));
  g_return_if_fail (GTK_IS_CELL_RENDERER (cell));

  va_start (args, cell);
  gtk_cell_layout_set_attributesv (cell_layout, cell, args);
  va_end (args);
}

460 461
/**
 * gtk_cell_layout_add_attribute:
462 463 464 465 466 467
 * @cell_layout: a #GtkCellLayout
 * @cell: a #GtkCellRenderer
 * @attribute: an attribute on the renderer
 * @column: the column position on the model to get the attribute from
 *
 * Adds an attribute mapping to the list in @cell_layout.
468
 *
469 470 471
 * The @column is the column of the model to get a value from, and the
 * @attribute is the parameter on @cell to be set from the value. So for
 * example if column 2 of the model contains strings, you could have the
William Jon McCann's avatar
William Jon McCann committed
472
 * “text” attribute of a #GtkCellRendererText get its values from column 2.
473
 */
474 475 476
void
gtk_cell_layout_add_attribute (GtkCellLayout   *cell_layout,
                               GtkCellRenderer *cell,
Benjamin Otte's avatar
Benjamin Otte committed
477
                               const char      *attribute,
Benjamin Otte's avatar
Benjamin Otte committed
478
                               int              column)
479 480 481 482 483 484
{
  g_return_if_fail (GTK_IS_CELL_LAYOUT (cell_layout));
  g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
  g_return_if_fail (attribute != NULL);
  g_return_if_fail (column >= 0);

485
  GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->add_attribute (cell_layout, cell, attribute, column);
486 487
}

488 489
/**
 * gtk_cell_layout_set_cell_data_func:
490 491
 * @cell_layout: a #GtkCellLayout
 * @cell: a #GtkCellRenderer
492
 * @func: (allow-none): the #GtkCellLayoutDataFunc to use, or %NULL
493
 * @func_data: (closure): user data for @func
494 495 496
 * @destroy: destroy notify for @func_data
 *
 * Sets the #GtkCellLayoutDataFunc to use for @cell_layout.
497
 *
498
 * This function is used instead of the standard attributes mapping
499
 * for setting the column value, and should set the value of @cell_layout’s
500 501 502
 * cell renderer(s) as appropriate.
 *
 * @func may be %NULL to remove a previously set function.
503
 */
504 505 506 507 508 509 510 511 512 513
void
gtk_cell_layout_set_cell_data_func (GtkCellLayout         *cell_layout,
                                    GtkCellRenderer       *cell,
                                    GtkCellLayoutDataFunc  func,
                                    gpointer               func_data,
                                    GDestroyNotify         destroy)
{
  g_return_if_fail (GTK_IS_CELL_LAYOUT (cell_layout));
  g_return_if_fail (GTK_IS_CELL_RENDERER (cell));

514 515
  GTK_CELL_LAYOUT_GET_IFACE 
    (cell_layout)->set_cell_data_func (cell_layout, cell, func, func_data, destroy);
516 517
}

518 519
/**
 * gtk_cell_layout_clear_attributes:
520 521
 * @cell_layout: a #GtkCellLayout
 * @cell: a #GtkCellRenderer to clear the attribute mapping on
522 523 524 525
 *
 * Clears all existing attributes previously set with
 * gtk_cell_layout_set_attributes().
 */
526 527 528 529 530 531 532
void
gtk_cell_layout_clear_attributes (GtkCellLayout   *cell_layout,
                                  GtkCellRenderer *cell)
{
  g_return_if_fail (GTK_IS_CELL_LAYOUT (cell_layout));
  g_return_if_fail (GTK_IS_CELL_RENDERER (cell));

533
  GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->clear_attributes (cell_layout, cell);
534
}
Kristian Rietveld's avatar
Kristian Rietveld committed
535 536 537

/**
 * gtk_cell_layout_reorder:
538 539 540 541 542
 * @cell_layout: a #GtkCellLayout
 * @cell: a #GtkCellRenderer to reorder
 * @position: new position to insert @cell at
 *
 * Re-inserts @cell at @position.
Kristian Rietveld's avatar
Kristian Rietveld committed
543
 *
544 545
 * Note that @cell has already to be packed into @cell_layout
 * for this to function properly.
Kristian Rietveld's avatar
Kristian Rietveld committed
546 547 548 549
 */
void
gtk_cell_layout_reorder (GtkCellLayout   *cell_layout,
                         GtkCellRenderer *cell,
Benjamin Otte's avatar
Benjamin Otte committed
550
                         int              position)
Kristian Rietveld's avatar
Kristian Rietveld committed
551 552 553 554
{
  g_return_if_fail (GTK_IS_CELL_LAYOUT (cell_layout));
  g_return_if_fail (GTK_IS_CELL_RENDERER (cell));

555
  GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->reorder (cell_layout, cell, position);
Kristian Rietveld's avatar
Kristian Rietveld committed
556
}
557

558 559 560
/**
 * gtk_cell_layout_get_cells:
 * @cell_layout: a #GtkCellLayout
561
 *
562 563
 * Returns the cell renderers which have been added to @cell_layout.
 *
564
 * Returns: (element-type GtkCellRenderer) (transfer container):
565 566 567
 *     a list of cell renderers. The list, but not the renderers has
 *     been newly allocated and should be freed with g_list_free()
 *     when no longer needed.
568 569 570 571 572 573
 */
GList *
gtk_cell_layout_get_cells (GtkCellLayout *cell_layout)
{
  g_return_val_if_fail (GTK_IS_CELL_LAYOUT (cell_layout), NULL);

574
  return GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->get_cells (cell_layout);
575 576
}

577 578 579 580
/**
 * gtk_cell_layout_get_area:
 * @cell_layout: a #GtkCellLayout
 *
581 582 583 584
 * Returns the underlying #GtkCellArea which might be @cell_layout
 * if called on a #GtkCellArea or might be %NULL if no #GtkCellArea
 * is used by @cell_layout.
 *
585 586
 * Returns: (transfer none) (nullable): the cell area used by @cell_layout,
 * or %NULL in case no cell area is used.
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
 */
GtkCellArea *
gtk_cell_layout_get_area (GtkCellLayout *cell_layout)
{
  GtkCellLayoutIface *iface;

  g_return_val_if_fail (GTK_IS_CELL_LAYOUT (cell_layout), NULL);

  iface = GTK_CELL_LAYOUT_GET_IFACE (cell_layout);  
  if (iface->get_area)
    return iface->get_area (cell_layout);

  return NULL;
}

/* Attribute parsing */
Johan Dahlin's avatar
Johan Dahlin committed
603 604 605
typedef struct {
  GtkCellLayout   *cell_layout;
  GtkCellRenderer *renderer;
606
  GtkBuilder      *builder;
Benjamin Otte's avatar
Benjamin Otte committed
607
  char            *attr_name;
608
  GString         *string;
Johan Dahlin's avatar
Johan Dahlin committed
609 610 611
} AttributesSubParserData;

static void
612
attributes_start_element (GtkBuildableParseContext *context,
Benjamin Otte's avatar
Benjamin Otte committed
613 614 615
                          const char               *element_name,
                          const char              **names,
                          const char              **values,
616 617
                          gpointer                  user_data,
                          GError                  **error)
Johan Dahlin's avatar
Johan Dahlin committed
618
{
619
  AttributesSubParserData *data = (AttributesSubParserData*)user_data;
Johan Dahlin's avatar
Johan Dahlin committed
620 621

  if (strcmp (element_name, "attribute") == 0)
Matthias Clasen's avatar
Matthias Clasen committed
622
    {
Benjamin Otte's avatar
Benjamin Otte committed
623
      const char *name;
624 625 626 627 628 629 630 631 632 633 634 635 636

      if (!_gtk_builder_check_parent (data->builder, context, "attributes", error))
        return;

      if (!g_markup_collect_attributes (element_name, names, values, error,
                                        G_MARKUP_COLLECT_STRING, "name", &name,
                                        G_MARKUP_COLLECT_INVALID))
        {
          _gtk_builder_prefix_error (data->builder, context, error);
          return;
        }

      data->attr_name = g_strdup (name);
Matthias Clasen's avatar
Matthias Clasen committed
637
    }
Johan Dahlin's avatar
Johan Dahlin committed
638
  else if (strcmp (element_name, "attributes") == 0)
639 640 641 642 643 644 645 646 647
    {
      if (!_gtk_builder_check_parent (data->builder, context, "child", error))
        return;

      if (!g_markup_collect_attributes (element_name, names, values, error,
                                        G_MARKUP_COLLECT_INVALID, NULL, NULL,
                                        G_MARKUP_COLLECT_INVALID))
        _gtk_builder_prefix_error (data->builder, context, error);
    }
Johan Dahlin's avatar
Johan Dahlin committed
648
  else
649 650 651 652 653 654 655 656
    {
      _gtk_builder_error_unhandled_tag (data->builder, context,
                                        "GtkCellLayout", element_name,
                                        error);
    }
}

static void
657
attributes_text_element (GtkBuildableParseContext  *context,
Benjamin Otte's avatar
Benjamin Otte committed
658
                         const char                *text,
659 660 661
                         gsize                      text_len,
                         gpointer                   user_data,
                         GError                   **error)
662 663 664 665 666
{
  AttributesSubParserData *data = (AttributesSubParserData*)user_data;

  if (data->attr_name)
    g_string_append_len (data->string, text, text_len);
Johan Dahlin's avatar
Johan Dahlin committed
667 668 669
}

static void
670
attributes_end_element (GtkBuildableParseContext  *context,
Benjamin Otte's avatar
Benjamin Otte committed
671
                        const char                *element_name,
672 673
                        gpointer                   user_data,
                        GError                   **error)
Johan Dahlin's avatar
Johan Dahlin committed
674
{
675 676 677 678
  AttributesSubParserData *data = (AttributesSubParserData*)user_data;
  GValue val = G_VALUE_INIT;

  if (!data->attr_name)
Johan Dahlin's avatar
Johan Dahlin committed
679
    return;
680

681
  if (!gtk_builder_value_from_string_type (data->builder, G_TYPE_INT, data->string->str, &val, error))
682
    {
683 684
      _gtk_builder_prefix_error (data->builder, context, error);
       return;
685 686
    }

687 688 689 690 691 692 693 694 695
  gtk_cell_layout_add_attribute (data->cell_layout,
				 data->renderer,
				 data->attr_name,
                                 g_value_get_int (&val));

  g_free (data->attr_name);
  data->attr_name = NULL;

  g_string_set_size (data->string, 0);
Johan Dahlin's avatar
Johan Dahlin committed
696 697
}

698
static const GtkBuildableParser attributes_parser =
Johan Dahlin's avatar
Johan Dahlin committed
699 700
  {
    attributes_start_element,
701 702
    attributes_end_element,
    attributes_text_element
Johan Dahlin's avatar
Johan Dahlin committed
703 704
  };

705 706 707 708 709 710

/* Cell packing parsing */
static void
gtk_cell_layout_buildable_set_cell_property (GtkCellArea     *area,
					     GtkBuilder      *builder,
					     GtkCellRenderer *cell,
Benjamin Otte's avatar
Benjamin Otte committed
711 712
					     char            *name,
					     const char      *value)
713 714
{
  GParamSpec *pspec;
Javier Jardón's avatar
Javier Jardón committed
715
  GValue gvalue = G_VALUE_INIT;
716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745
  GError *error = NULL;

  pspec = gtk_cell_area_class_find_cell_property (GTK_CELL_AREA_GET_CLASS (area), name);
  if (!pspec)
    {
      g_warning ("%s does not have a property called %s",
		 g_type_name (G_OBJECT_TYPE (area)), name);
      return;
    }

  if (!gtk_builder_value_from_string (builder, pspec, value, &gvalue, &error))
    {
      g_warning ("Could not read property %s:%s with value %s of type %s: %s",
		 g_type_name (G_OBJECT_TYPE (area)),
		 name,
		 value,
		 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspec)),
		 error->message);
      g_error_free (error);
      return;
    }

  gtk_cell_area_cell_set_property (area, cell, name, &gvalue);
  g_value_unset (&gvalue);
}

typedef struct {
  GtkBuilder      *builder;
  GtkCellLayout   *cell_layout;
  GtkCellRenderer *renderer;
746
  GString         *string;
Benjamin Otte's avatar
Benjamin Otte committed
747 748
  char            *cell_prop_name;
  char            *context;
749 750 751 752
  gboolean         translatable;
} CellPackingSubParserData;

static void
753
cell_packing_start_element (GtkBuildableParseContext *context,
Benjamin Otte's avatar
Benjamin Otte committed
754 755 756
                            const char               *element_name,
                            const char              **names,
                            const char              **values,
757 758
                            gpointer                  user_data,
                            GError                  **error)
759
{
760
  CellPackingSubParserData *data = (CellPackingSubParserData*)user_data;
761 762 763

  if (strcmp (element_name, "property") == 0)
    {
Benjamin Otte's avatar
Benjamin Otte committed
764
      const char *name;
765
      gboolean translatable = FALSE;
Benjamin Otte's avatar
Benjamin Otte committed
766
      const char *ctx = NULL;
767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784

      if (!_gtk_builder_check_parent (data->builder, context, "cell-packing", error))
        return;

      if (!g_markup_collect_attributes (element_name, names, values, error,
                                        G_MARKUP_COLLECT_STRING, "name", &name,
                                        G_MARKUP_COLLECT_BOOLEAN|G_MARKUP_COLLECT_OPTIONAL, "translatable", &translatable,
                                        G_MARKUP_COLLECT_STRING|G_MARKUP_COLLECT_OPTIONAL, "comments", NULL,
                                        G_MARKUP_COLLECT_STRING|G_MARKUP_COLLECT_OPTIONAL, "context", &ctx,
                                        G_MARKUP_COLLECT_INVALID))
       {
         _gtk_builder_prefix_error (data->builder, context, error);
         return;
       }

      data->cell_prop_name = g_strdup (name);
      data->translatable = translatable;
      data->context = g_strdup (ctx);
785 786
    }
  else if (strcmp (element_name, "cell-packing") == 0)
787 788 789 790 791 792 793 794 795
    {
      if (!_gtk_builder_check_parent (data->builder, context, "child", error))
        return;

      if (!g_markup_collect_attributes (element_name, names, values, error,
                                        G_MARKUP_COLLECT_INVALID, NULL, NULL,
                                        G_MARKUP_COLLECT_INVALID))
        _gtk_builder_prefix_error (data->builder, context, error);
    }
796
  else
797 798 799 800 801
    {
      _gtk_builder_error_unhandled_tag (data->builder, context,
                                        "GtkCellLayout", element_name,
                                        error);
    }
802 803 804
}

static void
805
cell_packing_text_element (GtkBuildableParseContext *context,
Benjamin Otte's avatar
Benjamin Otte committed
806
                           const char               *text,
807 808 809
                           gsize                     text_len,
                           gpointer                  user_data,
                           GError                  **error)
810
{
811
  CellPackingSubParserData *data = (CellPackingSubParserData*)user_data;
812

813 814
  if (data->cell_prop_name)
    g_string_append_len (data->string, text, text_len);
815
}
816

817
static void
818
cell_packing_end_element (GtkBuildableParseContext *context,
Benjamin Otte's avatar
Benjamin Otte committed
819
                          const char               *element_name,
820 821
                          gpointer                  user_data,
                          GError                  **error)
822
{
823
  CellPackingSubParserData *data = (CellPackingSubParserData*)user_data;
824
  GtkCellArea *area;
825

826
  area = gtk_cell_layout_get_area (data->cell_layout);
827

828 829 830
  if (area)
    {
      /* translate the string */
831
      if (data->string->len && data->translatable)
832
	{
Benjamin Otte's avatar
Benjamin Otte committed
833 834
	  const char *translated;
	  const char * domain;
835

836
	  domain = gtk_builder_get_translation_domain (data->builder);
837 838

	  translated = _gtk_builder_parser_translate (domain,
839 840 841
						      data->context,
						      data->string->str);
	  g_string_assign (data->string, translated);
842
	}
843

844 845 846 847 848 849
      if (data->cell_prop_name)
	gtk_cell_layout_buildable_set_cell_property (area,
						     data->builder,
						     data->renderer,
						     data->cell_prop_name,
						     data->string->str);
850
    }
851 852
  else
    g_warning ("%s does not have an internal GtkCellArea class and cannot apply child cell properties",
853 854 855 856 857 858 859 860
	       g_type_name (G_OBJECT_TYPE (data->cell_layout)));

  g_string_set_size (data->string, 0);
  g_free (data->cell_prop_name);
  g_free (data->context);
  data->cell_prop_name = NULL;
  data->context = NULL;
  data->translatable = FALSE;
861 862
}

863

864
static const GtkBuildableParser cell_packing_parser =
865 866
  {
    cell_packing_start_element,
867
    cell_packing_end_element,
868
    cell_packing_text_element
869 870
  };

Johan Dahlin's avatar
Johan Dahlin committed
871
gboolean
872 873 874
_gtk_cell_layout_buildable_custom_tag_start (GtkBuildable       *buildable,
                                             GtkBuilder         *builder,
                                             GObject            *child,
Benjamin Otte's avatar
Benjamin Otte committed
875
                                             const char         *tagname,
876 877
                                             GtkBuildableParser *parser,
                                             gpointer           *data)
Johan Dahlin's avatar
Johan Dahlin committed
878
{
879 880
  AttributesSubParserData  *attr_data;
  CellPackingSubParserData *packing_data;
Johan Dahlin's avatar
Johan Dahlin committed
881 882 883 884 885 886

  if (!child)
    return FALSE;

  if (strcmp (tagname, "attributes") == 0)
    {
887 888 889
      attr_data = g_slice_new0 (AttributesSubParserData);
      attr_data->cell_layout = GTK_CELL_LAYOUT (buildable);
      attr_data->renderer = GTK_CELL_RENDERER (child);
890
      attr_data->builder = builder;
891
      attr_data->attr_name = NULL;
892
      attr_data->string = g_string_new ("");
Johan Dahlin's avatar
Johan Dahlin committed
893 894

      *parser = attributes_parser;
895
      *data = attr_data;
896

897 898 899 900 901
      return TRUE;
    }
  else if (strcmp (tagname, "cell-packing") == 0)
    {
      packing_data = g_slice_new0 (CellPackingSubParserData);
902
      packing_data->string = g_string_new ("");
903 904 905 906 907 908
      packing_data->builder = builder;
      packing_data->cell_layout = GTK_CELL_LAYOUT (buildable);
      packing_data->renderer = GTK_CELL_RENDERER (child);

      *parser = cell_packing_parser;
      *data = packing_data;
909

Johan Dahlin's avatar
Johan Dahlin committed
910 911 912 913 914 915
      return TRUE;
    }

  return FALSE;
}

916
gboolean
Johan Dahlin's avatar
Johan Dahlin committed
917 918 919
_gtk_cell_layout_buildable_custom_tag_end (GtkBuildable *buildable,
					   GtkBuilder   *builder,
					   GObject      *child,
Benjamin Otte's avatar
Benjamin Otte committed
920
					   const char   *tagname,
Johan Dahlin's avatar
Johan Dahlin committed
921 922
					   gpointer     *data)
{
923
  AttributesSubParserData *attr_data;
924
  CellPackingSubParserData *packing_data;
Johan Dahlin's avatar
Johan Dahlin committed
925

926 927 928 929
  if (strcmp (tagname, "attributes") == 0)
    {
      attr_data = (AttributesSubParserData*)data;
      g_assert (!attr_data->attr_name);
930
      g_string_free (attr_data->string, TRUE);
931
      g_slice_free (AttributesSubParserData, attr_data);
932

933
      return TRUE;
934 935 936
    }
  else if (strcmp (tagname, "cell-packing") == 0)
    {
937 938 939
      packing_data = (CellPackingSubParserData *)data;
      g_string_free (packing_data->string, TRUE);
      g_slice_free (CellPackingSubParserData, packing_data);
940

941
      return TRUE;
942
    }
943
  return FALSE;
Johan Dahlin's avatar
Johan Dahlin committed
944 945 946
}

void
947 948 949
_gtk_cell_layout_buildable_add_child (GtkBuildable      *buildable,
				      GtkBuilder        *builder,
				      GObject           *child,
Benjamin Otte's avatar
Benjamin Otte committed
950
				      const char        *type)
Johan Dahlin's avatar
Johan Dahlin committed
951 952 953 954
{
  g_return_if_fail (GTK_IS_CELL_LAYOUT (buildable));
  g_return_if_fail (GTK_IS_CELL_RENDERER (child));

955
  gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (buildable), GTK_CELL_RENDERER (child), FALSE);
Johan Dahlin's avatar
Johan Dahlin committed
956
}