gtkcelllayout.c 29.5 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 19 20 21 22 23
/**
 * SECTION:gtkcelllayout
 * @Short_Description: An interface for packing cells
 * @Title: GtkCellLayout
 *
 * #GtkCellLayout is an interface to be implemented by all objects which
24 25
 * want to provide a #GtkTreeViewColumn like API for packing cells,
 * setting attributes and data funcs.
26
 *
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
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
 *
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 61 62 63 64
 * Furthermore for implementations of GtkCellLayout that use a #GtkCellArea
 * to lay out cells (all GtkCellLayouts in GTK+ use a GtkCellArea)
 * [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.
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
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"
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"
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 151 152 153 154 155 156 157 158 159 160 161 162 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 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,
							  const gchar           *attribute,
							  gint                   column);
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,
							  gint                   position);
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 244 245
gtk_cell_layout_default_add_attribute (GtkCellLayout         *cell_layout,
				       GtkCellRenderer       *cell,
				       const gchar           *attribute,
				       gint                   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 311 312 313 314 315 316 317 318 319 320 321
    }
}

static void
gtk_cell_layout_default_reorder (GtkCellLayout         *cell_layout,
				 GtkCellRenderer       *cell,
				 gint                   position)
{
  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.
Matthias Clasen's avatar
Matthias Clasen committed
361
 *
362 363
 * Since: 2.4
 */
364 365 366 367 368 369 370 371
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));

372
  GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->pack_start (cell_layout, cell, expand);
373 374
}

375 376
/**
 * gtk_cell_layout_pack_end:
377 378 379
 * @cell_layout: a #GtkCellLayout
 * @cell: a #GtkCellRenderer
 * @expand: %TRUE if @cell is to be given extra space allocated to @cell_layout
380 381 382 383 384
 *
 * 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.
 *
385
 * Note that reusing the same cell renderer is not supported.
Matthias Clasen's avatar
Matthias Clasen committed
386
 *
387 388
 * Since: 2.4
 */
389 390 391 392 393 394 395 396
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));

397
  GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->pack_end (cell_layout, cell, expand);
398 399
}

400 401
/**
 * gtk_cell_layout_clear:
402
 * @cell_layout: a #GtkCellLayout
403
 *
404 405
 * Unsets all the mappings on all renderers on @cell_layout and
 * removes all renderers from @cell_layout.
406 407 408
 *
 * Since: 2.4
 */
409 410 411 412 413
void
gtk_cell_layout_clear (GtkCellLayout *cell_layout)
{
  g_return_if_fail (GTK_IS_CELL_LAYOUT (cell_layout));

414
  GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->clear (cell_layout);
415 416 417 418 419 420 421 422 423 424 425 426
}

static void
gtk_cell_layout_set_attributesv (GtkCellLayout   *cell_layout,
                                 GtkCellRenderer *cell,
                                 va_list          args)
{
  gchar *attribute;
  gint column;

  attribute = va_arg (args, gchar *);

427
  gtk_cell_layout_clear_attributes (cell_layout, cell);
428 429 430 431

  while (attribute != NULL)
    {
      column = va_arg (args, gint);
432 433

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

435 436 437 438
      attribute = va_arg (args, gchar *);
    }
}

439 440
/**
 * gtk_cell_layout_set_attributes:
441 442
 * @cell_layout: a #GtkCellLayout
 * @cell: a #GtkCellRenderer
Matthias Clasen's avatar
Matthias Clasen committed
443
 * @...: a %NULL-terminated list of attributes
444 445
 *
 * Sets the attributes in list as the attributes of @cell_layout.
446
 *
447 448 449
 * 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.
450 451 452
 *
 * Since: 2.4
 */
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
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);
}

468 469
/**
 * gtk_cell_layout_add_attribute:
470 471 472 473 474 475
 * @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.
476
 *
477 478 479
 * 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
480
 * “text” attribute of a #GtkCellRendererText get its values from column 2.
481 482 483
 *
 * Since: 2.4
 */
