gtkcelllayout.c 27.6 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
 * as &lt;child&gt; elements in UI definitions. They support a custom
 * &lt;attributes&gt; element for their children, which can contain
 * multiple &lt;attribute&gt; elements. Each &lt;attribute&gt; element has
 * a name attribute which specifies a property of the cell renderer; the
46
 * 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 65 66 67
 * Furthermore for implementations of GtkCellLayout that use a
 * #GtkCellArea to lay out cells (all GtkCellLayouts in GTK+ use
 * a GtkCellArea) <link linkend="cell-properties">cell properties</link>
 * can also be defined in the format by specifying the custom
 * &lt;cell-packing&gt; attribute which can contain multiple
 * &lt;property&gt; elements defined in the normal way.
 *
 * Here is a UI definition fragment specifying cell properties:
68
 *
69
 * |[
70 71 72 73 74 75 76 77 78
 * <object class="GtkTreeViewColumn">
 *   <child>
 *     <object class="GtkCellRendererText"/>
 *     <cell-packing>
 *       <property name="align">True</property>
 *       <property name="expand">False</property>
 *     </cell-packing>
 *   </child>"
 * </object>
79
 * ]|
80
 *
81
 * # Subclassing GtkCellLayout implementations
82
 *
83 84 85 86 87
 * 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
88
 *
89
 * |[<!-- language="C" -->
90
 * combo = g_object_new (GTK_TYPE_COMBO_BOX, "cell-area", my_cell_area, NULL);
91
 * ]|
92
 *
93
 * to use a custom cell area with a combo box. But construct properties
94
 * are only initialized after instance init()
95 96 97 98 99
 * functions have run, which means that using functions which rely on
 * the existence of the cell area in your subclass' init() function will
 * 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).
100
 *
101
 * |[<!-- language="C" -->
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
 * static void
 * my_combo_box_init (MyComboBox *b)
 * {
 *   GtkCellRenderer *cell;
 *
 *   cell = gtk_cell_renderer_pixbuf_new ();
 *   /&ast; The following call causes the default cell area for combo boxes,
 *    &ast; a GtkCellAreaBox, to be instantiated
 *    &ast;/
 *   gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (b), cell, FALSE);
 *   ...
 * }
 *
 * GtkWidget *
 * my_combo_box_new (GtkCellArea *area)
 * {
 *   /&ast; This call is going to cause a warning
 *    &ast; about area being ignored
 *    &ast;/
 *   return g_object_new (MY_TYPE_COMBO_BOX, "cell-area", area, NULL);
 * }
123
 * ]|
124
 *
125 126 127 128 129
 * 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.
130 131
 */

132
#include "config.h"
133 134
#include <string.h>
#include <stdlib.h>
135
#include <errno.h>
Kristian Rietveld's avatar
Kristian Rietveld committed
136
#include "gtkcelllayout.h"
137
#include "gtkbuilderprivate.h"
138
#include "gtkintl.h"
139

140
#define warn_no_cell_area(func)					\
141
  g_critical ("%s: Called but no GtkCellArea is available yet", func)
142

143 144
typedef GtkCellLayoutIface GtkCellLayoutInterface;
G_DEFINE_INTERFACE (GtkCellLayout, gtk_cell_layout, G_TYPE_OBJECT);
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 194 195 196 197
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);

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

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);

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

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);

238 239 240 241
      if (area)
	gtk_cell_layout_clear (GTK_CELL_LAYOUT (area));
      else
	warn_no_cell_area ("GtkCellLayoutIface->clear()");
242 243
    }
}
244

245
static void
246 247 248 249
gtk_cell_layout_default_add_attribute (GtkCellLayout         *cell_layout,
				       GtkCellRenderer       *cell,
				       const gchar           *attribute,
				       gint                   column)
