src/adg/adg-table-style.c

   1 /* ADG - Automatic Drawing Generation
   2  * Copyright (C) 2007-2021  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  *
  27  * Since: 1.0
  28  */
  29
  30 /**
  31  * AdgTableStyle:
  32  *
  33  * All fields are private and should not be used directly.
  34  * Use its public methods instead.
  35  *
  36  * Since: 1.0
  37  **/
  38
  39
  40 #include "adg-internal.h"
  41 #include "adg-style.h"
  42 #include "adg-dress.h"
  43 #include "adg-param-dress.h"
  44
  45 #include "adg-table-style.h"
  46 #include "adg-table-style-private.h"
  47
  48
  49 G_DEFINE_TYPE_WITH_PRIVATE(AdgTableStyle, adg_table_style, ADG_TYPE_STYLE)
  50
  51 enum {
  52     PROP_0,
  53     PROP_COLOR_DRESS,
  54     PROP_GRID_DRESS,
  55     PROP_FRAME_DRESS,
  56     PROP_TITLE_DRESS,
  57     PROP_VALUE_DRESS,
  58     PROP_ROW_HEIGHT,
  59     PROP_CELL_PADDING,
  60     PROP_CELL_SPACING
  61 };
  62
  63
  64 static void             _adg_get_property       (GObject        *object,
  65                                                  guint           prop_id,
  66                                                  GValue         *value,
  67                                                  GParamSpec     *pspec);
  68 static void             _adg_set_property       (GObject        *object,
  69                                                  guint           prop_id,
  70                                                  const GValue   *value,
  71                                                  GParamSpec     *pspec);
  72 static void             _adg_apply              (AdgStyle       *style,
  73                                                  AdgEntity      *entity,
  74                                                  cairo_t        *cr);
  75
  76
  77 static void
  78 adg_table_style_class_init(AdgTableStyleClass *klass)
  79 {
  80     GObjectClass *gobject_class;
  81     AdgStyleClass *style_class;
  82     GParamSpec *param;
  83
  84     gobject_class = (GObjectClass *) klass;
  85     style_class = (AdgStyleClass *) klass;
  86
  87     gobject_class->get_property = _adg_get_property;
  88     gobject_class->set_property = _adg_set_property;
  89
  90     style_class->apply = _adg_apply;
  91
  92     param = adg_param_spec_dress("color-dress",
  93                                  P_("Color Dress"),
  94                                  P_("Fallback color dress, used when no specific dresses are selected"),
  95                                  ADG_DRESS_COLOR_ANNOTATION,
  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_FONT_ANNOTATION,
 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_FONT_TEXT,
 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                                CPML_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                                CPML_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 = adg_table_style_get_instance_private(table_style);
 153
 154     data->color_dress = ADG_DRESS_COLOR_ANNOTATION,
 155     data->grid_dress = ADG_DRESS_LINE_GRID;
 156     data->frame_dress = ADG_DRESS_LINE_FRAME;
 157     data->title_dress = ADG_DRESS_FONT_ANNOTATION;
 158     data->value_dress = ADG_DRESS_FONT_TEXT;
 159     data->row_height = 30;
 160     data->cell_padding.x = 3;
 161     data->cell_padding.y = 3;
 162     data->cell_spacing.x = 0;
 163     data->cell_spacing.y = 0;
 164
 165     table_style->data = data;
 166 }
 167
 168 static void
 169 _adg_get_property(GObject *object, guint prop_id,
 170                   GValue *value, GParamSpec *pspec)
 171 {
 172     AdgTableStylePrivate *data = ((AdgTableStyle *) object)->data;
 173
 174     switch (prop_id) {
 175     case PROP_COLOR_DRESS:
 176         g_value_set_enum(value, data->color_dress);
 177         break;
 178     case PROP_GRID_DRESS:
 179         g_value_set_enum(value, data->grid_dress);
 180         break;
 181     case PROP_FRAME_DRESS:
 182         g_value_set_enum(value, data->frame_dress);
 183         break;
 184     case PROP_TITLE_DRESS:
 185         g_value_set_enum(value, data->title_dress);
 186         break;
 187     case PROP_VALUE_DRESS:
 188         g_value_set_enum(value, data->value_dress);
 189         break;
 190     case PROP_ROW_HEIGHT:
 191         g_value_set_double(value, data->row_height);
 192         break;
 193     case PROP_CELL_PADDING:
 194         g_value_set_boxed(value, &data->cell_padding);
 195         break;
 196     case PROP_CELL_SPACING:
 197         g_value_set_boxed(value, &data->cell_spacing);
 198         break;
 199     default:
 200         G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
 201         break;
 202     }
 203 }
 204
 205 static void
 206 _adg_set_property(GObject *object, guint prop_id,
 207                   const GValue *value, GParamSpec *pspec)
 208 {
 209     AdgTableStylePrivate *data = ((AdgTableStyle *) object)->data;
 210
 211     switch (prop_id) {
 212     case PROP_COLOR_DRESS:
 213         data->color_dress = g_value_get_enum(value);
 214         break;
 215     case PROP_GRID_DRESS:
 216         data->grid_dress = g_value_get_enum(value);
 217         break;
 218     case PROP_FRAME_DRESS:
 219         data->frame_dress = g_value_get_enum(value);
 220         break;
 221     case PROP_TITLE_DRESS:
 222         data->title_dress = g_value_get_enum(value);
 223         break;
 224     case PROP_VALUE_DRESS:
 225         data->value_dress = g_value_get_enum(value);
 226         break;
 227     case PROP_ROW_HEIGHT:
 228         data->row_height = g_value_get_double(value);
 229         break;
 230     case PROP_CELL_PADDING:
 231         cpml_pair_copy(&data->cell_padding, g_value_get_boxed(value));
 232         break;
 233     case PROP_CELL_SPACING:
 234         cpml_pair_copy(&data->cell_spacing, g_value_get_boxed(value));
 235         break;
 236     default:
 237         G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
 238         break;
 239     }
 240 }
 241
 242
 243 /**
 244  * adg_table_style_new:
 245  *
 246  * Constructs a new empty table style initialized with default params.
 247  *
 248  * Returns: (transfer full): a new table style.
 249  *
 250  * Since: 1.0
 251  **/
 252 AdgTableStyle *
 253 adg_table_style_new(void)
 254 {
 255     return g_object_new(ADG_TYPE_TABLE_STYLE, NULL);
 256 }
 257
 258 /**
 259  * adg_table_style_set_color_dress:
 260  * @table_style: an #AdgTableStyle object
 261  * @dress: the new color dress
 262  *
 263  * Sets a new color dress on @table_style.
 264  *
 265  * Since: 1.0
 266  **/
 267 void
 268 adg_table_style_set_color_dress(AdgTableStyle *table_style, AdgDress dress)
 269 {
 270     g_return_if_fail(ADG_IS_TABLE_STYLE(table_style));
 271     g_object_set(table_style, "color-dress", dress, NULL);
 272 }
 273
 274 /**
 275  * adg_table_style_get_color_dress:
 276  * @table_style: an #AdgTableStyle object
 277  *
 278  * Gets the @table_style color dress to be used. This dress should be
 279  * intended as a fallback color as it could be overriden by more
 280  * specific dresses, such as a color explicitely specified on the
 281  * #AdgTableStyle:value-dress.
 282  *
 283  * Returns: (transfer none): the color dress.
 284  *
 285  * Since: 1.0
 286  **/
 287 AdgDress
 288 adg_table_style_get_color_dress(AdgTableStyle *table_style)
 289 {
 290     AdgTableStylePrivate *data;
 291
 292     g_return_val_if_fail(ADG_IS_TABLE_STYLE(table_style), ADG_DRESS_UNDEFINED);
 293
 294     data = table_style->data;
 295
 296     return data->color_dress;
 297 }
 298
 299 /**
 300  * adg_table_style_set_frame_dress:
 301  * @table_style: an #AdgTableStyle object
 302  * @dress: the new line dress
 303  *
 304  * Sets a new line dress on @table_style for rendering the frames.
 305  *
 306  * Since: 1.0
 307  **/
 308 void
 309 adg_table_style_set_frame_dress(AdgTableStyle *table_style, AdgDress dress)
 310 {
 311     g_return_if_fail(ADG_IS_TABLE_STYLE(table_style));
 312     g_object_set(table_style, "frame-dress", dress, NULL);
 313 }
 314
 315 /**
 316  * adg_table_style_get_frame_dress:
 317  * @table_style: an #AdgTableStyle object
 318  *
 319  * Gets the line dress to be used for rendering the frames with
 320  * @table_style.
 321  *
 322  * Returns: (transfer none): the line dress.
 323  *
 324  * Since: 1.0
 325  **/
 326 AdgDress
 327 adg_table_style_get_frame_dress(AdgTableStyle *table_style)
 328 {
 329     AdgTableStylePrivate *data;
 330
 331     g_return_val_if_fail(ADG_IS_TABLE_STYLE(table_style), ADG_DRESS_UNDEFINED);
 332
 333     data = table_style->data;
 334
 335     return data->frame_dress;
 336 }
 337
 338 /**
 339  * adg_table_style_set_grid_dress:
 340  * @table_style: an #AdgTableStyle object
 341  * @dress: the new line dress
 342  *
 343  * Sets a new line dress on @table_style for rendering the grids.
 344  *
 345  * Since: 1.0
 346  **/
 347 void
 348 adg_table_style_set_grid_dress(AdgTableStyle *table_style, AdgDress dress)
 349 {
 350     g_return_if_fail(ADG_IS_TABLE_STYLE(table_style));
 351     g_object_set(table_style, "grid-dress", dress, NULL);
 352 }
 353
 354 /**
 355  * adg_table_style_get_grid_dress:
 356  * @table_style: an #AdgTableStyle object
 357  *
 358  * Gets the line dress to be used for rendering the grids with
 359  * @table_style.
 360  *
 361  * Returns: (transfer none): the line dress.
 362  *
 363  * Since: 1.0
 364  **/
 365 AdgDress
 366 adg_table_style_get_grid_dress(AdgTableStyle *table_style)
 367 {
 368     AdgTableStylePrivate *data;
 369
 370     g_return_val_if_fail(ADG_IS_TABLE_STYLE(table_style), ADG_DRESS_UNDEFINED);
 371
 372     data = table_style->data;
 373
 374     return data->grid_dress;
 375 }
 376
 377 /**
 378  * adg_table_style_set_title_dress:
 379  * @table_style: an #AdgTableStyle object
 380  * @dress: the new font dress
 381  *
 382  * Sets a new font dress on @table_style for rendering cell titles.
 383  *
 384  * Since: 1.0
 385  **/
 386 void
 387 adg_table_style_set_title_dress(AdgTableStyle *table_style, AdgDress dress)
 388 {
 389     g_return_if_fail(ADG_IS_TABLE_STYLE(table_style));
 390     g_object_set(table_style, "title-dress", dress, NULL);
 391 }
 392
 393 /**
 394  * adg_table_style_get_title_dress:
 395  * @table_style: an #AdgTableStyle object
 396  *
 397  * Gets the font dress to be used for rendering cell titles
 398  * with @table_style.
 399  *
 400  * Returns: (transfer none): the font dress.
 401  *
 402  * Since: 1.0
 403  **/
 404 AdgDress
 405 adg_table_style_get_title_dress(AdgTableStyle *table_style)
 406 {
 407     AdgTableStylePrivate *data;
 408
 409     g_return_val_if_fail(ADG_IS_TABLE_STYLE(table_style), ADG_DRESS_UNDEFINED);
 410
 411     data = table_style->data;
 412
 413     return data->title_dress;
 414 }
 415
 416 /**
 417  * adg_table_style_set_value_dress:
 418  * @table_style: an #AdgTableStyle object
 419  * @dress: the new font dress
 420  *
 421  * Sets a new font dress on @table_style for rendering cell values.
 422  *
 423  * Since: 1.0
 424  **/
 425 void
 426 adg_table_style_set_value_dress(AdgTableStyle *table_style, AdgDress dress)
 427 {
 428     g_return_if_fail(ADG_IS_TABLE_STYLE(table_style));
 429     g_object_set(table_style, "value-dress", dress, NULL);
 430 }
 431
 432 /**
 433  * adg_table_style_get_value_dress:
 434  * @table_style: an #AdgTableStyle object
 435  *
 436  * Gets the font dress to be used for rendering cell values
 437  * with @table_style.
 438  *
 439  * Returns: (transfer none): the font dress.
 440  *
 441  * Since: 1.0
 442  **/
 443 AdgDress
 444 adg_table_style_get_value_dress(AdgTableStyle *table_style)
 445 {
 446     AdgTableStylePrivate *data;
 447
 448     g_return_val_if_fail(ADG_IS_TABLE_STYLE(table_style), ADG_DRESS_UNDEFINED);
 449
 450     data = table_style->data;
 451
 452     return data->value_dress;
 453 }
 454
 455 /**
 456  * adg_table_style_set_row_height:
 457  * @table_style: an #AdgTableStyle object
 458  * @height: the new row heigth fallback
 459  *
 460  * Sets a new #AdgTableStyle:row-height fallback. @height must
 461  * be a valid row height greather than 0 or a warning will be
 462  * raised and this function will fail.
 463  *
 464  * Since: 1.0
 465  **/
 466 void
 467 adg_table_style_set_row_height(AdgTableStyle *table_style, gdouble height)
 468 {
 469     g_return_if_fail(ADG_IS_TABLE_STYLE(table_style));
 470     g_object_set(table_style, "row-height", height, NULL);
 471 }
 472
 473 /**
 474  * adg_table_style_get_row_height:
 475  * @table_style: an #AdgTableStyle object
 476  *
 477  * Gets the row height fallback value.
 478  *
 479  * Returns: the fallback row height or 0 on errors.
 480  *
 481  * Since: 1.0
 482  **/
 483 gdouble
 484 adg_table_style_get_row_height(AdgTableStyle *table_style)
 485 {
 486     AdgTableStylePrivate *data;
 487
 488     g_return_val_if_fail(ADG_IS_TABLE_STYLE(table_style), 0);
 489
 490     data = table_style->data;
 491
 492     return data->row_height;
 493 }
 494
 495 /**
 496  * adg_table_style_set_cell_padding:
 497  * @table_style: an #AdgTableStyle object
 498  * @padding: the new padding values
 499  *
 500  * Sets new #AdgTableStyle:cell-padding values.
 501  *
 502  * Since: 1.0
 503  **/
 504 void
 505 adg_table_style_set_cell_padding(AdgTableStyle *table_style,
 506                                  const CpmlPair *padding)
 507 {
 508     g_return_if_fail(ADG_IS_TABLE_STYLE(table_style));
 509     g_object_set(table_style, "cell-padding", padding, NULL);
 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: (transfer none): the cell padding values or <constant>NULL</constant> on errors.
 525  *
 526  * Since: 1.0
 527  **/
 528 const CpmlPair *
 529 adg_table_style_get_cell_padding(AdgTableStyle *table_style)
 530 {
 531     AdgTableStylePrivate *data;
 532
 533     g_return_val_if_fail(ADG_IS_TABLE_STYLE(table_style), NULL);
 534
 535     data = table_style->data;
 536
 537     return &data->cell_padding;
 538 }
 539
 540 /**
 541  * adg_table_style_set_cell_spacing:
 542  * @table_style: an #AdgTableStyle object
 543  * @spacing: the new spacing values
 544  *
 545  * Sets new #AdgTableStyle:cell-spacing values.
 546  *
 547  * Since: 1.0
 548  **/
 549 void
 550 adg_table_style_set_cell_spacing(AdgTableStyle *table_style,
 551                                  const CpmlPair *spacing)
 552 {
 553     g_return_if_fail(ADG_IS_TABLE_STYLE(table_style));
 554     g_object_set(table_style, "cell-spacing", spacing, NULL);
 555 }
 556
 557 /**
 558  * adg_table_style_get_cell_spacing:
 559  * @table_style: an #AdgTableStyle object
 560  *
 561  * Gets the spacing values in x and y to be left between the cell
 562  * boundary boxes. The returned pointer refers to an internal
 563  * allocated struct and must not be modified or freed.
 564  *
 565  * The cell spacing is a symmetric value, that is the spacing on the
 566  * left will always be equal to the spacing on the right and the top
 567  * will always be equal to the bottom.
 568  *
 569  * Returns: (transfer none): the cell spacing values or <constant>NULL</constant> on errors.
 570  *
 571  * Since: 1.0
 572  **/
 573 const CpmlPair *
 574 adg_table_style_get_cell_spacing(AdgTableStyle *table_style)
 575 {
 576     AdgTableStylePrivate *data;
 577
 578     g_return_val_if_fail(ADG_IS_TABLE_STYLE(table_style), NULL);
 579
 580     data = table_style->data;
 581
 582     return &data->cell_spacing;
 583 }
 584
 585
 586 static void
 587 _adg_apply(AdgStyle *style, AdgEntity *entity, cairo_t *cr)
 588 {
 589     AdgTableStylePrivate *data = ((AdgTableStyle *) style)->data;
 590
 591     adg_entity_apply_dress(entity, data->color_dress, cr);
 592 }