484 485 486 487 488 489 490 491 492 493 494
void
gtk_cell_layout_add_attribute (GtkCellLayout   *cell_layout,
                               GtkCellRenderer *cell,
                               const gchar     *attribute,
                               gint             column)
{
  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);

495
  GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->add_attribute (cell_layout, cell, attribute, column);
496 497
}

498 499
/**
 * gtk_cell_layout_set_cell_data_func:
500 501
 * @cell_layout: a #GtkCellLayout
 * @cell: a #GtkCellRenderer
502
 * @func: (allow-none): the #GtkCellLayoutDataFunc to use, or %NULL
503
 * @func_data: (closure): user data for @func
504 505 506
 * @destroy: destroy notify for @func_data
 *
 * Sets the #GtkCellLayoutDataFunc to use for @cell_layout.
507
 *
508
 * This function is used instead of the standard attributes mapping
509
 * for setting the column value, and should set the value of @cell_layout’s
510 511 512
 * cell renderer(s) as appropriate.
 *
 * @func may be %NULL to remove a previously set function.
513 514 515
 *
 * Since: 2.4
 */
516 517 518 519 520 521 522 523 524 525
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));

526 527
  GTK_CELL_LAYOUT_GET_IFACE 
    (cell_layout)->set_cell_data_func (cell_layout, cell, func, func_data, destroy);
528 529
}

530 531
/**
 * gtk_cell_layout_clear_attributes:
532 533
 * @cell_layout: a #GtkCellLayout
 * @cell: a #GtkCellRenderer to clear the attribute mapping on
534 535 536 537 538 539
 *
 * Clears all existing attributes previously set with
 * gtk_cell_layout_set_attributes().
 *
 * Since: 2.4
 */
540 541 542 543 544 545 546
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));

547
  GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->clear_attributes (cell_layout, cell);
548
}
Kristian Rietveld's avatar
Kristian Rietveld committed
549 550 551

/**
 * gtk_cell_layout_reorder:
552 553 554 555 556
 * @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
557
 *
558 559
 * Note that @cell has already to be packed into @cell_layout
 * for this to function properly.
Kristian Rietveld's avatar
Kristian Rietveld committed
560 561 562 563 564 565 566 567 568 569 570
 *
 * Since: 2.4
 */
void
gtk_cell_layout_reorder (GtkCellLayout   *cell_layout,
                         GtkCellRenderer *cell,
                         gint             position)
{
  g_return_if_fail (GTK_IS_CELL_LAYOUT (cell_layout));
  g_return_if_fail (GTK_IS_CELL_RENDERER (cell));

571
  GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->reorder (cell_layout, cell, position);
Kristian Rietveld's avatar
Kristian Rietveld committed
572
}
573

574 575 576
/**
 * gtk_cell_layout_get_cells:
 * @cell_layout: a #GtkCellLayout
577
 *
578 579
 * Returns the cell renderers which have been added to @cell_layout.
 *
580
 * Returns: (element-type GtkCellRenderer) (transfer container):
581 582 583
 *     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.
584
 *
585 586 587 588 589 590 591
 * Since: 2.12
 */
GList *
gtk_cell_layout_get_cells (GtkCellLayout *cell_layout)
{
  g_return_val_if_fail (GTK_IS_CELL_LAYOUT (cell_layout), NULL);

592
  return GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->get_cells (cell_layout);
593 594
}

595 596 597 598
/**
 * gtk_cell_layout_get_area:
 * @cell_layout: a #GtkCellLayout
 *
599 600 601 602
 * 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.
 *
603 604
 * Returns: (transfer none) (nullable): the cell area used by @cell_layout,
 * or %NULL in case no cell area is used.
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
 *
 * Since: 3.0
 */
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 */
623 624 625
typedef struct {
  GtkCellLayout   *cell_layout;
  GtkCellRenderer *renderer;
626
  GtkBuilder      *builder;
627
  gchar           *attr_name;
628
  GString         *string;
629 630 631 632 633 634 635 636 637 638
} AttributesSubParserData;