250
{
251 252 253 254 255 256 257 258 259
  GtkCellLayoutIface *iface;
  GtkCellArea        *area;

  iface = GTK_CELL_LAYOUT_GET_IFACE (cell_layout);

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

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

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);

283 284 285 286 287 288
      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()");
289
    }
290 291
}

292 293 294 295 296 297 298 299 300 301 302 303 304
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);

305 306 307 308
      if (area)
	gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (area), cell);
      else
	warn_no_cell_area ("GtkCellLayoutIface->clear_attributes()");
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
    }
}

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);

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

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);

345 346 347 348
      if (area)
	return gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (area));
      else
	warn_no_cell_area ("GtkCellLayoutIface->get_cells()");
349 350 351 352 353
    }
  return NULL;
}


354 355
/**
 * gtk_cell_layout_pack_start:
356 357 358
 * @cell_layout: a #GtkCellLayout
 * @cell: a #GtkCellRenderer
 * @expand: %TRUE if @cell is to be given extra space allocated to @cell_layout
359 360 361 362 363
 *
 * 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.
 *
364
 * Note that reusing the same cell renderer is not supported.
Matthias Clasen's avatar
Matthias Clasen committed
365
 *
366 367
 * Since: 2.4
 */
368 369 370 371 372 373 374 375
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));

376
  GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->pack_start (cell_layout, cell, expand);
377 378
}

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

401
  GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->pack_end (cell_layout, cell, expand);
402 403
}

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

418
  GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->clear (cell_layout);
419 420 421 422 423 424 425 426 427 428 429 430
}

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

  attribute = va_arg (args, gchar *);

431
  gtk_cell_layout_clear_attributes (cell_layout, cell);
432 433 434 435

  while (attribute != NULL)
    {
      column = va_arg (args, gint);
436 437

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

439 440 441 442
      attribute = va_arg (args, gchar *);
    }
}

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

472 473
/**
 * gtk_cell_layout_add_attribute:
474 475 476 477 478 479
 * @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.
480
 *
481 482 483 484
 * 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
 * "text" attribute of a #GtkCellRendererText get its values from column 2.
485 486 487
 *
 * Since: 2.4
 */
488 489 490 491 492 493 494 495 496 497 498
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);

499
  GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->add_attribute (cell_layout, cell, attribute, column);
500 501
}

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

530 531
  GTK_CELL_LAYOUT_GET_IFACE 
    (cell_layout)->set_cell_data_func (cell_layout, cell, func, func_data, destroy);
532 533
}

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

551
  GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->clear_attributes (cell_layout, cell);
552
}
Kristian Rietveld's avatar
Kristian Rietveld committed
553 554 555

/**
 * gtk_cell_layout_reorder:
556 557 558 559 560
 * @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
561
 *
562 563
 * Note that @cell has already to be packed into @cell_layout
 * for this to function properly.
Kristian Rietveld's avatar
Kristian Rietveld committed
564 565 566 567 568 569 570 571 572 573 574
 *
 * 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));

575
  GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->reorder (cell_layout, cell, position);
Kristian Rietveld's avatar
Kristian Rietveld committed
576
}
577

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

596
  return GTK_CELL_LAYOUT_GET_IFACE (cell_layout)->get_cells (cell_layout);
597 598
}

599 600 601 602
/**
 * gtk_cell_layout_get_area:
 * @cell_layout: a #GtkCellLayout
 *
603 604 605 606
 * 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.
 *
607
 * Return value: (transfer none): the cell area used by @cell_layout.
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
 *
 * 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 */
626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
typedef struct {
  GtkCellLayout   *cell_layout;
  GtkCellRenderer *renderer;
  gchar           *attr_name;
} AttributesSubParserData;

