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 borders 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_BORDER_DRESS,
  50     PROP_GRID_DRESS,
  51     PROP_TITLE_DRESS,
  52     PROP_VALUE_DRESS,
  53     PROP_PADDING
  54 };
  55
  56
  57 static void             get_property            (GObject        *object,
  58                                                  guint           prop_id,
  59                                                  GValue         *value,
  60                                                  GParamSpec     *pspec);
  61 static void             set_property            (GObject        *object,
  62                                                  guint           prop_id,
  63                                                  const GValue   *value,
  64                                                  GParamSpec     *pspec);
  65 static void             apply                   (AdgStyle       *style,
  66                                                  AdgEntity      *entity,
  67                                                  cairo_t        *cr);
  68
  69
  70 G_DEFINE_TYPE(AdgTableStyle, adg_table_style, ADG_TYPE_STYLE);
  71
  72
  73 static void
  74 adg_table_style_class_init(AdgTableStyleClass *klass)
  75 {
  76     GObjectClass *gobject_class;
  77     AdgStyleClass *style_class;
  78     GParamSpec *param;
  79
  80     gobject_class = (GObjectClass *) klass;
  81     style_class = (AdgStyleClass *) klass;
  82
  83     g_type_class_add_private(klass, sizeof(AdgTableStylePrivate));
  84
  85     gobject_class->get_property = get_property;
  86     gobject_class->set_property = set_property;
  87
  88     style_class->apply = apply;
  89
  90     param = adg_param_spec_dress("color-dress",
  91                                   P_("Color Dress"),
  92                                   P_("Color dress for the whole tableension"),
  93                                   ADG_DRESS_COLOR,
  94                                   G_PARAM_READWRITE);
  95     g_object_class_install_property(gobject_class, PROP_COLOR_DRESS, param);
  96
  97     param = adg_param_spec_dress("border-dress",
  98                                   P_("Border Dress"),
  99                                   P_("Line dress to use while drawing the table border"),
 100                                   ADG_DRESS_LINE_STROKE,
 101                                   G_PARAM_READWRITE);
 102     g_object_class_install_property(gobject_class, PROP_BORDER_DRESS, param);
 103
 104     param = adg_param_spec_dress("grid-dress",
 105                                   P_("Grid Dress"),
 106                                   P_("Line dress to use while rendering the grid of the table"),
 107                                   ADG_DRESS_LINE_HATCH,
 108                                   G_PARAM_READWRITE);
 109     g_object_class_install_property(gobject_class, PROP_GRID_DRESS, param);
 110
 111     param = adg_param_spec_dress("title-dress",
 112                                   P_("Title Dress"),
 113                                   P_("Font dress to use for titles"),
 114                                   ADG_DRESS_TEXT_VALUE,
 115                                   G_PARAM_READWRITE);
 116     g_object_class_install_property(gobject_class, PROP_TITLE_DRESS, param);
 117
 118     param = adg_param_spec_dress("value-dress",
 119                                   P_("Value Dress"),
 120                                   P_("Font dress to use for values inside the cells"),
 121                                   ADG_DRESS_TEXT_LIMIT,
 122                                   G_PARAM_READWRITE);
 123     g_object_class_install_property(gobject_class, PROP_VALUE_DRESS, param);
 124
 125     param = g_param_spec_boxed("padding",
 126                                P_("Padding"),
 127                                P_("How much space from the extents must be reserved (that is, left clear) inside the cell"),
 128                                ADG_TYPE_PAIR,
 129                                G_PARAM_READWRITE);
 130     g_object_class_install_property(gobject_class, PROP_PADDING, param);
 131 }
 132
 133 static void
 134 adg_table_style_init(AdgTableStyle *table_style)
 135 {
 136     AdgTableStylePrivate *data = G_TYPE_INSTANCE_GET_PRIVATE(table_style,
 137                                                            ADG_TYPE_TABLE_STYLE,
 138                                                            AdgTableStylePrivate);
 139
 140     data->color_dress = ADG_DRESS_COLOR;
 141     data->border_dress = ADG_DRESS_LINE_STROKE;
 142     data->grid_dress = ADG_DRESS_LINE_HATCH;
 143     data->title_dress = ADG_DRESS_TEXT_VALUE;
 144     data->value_dress = ADG_DRESS_TEXT_LIMIT;
 145     data->padding.x = 2;
 146     data->padding.y = 2;
 147
 148     table_style->data = data;
 149 }
 150
 151 static void
 152 get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
 153 {
 154     AdgTableStylePrivate *data = ((AdgTableStyle *) object)->data;
 155
 156     switch (prop_id) {
 157     case PROP_COLOR_DRESS:
 158         g_value_set_int(value, data->color_dress);
 159         break;
 160     case PROP_BORDER_DRESS:
 161         g_value_set_int(value, data->border_dress);
 162         break;
 163     case PROP_GRID_DRESS:
 164         g_value_set_int(value, data->grid_dress);
 165         break;
 166     case PROP_TITLE_DRESS:
 167         g_value_set_int(value, data->title_dress);
 168         break;
 169     case PROP_VALUE_DRESS:
 170         g_value_set_int(value, data->value_dress);
 171         break;
 172     case PROP_PADDING:
 173         g_value_set_boxed(value, &data->padding);
 174         break;
 175     default:
 176         G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
 177         break;
 178     }
 179 }
 180
 181 static void
 182 set_property(GObject *object,
 183              guint prop_id, const GValue *value, GParamSpec *pspec)
 184 {
 185     AdgTableStylePrivate *data = ((AdgTableStyle *) object)->data;
 186
 187     switch (prop_id) {
 188     case PROP_COLOR_DRESS:
 189         adg_dress_set(&data->color_dress, g_value_get_int(value));
 190         break;
 191     case PROP_BORDER_DRESS:
 192         adg_dress_set(&data->border_dress, g_value_get_int(value));
 193         break;
 194     case PROP_GRID_DRESS:
 195         adg_dress_set(&data->grid_dress, g_value_get_int(value));
 196         break;
 197     case PROP_TITLE_DRESS:
 198         adg_dress_set(&data->title_dress, g_value_get_int(value));
 199         break;
 200     case PROP_VALUE_DRESS:
 201         adg_dress_set(&data->value_dress, g_value_get_int(value));
 202         break;
 203     case PROP_PADDING:
 204         cpml_pair_copy(&data->padding, g_value_get_boxed(value));
 205         break;
 206     default:
 207         G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
 208         break;
 209     }
 210 }
 211
 212
 213 /**
 214  * adg_table_style_new:
 215  *
 216  * Constructs a new tableension style initialized with default params.
 217  *
 218  * Returns: a new tableension style
 219  **/
 220 AdgStyle *
 221 adg_table_style_new(void)
 222 {
 223     return g_object_new(ADG_TYPE_TABLE_STYLE, NULL);
 224 }
 225
 226 /**
 227  * adg_table_style_get_color_dress:
 228  * @table_style: an #AdgTableStyle object
 229  *
 230  * Gets the @table_style color dress to be used. This dress should be
 231  * intended as a fallback color as it could be overriden by more
 232  * specific dresses, such as a color explicitely specified on the
 233  * #AdgTableStyle:value-dress.
 234  *
 235  * Returns: the color dress
 236  **/
 237 AdgDress
 238 adg_table_style_get_color_dress(AdgTableStyle *table_style)
 239 {
 240     AdgTableStylePrivate *data;
 241
 242     g_return_val_if_fail(ADG_IS_TABLE_STYLE(table_style), ADG_DRESS_UNDEFINED);
 243
 244     data = table_style->data;
 245
 246     return data->color_dress;
 247 }
 248
 249 /**
 250  * adg_table_style_set_color_dress:
 251  * @table_style: an #AdgTableStyle object
 252  * @dress: the new color dress
 253  *
 254  * Sets a new color dress on @table_style.
 255  **/
 256 void
 257 adg_table_style_set_color_dress(AdgTableStyle *table_style, AdgDress dress)
 258 {
 259     AdgTableStylePrivate *data;
 260
 261     g_return_if_fail(ADG_IS_TABLE_STYLE(table_style));
 262
 263     data = table_style->data;
 264
 265     if (adg_dress_set(&data->color_dress, dress))
 266         g_object_notify((GObject *) table_style, "color-dress");
 267 }
 268
 269 /**
 270  * adg_table_style_get_border_dress:
 271  * @table_style: an #AdgTableStyle object
 272  *
 273  * Gets the line dress to be used for rendering the borders with
 274  * @table_style.
 275  *
 276  * Returns: the line dress
 277  **/
 278 AdgDress
 279 adg_table_style_get_border_dress(AdgTableStyle *table_style)
 280 {
 281     AdgTableStylePrivate *data;
 282
 283     g_return_val_if_fail(ADG_IS_TABLE_STYLE(table_style), ADG_DRESS_UNDEFINED);
 284
 285     data = table_style->data;
 286
 287     return data->border_dress;
 288 }
 289
 290 /**
 291  * adg_table_style_set_border_dress:
 292  * @table_style: an #AdgTableStyle object
 293  * @dress: the new line dress
 294  *
 295  * Sets a new line dress on @table_style for rendering the borders.
 296  **/
 297 void
 298 adg_table_style_set_border_dress(AdgTableStyle *table_style, AdgDress dress)
 299 {
 300     AdgTableStylePrivate *data;
 301
 302     g_return_if_fail(ADG_IS_TABLE_STYLE(table_style));
 303
 304     data = table_style->data;
 305
 306     if (adg_dress_set(&data->border_dress, dress))
 307         g_object_notify((GObject *) table_style, "border-dress");
 308 }
 309
 310 /**
 311  * adg_table_style_get_grid_dress:
 312  * @table_style: an #AdgTableStyle object
 313  *
 314  * Gets the line dress to be used for rendering the grids with
 315  * @table_style.
 316  *
 317  * Returns: the line dress
 318  **/
 319 AdgDress
 320 adg_table_style_get_grid_dress(AdgTableStyle *table_style)
 321 {
 322     AdgTableStylePrivate *data;
 323
 324     g_return_val_if_fail(ADG_IS_TABLE_STYLE(table_style), ADG_DRESS_UNDEFINED);
 325
 326     data = table_style->data;
 327
 328     return data->grid_dress;
 329 }
 330
 331 /**
 332  * adg_table_style_set_grid_dress:
 333  * @table_style: an #AdgTableStyle object
 334  * @dress: the new line dress
 335  *
 336  * Sets a new line dress on @table_style for rendering the grids.
 337  **/
 338 void
 339 adg_table_style_set_grid_dress(AdgTableStyle *table_style, AdgDress dress)
 340 {
 341     AdgTableStylePrivate *data;
 342
 343     g_return_if_fail(ADG_IS_TABLE_STYLE(table_style));
 344
 345     data = table_style->data;
 346
 347     if (adg_dress_set(&data->grid_dress, dress))
 348         g_object_notify((GObject *) table_style, "grid-dress");
 349 }
 350
 351 /**
 352  * adg_table_style_get_title_dress:
 353  * @table_style: an #AdgTableStyle object
 354  *
 355  * Gets the font dress to be used for rendering cell titles
 356  * with @table_style.
 357  *
 358  * Returns: the font dress
 359  **/
 360 AdgDress
 361 adg_table_style_get_title_dress(AdgTableStyle *table_style)
 362 {
 363     AdgTableStylePrivate *data;
 364
 365     g_return_val_if_fail(ADG_IS_TABLE_STYLE(table_style), ADG_DRESS_UNDEFINED);
 366
 367     data = table_style->data;
 368
 369     return data->title_dress;
 370 }
 371
 372 /**
 373  * adg_table_style_set_title_dress:
 374  * @table_style: an #AdgTableStyle object
 375  * @dress: the new font dress
 376  *
 377  * Sets a new font dress on @table_style for rendering cell titles.
 378  **/
 379 void
 380 adg_table_style_set_title_dress(AdgTableStyle *table_style, AdgDress dress)
 381 {
 382     AdgTableStylePrivate *data;
 383
 384     g_return_if_fail(ADG_IS_TABLE_STYLE(table_style));
 385
 386     data = table_style->data;
 387
 388     if (adg_dress_set(&data->title_dress, dress))
 389         g_object_notify((GObject *) table_style, "title-dress");
 390 }
 391
 392 /**
 393  * adg_table_style_get_value_dress:
 394  * @table_style: an #AdgTableStyle object
 395  *
 396  * Gets the font dress to be used for rendering cell values
 397  * with @table_style.
 398  *
 399  * Returns: the font dress
 400  **/
 401 AdgDress
 402 adg_table_style_get_value_dress(AdgTableStyle *table_style)
 403 {
 404     AdgTableStylePrivate *data;
 405
 406     g_return_val_if_fail(ADG_IS_TABLE_STYLE(table_style), ADG_DRESS_UNDEFINED);
 407
 408     data = table_style->data;
 409
 410     return data->value_dress;
 411 }
 412
 413 /**
 414  * adg_table_style_set_value_dress:
 415  * @table_style: an #AdgTableStyle object
 416  * @dress: the new font dress
 417  *
 418  * Sets a new font dress on @table_style for rendering cell values.
 419  **/
 420 void
 421 adg_table_style_set_value_dress(AdgTableStyle *table_style, AdgDress dress)
 422 {
 423     AdgTableStylePrivate *data;
 424
 425     g_return_if_fail(ADG_IS_TABLE_STYLE(table_style));
 426
 427     data = table_style->data;
 428
 429     if (adg_dress_set(&data->value_dress, dress))
 430         g_object_notify((GObject *) table_style, "value-dress");
 431 }
 432
 433 /**
 434  * adg_table_style_get_padding:
 435  * @table_style: an #AdgTableStyle object
 436  *
 437  * Gets the padding values in x and y to be left clear inside the cells.
 438  * The returned pointer refers to an internal allocated struct and
 439  * must not be modified or freed.
 440  *
 441  * Returns: the internal padding values
 442  **/
 443 const AdgPair *
 444 adg_table_style_get_padding(AdgTableStyle *table_style)
 445 {
 446     AdgTableStylePrivate *data;
 447
 448     g_return_val_if_fail(ADG_IS_TABLE_STYLE(table_style), NULL);
 449
 450     data = table_style->data;
 451
 452     return &data->padding;
 453 }
 454
 455 /**
 456  * adg_table_style_set_padding:
 457  * @table_style: an #AdgTableStyle object
 458  * @padding: the new padding values
 459  *
 460  * Sets new #AdgTableStyle:padding values.
 461  **/
 462 void
 463 adg_table_style_set_padding(AdgTableStyle *table_style, const AdgPair *padding)
 464 {
 465     AdgTableStylePrivate *data;
 466
 467     g_return_if_fail(ADG_IS_TABLE_STYLE(table_style));
 468     g_return_if_fail(padding != NULL);
 469
 470     data = table_style->data;
 471     cpml_pair_copy(&data->padding, padding);
 472
 473     g_object_notify((GObject *) table_style, "padding");
 474 }
 475
 476
 477 static void
 478 apply(AdgStyle *style, AdgEntity *entity, cairo_t *cr)
 479 {
 480     AdgTableStylePrivate *data = ((AdgTableStyle *) style)->data;
 481
 482     adg_entity_apply_dress(entity, data->color_dress, cr);
 483 }