static void
attributes_start_element (GMarkupParseContext *context,
			  const gchar         *element_name,
			  const gchar        **names,
			  const gchar        **values,
			  gpointer             user_data,
			  GError             **error)
{
639
  AttributesSubParserData *data = (AttributesSubParserData*)user_data;
640 641

  if (strcmp (element_name, "attribute") == 0)
642
    {
643 644 645 646 647 648 649 650 651 652 653 654 655 656
      const gchar *name;

      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);
657
    }
658
  else if (strcmp (element_name, "attributes") == 0)
659 660 661 662 663 664 665 666 667
    {
      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);
    }
668
  else
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
    {
      _gtk_builder_error_unhandled_tag (data->builder, context,
                                        "GtkCellLayout", element_name,
                                        error);
    }
}

static void
attributes_text_element (GMarkupParseContext  *context,
			 const gchar          *text,
			 gsize                 text_len,
			 gpointer              user_data,
			 GError              **error)
{
  AttributesSubParserData *data = (AttributesSubParserData*)user_data;

  if (data->attr_name)
    g_string_append_len (data->string, text, text_len);
687 688 689
}

static void
690 691 692 693
attributes_end_element (GMarkupParseContext  *context,
			const gchar          *element_name,
			gpointer              user_data,
			GError              **error)
694
{
695 696 697 698
  AttributesSubParserData *data = (AttributesSubParserData*)user_data;
  GValue val = G_VALUE_INIT;

  if (!data->attr_name)
699
    return;
700

701
  if (!gtk_builder_value_from_string_type (data->builder, G_TYPE_INT, data->string->str, &val, error))
702
    {
703 704
      _gtk_builder_prefix_error (data->builder, context, error);
       return;
705 706
    }

707 708 709 710 711 712 713 714 715
  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);
716 717 718 719 720
}

static const GMarkupParser attributes_parser =
  {
    attributes_start_element,
721 722
    attributes_end_element,
    attributes_text_element
723 724
  };

725 726 727 728 729 730 731 732 733 734

/* Cell packing parsing */
static void
gtk_cell_layout_buildable_set_cell_property (GtkCellArea     *area,
					     GtkBuilder      *builder,
					     GtkCellRenderer *cell,
					     gchar           *name,
					     const gchar     *value)
{
  GParamSpec *pspec;
Javier Jardón's avatar
Javier Jardón committed
735
  GValue gvalue = G_VALUE_INIT;
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765
  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;
766
  GString         *string;
767 768 769 770 771 772 773 774 775 776 777 778 779
  gchar           *cell_prop_name;
  gchar           *context;
  gboolean         translatable;
} CellPackingSubParserData;

static void
cell_packing_start_element (GMarkupParseContext *context,
			    const gchar         *element_name,
			    const gchar        **names,
			    const gchar        **values,
			    gpointer             user_data,
			    GError             **error)
{
780
  CellPackingSubParserData *data = (CellPackingSubParserData*)user_data;
781 782 783

  if (strcmp (element_name, "property") == 0)
    {
784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
      const gchar *name;
      gboolean translatable = FALSE;
      const gchar *ctx = NULL;

      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);
805 806
    }
  else if (strcmp (element_name, "cell-packing") == 0)
807 808 809 810 811 812 813 814 815
    {
      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);
    }
816
  else
817 818 819 820 821
    {
      _gtk_builder_error_unhandled_tag (data->builder, context,
                                        "GtkCellLayout", element_name,
                                        error);
    }
822 823 824 825 826 827 828 829 830
}

static void
cell_packing_text_element (GMarkupParseContext *context,
			   const gchar         *text,
			   gsize                text_len,
			   gpointer             user_data,
			   GError             **error)
{
831
  CellPackingSubParserData *data = (CellPackingSubParserData*)user_data;
832

833 834
  if (data->cell_prop_name)
    g_string_append_len (data->string, text, text_len);
835
}
836