static void
attributes_start_element (GMarkupParseContext *context,
			  const gchar         *element_name,
			  const gchar        **names,
			  const gchar        **values,
			  gpointer             user_data,
			  GError             **error)
{
  AttributesSubParserData *parser_data = (AttributesSubParserData*)user_data;
  guint i;

  if (strcmp (element_name, "attribute") == 0)
644 645 646 647 648
    {
      for (i = 0; names[i]; i++)
	if (strcmp (names[i], "name") == 0)
	  parser_data->attr_name = g_strdup (values[i]);
    }
649 650 651 652 653 654 655 656 657 658 659 660 661 662
  else if (strcmp (element_name, "attributes") == 0)
    return;
  else
    g_warning ("Unsupported tag for GtkCellLayout: %s\n", element_name);
}

static void
attributes_text_element (GMarkupParseContext *context,
			 const gchar         *text,
			 gsize                text_len,
			 gpointer             user_data,
			 GError             **error)
{
  AttributesSubParserData *parser_data = (AttributesSubParserData*)user_data;
663 664
  glong l;
  gchar *endptr;
665 666
  gchar *string;
  
667 668
  if (!parser_data->attr_name)
    return;
669

670
  string = g_strndup (text, text_len);
671 672
  errno = 0;
  l = g_ascii_strtoll (string, &endptr, 0);
673
  if (errno || endptr == string)
674 675 676 677 678
    {
      g_set_error (error, 
                   GTK_BUILDER_ERROR,
                   GTK_BUILDER_ERROR_INVALID_VALUE,
                   "Could not parse integer `%s'",
679 680
                   string);
      g_free (string);
681 682
      return;
    }
683
  g_free (string);
684

685 686
  gtk_cell_layout_add_attribute (parser_data->cell_layout,
				 parser_data->renderer,
687
				 parser_data->attr_name, l);
688 689 690 691 692 693 694 695 696 697 698
  g_free (parser_data->attr_name);
  parser_data->attr_name = NULL;
}

static const GMarkupParser attributes_parser =
  {
    attributes_start_element,
    NULL,
    attributes_text_element,
  };

699 700 701 702 703 704 705 706 707 708

/* 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
709
  GValue gvalue = G_VALUE_INIT;
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739
  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;
740
  GString         *string;
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 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
  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)
{
  CellPackingSubParserData *parser_data = (CellPackingSubParserData*)user_data;
  guint i;

  if (strcmp (element_name, "property") == 0)
    {
      for (i = 0; names[i]; i++)
	if (strcmp (names[i], "name") == 0)
	  parser_data->cell_prop_name = g_strdup (values[i]);
	else if (strcmp (names[i], "translatable") == 0)
	  {
	    if (!_gtk_builder_boolean_from_string (values[i],
						   &parser_data->translatable,
						   error))
	      return;
	  }
	else if (strcmp (names[i], "comments") == 0)
	  ; /* for translators */
	else if (strcmp (names[i], "context") == 0)
	  parser_data->context = g_strdup (values[i]);
	else
	  g_warning ("Unsupported attribute for GtkCellLayout Cell "
		     "property: %s\n", names[i]);
    }
  else if (strcmp (element_name, "cell-packing") == 0)
    return;
  else
    g_warning ("Unsupported tag for GtkCellLayout: %s\n", element_name);
}

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

792 793 794
  if (parser_data->cell_prop_name)
    g_string_append_len (parser_data->string, text, text_len);
}
795

