adg/adg-table-style.c

   1 /* ADG - Automatic Drawing Generation
   2  * Copyright (C) 2007,2008,2009 Nicola Fontana <ntd at entidi.it>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17  * Boston, MA  02110-1301, USA.
  18  */
  19
  20
  21 /**
  22  * SECTION:adg-table-style
  23  * @short_description: Customization of table rendering
  24  *
  25  * Contains parameters on how to build tables such as the lines to
  26  * use for frames and grids and the font dresses for titles or values.
  27  */
  28
  29 /**
  30  * AdgTableStyle:
  31  *
  32  * All fields are private and should not be used directly.
  33  * Use its public methods instead.
  34  **/
  35
  36
  37 #include "adg-table-style.h"
  38 #include "adg-table-style-private.h"
  39 #include "adg-dress-builtins.h"
  40 #include "adg-font-style.h"
  41 #include "adg-line-style.h"
  42 #include "adg-intl.h"
  43 #include "adg-util.h"
  44
  45
  46 enum {
  47     PROP_0,
  48     PROP_COLOR_DRESS,
  49     PROP_GRID_DRESS,
  50     PROP_FRAME_DRESS,
  51     PROP_TITLE_DRESS,
  52     PROP_VALUE_DRESS,
  53     PROP_ROW_HEIGHT,
  54     PROP_CELL_PADDING,
  55     PROP_CELL_SPACING
  56 };
  57
  58
  59 static void             get_property            (GObject        *object,
  60                                                  guint           prop_id,
  61                                                  GValue         *value,
  62                                                  GParamSpec     *pspec);
  63 static void             set_property            (GObject        *object,
  64                                                  guint           prop_id,
  65                                                  const GValue   *value,
  66                                                  GParamSpec     *pspec);
  67 static void             apply                   (AdgStyle       *style,
  68                                                  AdgEntity      *entity,
  69                                                  cairo_t        *cr);
  70
  71
  72 G_DEFINE_TYPE(AdgTableStyle, adg_table_style, ADG_TYPE_STYLE);
  73
  74
  75 static void
  76 adg_table_style_class_init(AdgTableStyleClass *klass)
  77 {
  78     GObjectClass *gobject_class;
  79     AdgStyleClass *style_class;
  80     GParamSpec *param;
  81
  82     gobject_class = (GObjectClass *) klass;
  83     style_class = (AdgStyleClass *) klass;
  84
  85     g_type_class_add_private(klass, sizeof(AdgTableStylePrivate));
  86
  87     gobject_class->get_property = get_property;
  88     gobject_class->set_property = set_property;
  89
  90     style_class->apply = apply;
  91
  92     param = adg_param_spec_dress("color-dress",
  93                                   P_("Color Dress"),
  94                                   P_("Color dress for the whole tableension"),
  95                                   ADG_DRESS_COLOR,
  96                                   G_PARAM_READWRITE);
  97     g_object_class_install_property(gobject_class, PROP_COLOR_DRESS, param);
  98
  99     param = adg_param_spec_dress("grid-dress",
 100                                   P_("Grid Dress"),
 101                                   P_("Line dress to use while rendering the grid of the table"),
 102                                   ADG_DRESS_LINE_GRID,
 103                                   G_PARAM_READWRITE);
 104     g_object_class_install_property(gobject_class, PROP_GRID_DRESS, param);
 105
 106     param = adg_param_spec_dress("frame-dress",
 107                                   P_("Frame Dress"),
 108                                   P_("Line dress to use while drawing the table frame"),
 109                                   ADG_DRESS_LINE_FRAME,
 110                                   G_PARAM_READWRITE);
 111     g_object_class_install_property(gobject_class, PROP_FRAME_DRESS, param);
 112
 113     param = adg_param_spec_dress("title-dress",
 114                                   P_("Title Dress"),
 115                                   P_("Font dress to use for titles"),
 116                                   ADG_DRESS_TEXT_LIMIT,
 117                                   G_PARAM_READWRITE);
 118     g_object_class_install_property(gobject_class, PROP_TITLE_DRESS, param);
 119
 120     param = adg_param_spec_dress("value-dress",
 121                                   P_("Value Dress"),
 122                                   P_("Font dress to use for values inside the cells"),
 123                                   ADG_DRESS_TEXT_VALUE,
 124                                   G_PARAM_READWRITE);
 125     g_object_class_install_property(gobject_class, PROP_VALUE_DRESS, param);
 126
 127     param = g_param_spec_double("row-height",
 128                                 P_("Row Height"),
 129                                 P_("The fallback row height when not explicitely specified while creating a new row"),
 130                                 0, G_MAXDOUBLE, 30,
 131                                 G_PARAM_READWRITE);
 132     g_object_class_install_property(gobject_class, PROP_ROW_HEIGHT, param);
 133
 134     param = g_param_spec_boxed("cell-padding",
 135                                P_("Cell Padding"),
 136                                P_("How much space from the bounding box must left inside every cell"),
 137                                ADG_TYPE_PAIR,
 138                                G_PARAM_READWRITE);
 139     g_object_class_install_property(gobject_class, PROP_CELL_PADDING, param);
 140
 141     param = g_param_spec_boxed("cell-spacing",
 142                                P_("Cell Spacing"),
 143                                P_("How much space to left between the cells"),
 144                                ADG_TYPE_PAIR,
 145                                G_PARAM_READWRITE);
 146     g_object_class_install_property(gobject_class, PROP_CELL_SPACING, param);
 147 }
 148
 149 static void
 150 adg_table_style_init(AdgTableStyle *table_style)
 151 {
 152     AdgTableStylePrivate *data;
 153
 154     data = G_TYPE_INSTANCE_GET_PRIVATE(table_style, ADG_TYPE_TABLE_STYLE,
 155                                        AdgTableStylePrivate);
 156
 157     data->color_dress = ADG_DRESS_COLOR;
 158     data->grid_dress = ADG_DRESS_LINE_GRID;
 159     data->frame_dress = ADG_DRESS_LINE_FRAME;
 160     data->title_dress = ADG_DRESS_TEXT_LIMIT;
 161     data->value_dress = ADG_DRESS_TEXT_VALUE;
 162     data->row_height = 30;
 163     data->cell_padding.x = 5;
 164     data->cell_padding.y = 5;
 165     data->cell_spacing.x = 0;
 166     data->cell_spacing.y = 0;
 167
 168     table_style->data = data;
 169 }
 170
 171 static void
 172 get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
 173 {
 174     AdgTableStylePrivate *data = ((AdgTableStyle *) object)->data;
 175
 176     switch (prop_id) {
 177     case PROP_COLOR_DRESS:
 178         g_value_set_int(value, data->color_dress);
 179         break;
 180     case PROP_GRID_DRESS:
 181         g_value_set_int(value, data->grid_dress);
 182         break;
 183     case PROP_FRAME_DRESS:
 184         g_value_set_int(value, data->frame_dress);
 185         break;
 186     case PROP_TITLE_DRESS:
 187         g_value_set_int(value, data->title_dress);
 188         break;
 189     case PROP_VALUE_DRESS:
 190         g_value_set_int(value, data->value_dress);
 191         break;
 192     case PROP_ROW_HEIGHT:
 193         g_value_set_double(value, data->row_height);
 194         break;
 195     case PROP_CELL_PADDING:
 196         g_value_set_boxed(value, &data->cell_padding);
 197         break;
 198     case PROP_CELL_SPACING:
 199         g_value_set_boxed(value, &data->cell_spacing);
 200         break;
 201     default:
 202         G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
 203         break;
 204     }
 205 }
 206
 207 static void
 208 set_property(GObject *object,
 209              guint prop_id, const GValue *value, GParamSpec *pspec)
 210 {
 211     AdgTableStylePrivate *data = ((AdgTableStyle *) object)->data;
 212
 213     switch (prop_id) {
 214     case PROP_COLOR_DRESS:
 215         adg_dress_set(&data->color_dress, g_value_get_int(value));
 216         break;
 217     case PROP_GRID_DRESS:
 218         adg_dress_set(&data->grid_dress, g_value_get_int(value));
 219         break;
 220     case PROP_FRAME_DRESS:
 221         adg_dress_set(&data->frame_dress, g_value_get_int(value));
 222         break;
 223     case PROP_TITLE_DRESS:
 224         adg_dress_set(&data->title_dress, g_value_get_int(value));
 225         break;
 226     case PROP_VALUE_DRESS:
 227         adg_dress_set(&data->value_dress, g_value_get_int(value));
 228         break;
 229     case PROP_ROW_HEIGHT:
 230         data->row_height = g_value_get_double(value);
 231         break;
 232     case PROP_CELL_PADDING:
 233         cpml_pair_copy(&data->cell_padding, g_value_get_boxed(value));
 234         break;
 235     case PROP_CELL_SPACING:
 236         cpml_pair_copy(&data->cell_spacing, g_value_get_boxed(value));
 237         break;
 238     default:
 239         G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
 240         break;
 241     }
 242 }
 243
 244
 245 /**
 246  * adg_table_style_new:
 247  *
 248  * Constructs a new tableension style initialized with default params.
 249  *
 250  * Returns: a new tableension style
 251  **/
 252 AdgStyle *
 253 adg_table_style_new(void)
 254 {
 255     return g_object_new(ADG_TYPE_TABLE_STYLE, NULL);
 256 }
 257
 258 /**
 259  * adg_table_style_get_color_dress:
 260  * @table_style: an #AdgTableStyle object
 261  *
 262  * Gets the @table_style color dress to be used. This dress should be
 263  * intended as a fallback color as it could be overriden by more
 264  * specific dresses, such as a color explicitely specified on the
 265  * #AdgTableStyle:value-dress.
 266  *
 267  * Returns: the color dress
 268  **/
 269 AdgDress
 270 adg_table_style_get_color_dress(AdgTableStyle *table_style)
 271 {
 272     AdgTableStylePrivate *data;
 273
 274     g_return_val_if_fail(ADG_IS_TABLE_STYLE(table_style), ADG_DRESS_UNDEFINED);
 275
 276     data = table_style->data;
 277
 278     return data->color_dress;
 279 }
 280
 281 /**
 282  * adg_table_style_set_color_dress:
 283  * @table_style: an #AdgTableStyle object
 284  * @dress: the new color dress
 285  *
 286  * Sets a new color dress on @table_style.
 287  **/
 288 void
 289 adg_table_style_set_color_dress(AdgTableStyle *table_style, AdgDress dress)
 290 {
 291     AdgTableStylePrivate *data;
 292
 293     g_return_if_fail(ADG_IS_TABLE_STYLE(table_style));
 294
 295     data = table_style->data;
 296
 297     if (adg_dress_set(&data->color_dress, dress))
 298         g_object_notify((GObject *) table_style, "color-dress");
 299 }
 300
 301 /**
 302  * adg_table_style_get_frame_dress:
 303  * @table_style: an #AdgTableStyle object
 304  *
 305  * Gets the line dress to be used for rendering the frames with
 306  * @table_style.
 307  *
 308  * Returns: the line dress
 309  **/
 310 AdgDress
 311 adg_table_style_get_frame_dress(AdgTableStyle *table_style)
 312 {
 313     AdgTableStylePrivate *data;
 314
 315     g_return_val_if_fail(ADG_IS_TABLE_STYLE(table_style), ADG_DRESS_UNDEFINED);
 316
 317     data = table_style->data;
 318
 319     return data->frame_dress;
 320 }
 321
 322 /**
 323  * adg_table_style_set_frame_dress:
 324  * @table_style: an #AdgTableStyle object
 325  * @dress: the new line dress
 326  *
 327  * Sets a new line dress on @table_style for rendering the frames.
 328  **/
 329 void
 330 adg_table_style_set_frame_dress(AdgTableStyle *table_style, AdgDress dress)
 331 {
 332     AdgTableStylePrivate *data;
 333
 334     g_return_if_fail(ADG_IS_TABLE_STYLE(table_style));
 335
 336     data = table_style->data;
 337
 338     if (adg_dress_set(&data->frame_dress, dress))
 339         g_object_notify((GObject *) table_style, "frame-dress");
 340 }
 341
 342 /**
 343  * adg_table_style_get_grid_dress:
 344  * @table_style: an #AdgTableStyle object
 345  *
 346  * Gets the line dress to be used for rendering the grids with
 347  * @table_style.
 348  *
 349  * Returns: the line dress
 350  **/
 351 AdgDress
 352 adg_table_style_get_grid_dress(AdgTableStyle *table_style)
 353 {
 354     AdgTableStylePrivate *data;
 355
 356     g_return_val_if_fail(ADG_IS_TABLE_STYLE(table_style), ADG_DRESS_UNDEFINED);
 357
 358     data = table_style->data;
 359
 360     return data->grid_dress;
 361 }
 362
 363 /**
 364  * adg_table_style_set_grid_dress:
 365  * @table_style: an #AdgTableStyle object
 366  * @dress: the new line dress
 367  *
 368  * Sets a new line dress on @table_style for rendering the grids.
 369  **/
 370 void
 371 adg_table_style_set_grid_dress(AdgTableStyle *table_style, AdgDress dress)
 372 {
 373     AdgTableStylePrivate *data;
 374
 375     g_return_if_fail(ADG_IS_TABLE_STYLE(table_style));
 376
 377     data = table_style->data;
 378
 379     if (adg_dress_set(&data->grid_dress, dress))
 380         g_object_notify((GObject *) table_style, "grid-dress");
 381 }
 382
 383 /**
 384  * adg_table_style_get_title_dress:
 385  * @table_style: an #AdgTableStyle object
 386  *
 387  * Gets the font dress to be used for rendering cell titles
 388  * with @table_style.
 389  *
 390  * Returns: the font dress
 391  **/
 392 AdgDress
 393 adg_table_style_get_title_dress(AdgTableStyle *table_style)
 394 {
 395     AdgTableStylePrivate *data;
 396
 397     g_return_val_if_fail(ADG_IS_TABLE_STYLE(table_style), ADG_DRESS_UNDEFINED);
 398
 399     data = table_style->data;
 400
 401     return data->title_dress;
 402 }
 403
 404 /**
 405  * adg_table_style_set_title_dress:
 406  * @table_style: an #AdgTableStyle object
 407  * @dress: the new font dress
 408  *
 409  * Sets a new font dress on @table_style for rendering cell titles.
 410  **/
 411 void
 412 adg_table_style_set_title_dress(AdgTableStyle *table_style, AdgDress dress)
 413 {
 414     AdgTableStylePrivate *data;
 415
 416     g_return_if_fail(ADG_IS_TABLE_STYLE(table_style));
 417
 418     data = table_style->data;
 419
 420     if (adg_dress_set(&data->title_dress, dress))
 421         g_object_notify((GObject *) table_style, "title-dress");
 422 }
 423
 424 /**
 425  * adg_table_style_get_value_dress:
 426  * @table_style: an #AdgTableStyle object
 427  *
 428  * Gets the font dress to be used for rendering cell values
 429  * with @table_style.
 430  *
 431  * Returns: the font dress
 432  **/
 433 AdgDress
 434 adg_table_style_get_value_dress(AdgTableStyle *table_style)
 435 {
 436     AdgTableStylePrivate *data;
 437
 438     g_return_val_if_fail(ADG_IS_TABLE_STYLE(table_style), ADG_DRESS_UNDEFINED);
 439
 440     data = table_style->data;
 441
 442     return data->value_dress;
 443 }
 444
 445 /**
 446  * adg_table_style_set_value_dress:
 447  * @table_style: an #AdgTableStyle object
 448  * @dress: the new font dress
 449  *
 450  * Sets a new font dress on @table_style for rendering cell values.
 451  **/
 452 void
 453 adg_table_style_set_value_dress(AdgTableStyle *table_style, AdgDress dress)
 454 {
 455     AdgTableStylePrivate *data;
 456
 457     g_return_if_fail(ADG_IS_TABLE_STYLE(table_style));
 458
 459     data = table_style->data;
 460
 461     if (adg_dress_set(&data->value_dress, dress))
 462         g_object_notify((GObject *) table_style, "value-dress");
 463 }
 464
 465 /**
 466  * adg_table_style_get_row_height:
 467  * @table_style: an #AdgTableStyle object
 468  *
 469  * Gets the row height fallback value.
 470  *
 471  * Returns: the fallback row height or %0 on errors
 472  **/
 473 gdouble
 474 adg_table_style_get_row_height(AdgTableStyle *table_style)
 475 {
 476     AdgTableStylePrivate *data;
 477
 478     g_return_val_if_fail(ADG_IS_TABLE_STYLE(table_style), 0);
 479
 480     data = table_style->data;
 481
 482     return data->row_height;
 483 }
 484
 485 /**
 486  * adg_table_style_set_row_height:
 487  * @table_style: an #AdgTableStyle object
 488  * @row_heigth: the new row heigth fallback
 489  *
 490  * Sets a new #AdgTableStyle:row-height fallback. @row_height must
 491  * be a valid row height greather than %0 or a warning will be
 492  * raised and this function will fail.
 493  **/
 494 void
 495 adg_table_style_set_row_height(AdgTableStyle *table_style, gdouble row_height)
 496 {
 497     AdgTableStylePrivate *data;
 498
 499     g_return_if_fail(ADG_IS_TABLE_STYLE(table_style));
 500     g_return_if_fail(row_height > 0);
 501
 502     data = table_style->data;
 503
 504     if (row_height == data->row_height)
 505         return;
 506
 507     data->row_height = row_height;
 508
 509     g_object_notify((GObject *) table_style, "row-height");
 510 }
 511
 512 /**
 513  * adg_table_style_get_cell_padding:
 514  * @table_style: an #AdgTableStyle object
 515  *
 516  * Gets the padding values in x and y to be left clear inside the cells.
 517  * The returned pointer refers to an internal allocated struct and
 518  * must not be modified or freed.
 519  *
 520  * The cell padding is a symmetric value, that is the padding on the
 521  * left will always be equal to the padding on the right and the top
 522  * will always be equal to the bottom.
 523  *
 524  * Returns: the cell padding values or %NULL on errors
 525  **/
 526 const AdgPair *
 527 adg_table_style_get_cell_padding(AdgTableStyle *table_style)
 528 {
 529     AdgTableStylePrivate *data;
 530
 531     g_return_val_if_fail(ADG_IS_TABLE_STYLE(table_style), NULL);
 532
 533     data = table_style->data;
 534
 535     return &data->cell_padding;
 536 }
 537
 538 /**
 539  * adg_table_style_set_cell_padding:
 540  * @table_style: an #AdgTableStyle object
 541  * @cell_padding: the new padding values
 542  *
 543  * Sets new #AdgTableStyle:cell-padding values.
 544  **/
 545 void
 546 adg_table_style_set_cell_padding(AdgTableStyle *table_style,
 547                                  const AdgPair *cell_padding)
 548 {
 549     AdgTableStylePrivate *data;
 550
 551     g_return_if_fail(ADG_IS_TABLE_STYLE(table_style));
 552     g_return_if_fail(cell_padding != NULL);
 553
 554     data = table_style->data;
 555     cpml_pair_copy(&data->cell_padding, cell_padding);
 556
 557     g_object_notify((GObject *) table_style, "cell-padding");
 558 }
 559
 560 /**
 561  * adg_table_style_get_cell_spacing:
 562  * @table_style: an #AdgTableStyle object
 563  *
 564  * Gets the spacing values in x and y to be left between the cell
 565  * boundary boxes. The returned pointer refers to an internal
 566  * allocated struct and must not be modified or freed.
 567  *
 568  * The cell spacing is a symmetric value, that is the spacing on the
 569  * left will always be equal to the spacing on the right and the top
 570  * will always be equal to the bottom.
 571  *
 572  * Returns: the cell spacing values or %NULL on errors
 573  **/
 574 const AdgPair *
 575 adg_table_style_get_cell_spacing(AdgTableStyle *table_style)
 576 {
 577     AdgTableStylePrivate *data;
 578
 579     g_return_val_if_fail(ADG_IS_TABLE_STYLE(table_style), NULL);
 580
 581     data = table_style->data;
 582
 583     return &data->cell_spacing;
 584 }
 585
 586 /**
 587  * adg_table_style_set_cell_spacing:
 588  * @table_style: an #AdgTableStyle object
 589  * @cell_spacing: the new spacing values
 590  *
 591  * Sets new #AdgTableStyle:cell-spacing values.
 592  **/
 593 void
 594 adg_table_style_set_cell_spacing(AdgTableStyle *table_style,
 595                                  const AdgPair *cell_spacing)
 596 {
 597     AdgTableStylePrivate *data;
 598
 599     g_return_if_fail(ADG_IS_TABLE_STYLE(table_style));
 600     g_return_if_fail(cell_spacing != NULL);
 601
 602     data = table_style->data;
 603     cpml_pair_copy(&data->cell_spacing, cell_spacing);
 604
 605     g_object_notify((GObject *) table_style, "cell-spacing");
 606 }
 607
 608
 609 static void
 610 apply(AdgStyle *style, AdgEntity *entity, cairo_t *cr)
 611 {
 612     AdgTableStylePrivate *data = ((AdgTableStyle *) style)->data;
 613
 614     adg_entity_apply_dress(entity, data->color_dress, cr);
 615 }