837 838 839 840 841 842
static void
cell_packing_end_element (GMarkupParseContext *context,
			  const gchar         *element_name,
			  gpointer             user_data,
			  GError             **error)
{
843
  CellPackingSubParserData *data = (CellPackingSubParserData*)user_data;
844
  GtkCellArea *area;
845

846
  area = gtk_cell_layout_get_area (data->cell_layout);
847

848 849 850
  if (area)
    {
      /* translate the string */
851
      if (data->string->len && data->translatable)
852
	{
853
	  const gchar *translated;
854 855
	  const gchar* domain;

856
	  domain = gtk_builder_get_translation_domain (data->builder);
857 858

	  translated = _gtk_builder_parser_translate (domain,
859 860 861
						      data->context,
						      data->string->str);
	  g_string_assign (data->string, translated);
862
	}
863

864 865 866 867 868 869
      if (data->cell_prop_name)
	gtk_cell_layout_buildable_set_cell_property (area,
						     data->builder,
						     data->renderer,
						     data->cell_prop_name,
						     data->string->str);
870
    }
871 872
  else
    g_warning ("%s does not have an internal GtkCellArea class and cannot apply child cell properties",
873 874 875 876 877 878 879 880
	       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;
881 882
}

883

884 885 886
static const GMarkupParser cell_packing_parser =
  {
    cell_packing_start_element,
887
    cell_packing_end_element,
888
    cell_packing_text_element
889 890
  };

891 892 893 894 895 896 897 898
gboolean
_gtk_cell_layout_buildable_custom_tag_start (GtkBuildable  *buildable,
					     GtkBuilder    *builder,
					     GObject       *child,
					     const gchar   *tagname,
					     GMarkupParser *parser,
					     gpointer      *data)
{
899 900
  AttributesSubParserData  *attr_data;
  CellPackingSubParserData *packing_data;
901 902 903 904 905 906

  if (!child)
    return FALSE;

  if (strcmp (tagname, "attributes") == 0)
    {
907 908 909
      attr_data = g_slice_new0 (AttributesSubParserData);
      attr_data->cell_layout = GTK_CELL_LAYOUT (buildable);
      attr_data->renderer = GTK_CELL_RENDERER (child);
910
      attr_data->builder = builder;
911
      attr_data->attr_name = NULL;
912
      attr_data->string = g_string_new ("");
913 914

      *parser = attributes_parser;
915
      *data = attr_data;
916

917 918 919 920 921
      return TRUE;
    }
  else if (strcmp (tagname, "cell-packing") == 0)
    {
      packing_data = g_slice_new0 (CellPackingSubParserData);
922
      packing_data->string = g_string_new ("");
923 924 925 926 927 928
      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;
929

930 931 932 933 934 935
      return TRUE;
    }

  return FALSE;
}

936
gboolean
937 938 939 940 941 942
_gtk_cell_layout_buildable_custom_tag_end (GtkBuildable *buildable,
					   GtkBuilder   *builder,
					   GObject      *child,
					   const gchar  *tagname,
					   gpointer     *data)
{
943
  AttributesSubParserData *attr_data;
944
  CellPackingSubParserData *packing_data;
945

946 947 948 949
  if (strcmp (tagname, "attributes") == 0)
    {
      attr_data = (AttributesSubParserData*)data;
      g_assert (!attr_data->attr_name);
950
      g_string_free (attr_data->string, TRUE);
951
      g_slice_free (AttributesSubParserData, attr_data);
952

953
      return TRUE;
954 955 956
    }
  else if (strcmp (tagname, "cell-packing") == 0)
    {
957 958 959
      packing_data = (CellPackingSubParserData *)data;
      g_string_free (packing_data->string, TRUE);
      g_slice_free (CellPackingSubParserData, packing_data);
960

961
      return TRUE;
962
    }
963
  return FALSE;
964 965 966
}

void
967 968 969 970
_gtk_cell_layout_buildable_add_child (GtkBuildable      *buildable,
				      GtkBuilder        *builder,
				      GObject           *child,
				      const gchar       *type)
971 972 973 974
{
  g_return_if_fail (GTK_IS_CELL_LAYOUT (buildable));
  g_return_if_fail (GTK_IS_CELL_RENDERER (child));

975
  gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (buildable), GTK_CELL_RENDERER (child), FALSE);
976
}