796 797 798 799 800 801 802 803
static void
cell_packing_end_element (GMarkupParseContext *context,
			  const gchar         *element_name,
			  gpointer             user_data,
			  GError             **error)
{
  CellPackingSubParserData *parser_data = (CellPackingSubParserData*)user_data;
  GtkCellArea *area;
804

805
  area = gtk_cell_layout_get_area (parser_data->cell_layout);
806

807 808 809 810
  if (area)
    {
      /* translate the string */
      if (parser_data->string->len && parser_data->translatable)
811
	{
812
	  const gchar *translated;
813 814 815 816 817 818 819
	  const gchar* domain;

	  domain = gtk_builder_get_translation_domain (parser_data->builder);

	  translated = _gtk_builder_parser_translate (domain,
						      parser_data->context,
						      parser_data->string->str);
820
	  g_string_assign (parser_data->string, translated);
821
	}
822 823 824 825 826 827 828

      if (parser_data->cell_prop_name)
	gtk_cell_layout_buildable_set_cell_property (area, 
						     parser_data->builder,
						     parser_data->renderer,
						     parser_data->cell_prop_name,
						     parser_data->string->str);
829
    }
830 831 832
  else
    g_warning ("%s does not have an internal GtkCellArea class and cannot apply child cell properties",
	       g_type_name (G_OBJECT_TYPE (parser_data->cell_layout)));
833

834
  g_string_set_size (parser_data->string, 0);
835 836 837 838 839 840 841
  g_free (parser_data->cell_prop_name);
  g_free (parser_data->context);
  parser_data->cell_prop_name = NULL;
  parser_data->context = NULL;
  parser_data->translatable = FALSE;
}

842

843 844 845
static const GMarkupParser cell_packing_parser =
  {
    cell_packing_start_element,
846
    cell_packing_end_element,
847 848 849
    cell_packing_text_element,
  };

850 851 852 853 854 855 856 857
gboolean
_gtk_cell_layout_buildable_custom_tag_start (GtkBuildable  *buildable,
					     GtkBuilder    *builder,
					     GObject       *child,
					     const gchar   *tagname,
					     GMarkupParser *parser,
					     gpointer      *data)
{
858 859
  AttributesSubParserData  *attr_data;
  CellPackingSubParserData *packing_data;
860 861 862 863 864 865

  if (!child)
    return FALSE;

  if (strcmp (tagname, "attributes") == 0)
    {
866 867 868 869
      attr_data = g_slice_new0 (AttributesSubParserData);
      attr_data->cell_layout = GTK_CELL_LAYOUT (buildable);
      attr_data->renderer = GTK_CELL_RENDERER (child);
      attr_data->attr_name = NULL;
870 871

      *parser = attributes_parser;
872 873 874 875 876 877
      *data = attr_data;
      return TRUE;
    }
  else if (strcmp (tagname, "cell-packing") == 0)
    {
      packing_data = g_slice_new0 (CellPackingSubParserData);
878
      packing_data->string = g_string_new ("");
879 880 881 882 883 884
      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;
885 886 887 888 889 890
      return TRUE;
    }

  return FALSE;
}

891
gboolean
892 893 894 895 896 897
_gtk_cell_layout_buildable_custom_tag_end (GtkBuildable *buildable,
					   GtkBuilder   *builder,
					   GObject      *child,
					   const gchar  *tagname,
					   gpointer     *data)
{
898
  AttributesSubParserData *attr_data;
899
  CellPackingSubParserData *packing_data;
900

901 902 903 904 905
  if (strcmp (tagname, "attributes") == 0)
    {
      attr_data = (AttributesSubParserData*)data;
      g_assert (!attr_data->attr_name);
      g_slice_free (AttributesSubParserData, attr_data);
906
      return TRUE;
907 908 909
    }
  else if (strcmp (tagname, "cell-packing") == 0)
    {
910 911 912
      packing_data = (CellPackingSubParserData *)data;
      g_string_free (packing_data->string, TRUE);
      g_slice_free (CellPackingSubParserData, packing_data);
913
      return TRUE;
914
    }
915
  return FALSE;
916 917 918
}

void
919 920 921 922
_gtk_cell_layout_buildable_add_child (GtkBuildable      *buildable,
				      GtkBuilder        *builder,
				      GObject           *child,
				      const gchar       *type)
923 924 925 926
{
  g_return_if_fail (GTK_IS_CELL_LAYOUT (buildable));
  g_return_if_fail (GTK_IS_CELL_RENDERER (child));

927
  gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (buildable), GTK_CELL_RENDERER (child), FALSE);
928
}