vcs.maemo.org Git - hildon/blob - src/hildon-caption.c

   1 /*
   2  * This file is a part of hildon
   3  *
   4  * Copyright (C) 2005, 2006 Nokia Corporation, all rights reserved.
   5  *
   6  * Contact: Michael Dominic Kostrzewa <michael.kostrzewa@nokia.com>
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public License
  10  * as published by the Free Software Foundation; version 2.1 of
  11  * the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  21  * 02110-1301 USA
  22  *
  23  */
  24
  25 /**
  26  * SECTION:hildon-caption
  27  * @short_description: A single-child container widget that precedes the
  28  * contained widget with a field label and an optional icon.
  29  *
  30  * #HildonCaption is a single-child container widget that precedes the
  31  * contained widget with a field label and an optional icon. It allows
  32  * grouping of several controls together. When a captioned widget has focus,
  33  * both widget and caption label are displayed with active focus.
  34  */
  35
  36 #ifdef                                          HAVE_CONFIG_H
  37 #include                                        <config.h>
  38 #endif
  39
  40 #include                                        "hildon-caption.h"
  41 #include                                        <gtk/gtkhbox.h>
  42 #include                                        <gtk/gtklabel.h>
  43 #include                                        <gtk/gtkimage.h>
  44 #include                                        <gtk/gtkentry.h>
  45 #include                                        <gtk/gtkcombo.h>
  46 #include                                        <gtk/gtkcombobox.h>
  47 #include                                        <gtk/gtkcomboboxentry.h>
  48 #include                                        <gtk/gtkoptionmenu.h>
  49 #include                                        <gtk/gtkmarshal.h>
  50 #include                                        <gtk/gtkalignment.h>
  51 #include                                        <gtk/gtkcheckbutton.h>
  52 #include                                        <stdio.h>
  53 #include                                        <string.h>
  54 #include                                        "hildon-defines.h"
  55 #include                                        <libintl.h>
  56 #include                                        "hildon-caption-private.h"
  57
  58 #define                                         _(String)\
  59                                                 dgettext("hildon-libs", String)
  60
  61 #define                                         HILDON_CAPTION_SPACING 6
  62
  63 static GtkEventBox*                             parent_class = NULL;
  64
  65 static void
  66 hildon_caption_class_init                       (HildonCaptionClass *caption_class);
  67
  68 static void
  69 hildon_caption_init                             (HildonCaption *caption);
  70
  71 static void
  72 hildon_caption_size_request                     (GtkWidget *widget,
  73                                                  GtkRequisition *requisition);
  74
  75 static void
  76 hildon_caption_size_allocate                    (GtkWidget *widget,
  77                                                  GtkAllocation *allocation);
  78
  79 static void
  80 hildon_caption_forall                           (GtkContainer *container,
  81                                                  gboolean include_internals,
  82                                                  GtkCallback callback,
  83                                                  gpointer data );
  84
  85 static void
  86 hildon_caption_hierarchy_changed                (GtkWidget *widget,
  87                                                  GtkWidget *previous_toplevel);
  88
  89 static void
  90 hildon_caption_set_focus                        (GtkWindow *window,
  91                                                  GtkWidget *widget,
  92                                                  GtkWidget *caption);
  93
  94 static void
  95 hildon_caption_grab_focus                       (GtkWidget *widget);
  96
  97 static void
  98 hildon_caption_activate                         (GtkWidget *widget);
  99
 100 static void
 101 hildon_caption_set_property                     (GObject *object,
 102                                                  guint param_id,
 103                                                  const GValue *value,
 104                                                  GParamSpec *pspec );
 105
 106 static void
 107 hildon_caption_get_property                     (GObject *object,
 108                                                  guint param_id,
 109                                                  GValue *value,
 110                                                  GParamSpec *pspec);
 111
 112 static gboolean
 113 hildon_caption_expose                           (GtkWidget *widget,
 114                                                  GdkEventExpose *event);
 115
 116 static void
 117 hildon_caption_destroy                          (GtkObject *self);
 118
 119 static gboolean
 120 hildon_caption_button_press                     (GtkWidget *widget,
 121                                                  GdkEventButton *event);
 122
 123 static void
 124 hildon_caption_set_label_text                   (HildonCaptionPrivate *priv,
 125                                                  gboolean markup);
 126
 127 static void
 128 hildon_caption_set_child_property               (GtkContainer *container,
 129                                                  GtkWidget *child,
 130                                                  guint property_id,
 131                                                  const GValue *value,
 132                                                  GParamSpec *pspec);
 133
 134 static void
 135 hildon_caption_get_child_property               (GtkContainer *container,
 136                                                  GtkWidget *child,
 137                                                  guint property_id,
 138                                                  GValue *value,
 139                                                  GParamSpec *pspec);
 140
 141 enum
 142 {
 143     PROP_0,
 144     PROP_LABEL,
 145     PROP_MARKUP,
 146     PROP_ICON,
 147     PROP_STATUS,
 148     PROP_SEPARATOR,
 149     PROP_SIZE_GROUP,
 150     PROP_ICON_POSITION,
 151 };
 152
 153 enum
 154 {
 155     CHILD_PROP_NONE,
 156     CHILD_PROP_EXPAND
 157 };
 158
 159 /**
 160  * hildon_caption_get_type:
 161  *
 162  * Initializes and returns the type of a hildon caption.
 163  *
 164  * @Returns: GType of #HildonCaption
 165  */
 166 GType G_GNUC_CONST
 167 hildon_caption_get_type                         (void)
 168 {
 169     static GType caption_type = 0;
 170
 171     if (!caption_type)
 172     {
 173         static const GTypeInfo caption_info = {
 174             sizeof (HildonCaptionClass),
 175             NULL,       /* base_init */
 176             NULL,       /* base_finalize */
 177             (GClassInitFunc) hildon_caption_class_init,
 178             NULL,       /* class_finalize */
 179             NULL,       /* class_data */
 180             sizeof (HildonCaption),
 181             0,  /* n_preallocs */
 182             (GInstanceInitFunc) hildon_caption_init,
 183         };
 184         caption_type = g_type_register_static (GTK_TYPE_EVENT_BOX,
 185                 "HildonCaption", &caption_info, 0 );
 186     }
 187     return caption_type;
 188 }
 189
 190 /*
 191  * Initialises the caption class.
 192  */
 193 static void
 194 hildon_caption_class_init                       (HildonCaptionClass *caption_class)
 195 {
 196     GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (caption_class);
 197     GObjectClass *gobject_class = G_OBJECT_CLASS (caption_class);
 198     GtkContainerClass *container_class = GTK_CONTAINER_CLASS (caption_class);
 199
 200     parent_class = g_type_class_peek_parent (caption_class);
 201
 202     g_type_class_add_private (caption_class, sizeof (HildonCaptionPrivate));
 203
 204     /* Override virtual functions */
 205     gobject_class->get_property                 = hildon_caption_get_property;
 206     gobject_class->set_property                 = hildon_caption_set_property;
 207     caption_class->activate                     = (gpointer) hildon_caption_activate;
 208     GTK_OBJECT_CLASS(caption_class)->destroy    = hildon_caption_destroy;
 209
 210     container_class->forall                     = hildon_caption_forall;
 211     container_class->set_child_property         = hildon_caption_set_child_property;
 212     container_class->get_child_property         = hildon_caption_get_child_property;
 213
 214     widget_class->expose_event                  = hildon_caption_expose;
 215     widget_class->hierarchy_changed             = hildon_caption_hierarchy_changed;
 216     widget_class->size_request                  = hildon_caption_size_request;
 217     widget_class->size_allocate                 = hildon_caption_size_allocate;
 218     widget_class->button_press_event            = hildon_caption_button_press;
 219     widget_class->grab_focus                    = hildon_caption_grab_focus;
 220
 221     /* Create new signals and properties */
 222     widget_class->activate_signal = g_signal_new ("activate",
 223             G_OBJECT_CLASS_TYPE (
 224                 gobject_class),
 225             G_SIGNAL_RUN_FIRST |
 226             G_SIGNAL_ACTION,
 227             G_STRUCT_OFFSET (HildonCaptionClass,
 228                 activate), NULL, NULL,
 229             gtk_marshal_VOID__VOID,
 230             G_TYPE_NONE, 0);
 231
 232     /**
 233      * HildonCaption:label:
 234      *
 235      * Caption label.
 236      */
 237     g_object_class_install_property (gobject_class, PROP_LABEL,
 238             g_param_spec_string ("label",
 239                 "Current label", "Caption label",
 240                 NULL, G_PARAM_READABLE | G_PARAM_WRITABLE) );
 241
 242     /**
 243      * HildonCaption:markup:
 244      *
 245      * Caption markup. Mutually exclusive with label.
 246      */
 247     g_object_class_install_property (gobject_class, PROP_MARKUP,
 248             g_param_spec_string ("markup",
 249                 "Current markup", "Caption markup",
 250                 NULL, G_PARAM_WRITABLE) );
 251
 252     /**
 253      * HildonCaption:icon:
 254      *
 255      * The icon shown on the caption area.
 256      */
 257     g_object_class_install_property (gobject_class, PROP_ICON,
 258             g_param_spec_object ("icon",
 259                 "Current icon",
 260                 "The icon shown on the caption area",
 261                 GTK_TYPE_WIDGET, G_PARAM_READABLE |
 262                 G_PARAM_WRITABLE) );
 263     /**
 264      * HildonCaption:status:
 265      *
 266      * Mandatory or optional status.
 267      */
 268     g_object_class_install_property (gobject_class, PROP_STATUS,
 269             g_param_spec_enum ("status",
 270                 "Current status",
 271                 "Mandatory or optional status",
 272                 HILDON_TYPE_CAPTION_STATUS,
 273                 HILDON_CAPTION_OPTIONAL,
 274                 G_PARAM_READABLE | G_PARAM_WRITABLE) );
 275     /**
 276      * HildonCaption:icon-position:
 277      *
 278      * If the icon is positioned on the left or right side.
 279      */
 280     g_object_class_install_property (gobject_class, PROP_ICON_POSITION,
 281             g_param_spec_enum ("icon-position",
 282                 "Icon position",
 283                 "If the icon is on the left or right side",
 284                 HILDON_TYPE_CAPTION_ICON_POSITION,
 285                 HILDON_CAPTION_POSITION_RIGHT,
 286                 G_PARAM_READABLE | G_PARAM_WRITABLE) );
 287
 288     /**
 289      * HildonCaption:size_group:
 290      *
 291      * Current size group the caption is in.
 292      */
 293     g_object_class_install_property (gobject_class, PROP_SIZE_GROUP,
 294             g_param_spec_object ("size_group",
 295                 "Current size group",
 296                 "Current size group the caption is in",
 297                 GTK_TYPE_SIZE_GROUP, G_PARAM_READABLE |
 298                 G_PARAM_WRITABLE) );
 299
 300     /**
 301      * HildonCaption:separator:
 302      *
 303      * The current separator.
 304      */
 305     g_object_class_install_property (gobject_class, PROP_SEPARATOR,
 306             g_param_spec_string ("separator",
 307                 "Current separator", "Current separator",
 308                 _("ecdg_ti_caption_separator"),
 309                 G_PARAM_READABLE | G_PARAM_WRITABLE) );
 310
 311     /* Create child properties. These are related to
 312        child <-> parent relationship, not to either of objects itself */
 313     gtk_container_class_install_child_property (container_class,
 314             CHILD_PROP_EXPAND,
 315             g_param_spec_boolean ("expand",
 316                 "Same as GtkBox expand.",
 317                 "Same as GtkBox expand. Wheter the child should be expanded or not.",
 318                 FALSE,
 319                 G_PARAM_READWRITE));
 320 }
 321
 322 /* Destroy can be called multiple times, remember to set pointers to NULL */
 323 static void
 324 hildon_caption_destroy                          (GtkObject *self)
 325 {
 326     HildonCaptionPrivate *priv = HILDON_CAPTION_GET_PRIVATE (self);
 327
 328     /* Free our internal child */
 329     if (priv && priv->caption_area)
 330     {
 331         gtk_widget_unparent (priv->caption_area);
 332         priv->caption_area = NULL;
 333     }
 334
 335     /* Free user provided strings */
 336     if (priv && priv->text)
 337     {
 338         g_free (priv->text);
 339         priv->text = NULL;
 340     }
 341
 342     if (priv && priv->separator)
 343     {
 344         g_free (priv->separator);
 345         priv->separator = NULL;
 346     }
 347
 348     /* Parent classes destroy takes care of user packed contents */
 349     if (GTK_OBJECT_CLASS (parent_class)->destroy)
 350         GTK_OBJECT_CLASS (parent_class)->destroy (self);
 351 }
 352
 353 /* Parent, eventbox will run allocate also for the child which may be
 354  * owning a window too. This window is then moved and resized
 355  * and we do not want to do that (it causes flickering).
 356  */
 357 static gboolean
 358 hildon_caption_expose                           (GtkWidget *widget,
 359                                                  GdkEventExpose *event)
 360 {
 361     HildonCaptionPrivate *priv = NULL;
 362     GtkRequisition req;
 363     GtkAllocation alloc;
 364     gfloat align;
 365
 366     g_assert (HILDON_IS_CAPTION (widget));
 367     priv = HILDON_CAPTION_GET_PRIVATE (widget);
 368     g_assert (priv);
 369
 370     if (! GTK_WIDGET_DRAWABLE (widget))
 371         return FALSE;
 372
 373     GTK_WIDGET_CLASS (parent_class)->expose_event (widget, event);
 374
 375     /* If our child control is focused, we draw nice looking focus
 376        graphics for the caption */
 377     if (priv->is_focused && priv->text)
 378     {
 379         /* Determine focus box dimensions */
 380         gtk_widget_get_child_requisition (priv->caption_area, &req);
 381         align = hildon_caption_get_label_alignment (HILDON_CAPTION(widget));
 382
 383         alloc.width = priv->caption_area->allocation.width + HILDON_CAPTION_SPACING;
 384         alloc.height = MIN (req.height + (2 * widget->style->ythickness), priv->caption_area->allocation.height);
 385
 386         alloc.x = priv->caption_area->allocation.x - HILDON_CAPTION_SPACING; /* - left margin */
 387         alloc.y = priv->caption_area->allocation.y +
 388             MAX (((priv->caption_area->allocation.height - alloc.height) * align), 0);
 389
 390         /* Paint the focus box */
 391         gtk_paint_box (widget->style, widget->window, GTK_STATE_ACTIVE,
 392                 GTK_SHADOW_OUT, NULL, widget, "selection",
 393                 alloc.x, alloc.y, alloc.width, alloc.height);
 394
 395         /* Paint caption contents on top of the focus box */
 396         GTK_WIDGET_GET_CLASS (priv->caption_area)->expose_event (priv->caption_area, event);
 397     }
 398
 399     return FALSE;
 400 }
 401
 402 static void
 403 hildon_caption_set_property                     (GObject *object,
 404                                                  guint param_id,
 405                                                  const GValue *value,
 406                                                  GParamSpec *pspec)
 407 {
 408     HildonCaptionPrivate *priv = HILDON_CAPTION_GET_PRIVATE (object);
 409     g_assert (priv);
 410
 411     switch (param_id)
 412     {
 413         case PROP_ICON_POSITION:
 414             hildon_caption_set_icon_position (HILDON_CAPTION (object), g_value_get_enum (value));
 415             break;
 416
 417         case PROP_LABEL:
 418             /* Free old label string */
 419             if (priv->text)
 420             {
 421                 g_free (priv->text);
 422                 priv->text = NULL;
 423             }
 424
 425             /* Update label */
 426             priv->text = g_value_dup_string (value);
 427             hildon_caption_set_label_text (priv, FALSE);
 428             break;
 429
 430         case PROP_MARKUP:
 431             /* Free old label string */
 432             if (priv->text)
 433             {
 434                 g_free (priv->text);
 435                 priv->text = NULL;
 436             }
 437
 438             /* Update label */
 439             priv->text = g_value_dup_string (value);
 440             hildon_caption_set_label_text (priv, TRUE);
 441             break;
 442
 443         case PROP_ICON:
 444             /* Remove old icon */
 445             if (priv->icon)
 446                 gtk_container_remove (GTK_CONTAINER (priv->icon_align), priv->icon);
 447
 448             /* Pack and display new icon */
 449             priv->icon = g_value_get_object (value);
 450             if (priv->icon)
 451             {
 452                 gtk_container_add (GTK_CONTAINER (priv->icon_align), priv->icon);
 453                 gtk_widget_show_all (priv->caption_area);
 454             }
 455             break;
 456
 457         case PROP_STATUS:
 458             priv->status = g_value_get_enum (value);
 459             break;
 460
 461         case PROP_SIZE_GROUP:
 462             /* Detach from previous size group */
 463             if (priv->group)
 464                 gtk_size_group_remove_widget (priv->group, priv->caption_area);
 465
 466             priv->group = g_value_get_object (value);
 467
 468             /* Attach to new size group */
 469             if (priv->group)
 470                 gtk_size_group_add_widget (priv->group, priv->caption_area);
 471
 472             gtk_widget_queue_draw (GTK_WIDGET(object));
 473             break;
 474
 475         case PROP_SEPARATOR:
 476
 477             /* Free old separator */
 478             if (priv->separator)
 479             {
 480                 g_free (priv->separator);
 481                 priv->separator = NULL;
 482             }
 483
 484             priv->separator = g_value_dup_string (value);
 485             hildon_caption_set_label_text (priv, FALSE);
 486             break;
 487
 488         default:
 489             G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
 490             break;
 491     }
 492 }
 493
 494 static void
 495 hildon_caption_get_property                     (GObject *object,
 496                                                  guint param_id,
 497                                                  GValue *value,
 498                                                  GParamSpec *pspec)
 499 {
 500     HildonCaptionPrivate *priv = HILDON_CAPTION_GET_PRIVATE (object);
 501
 502     switch (param_id)
 503     {
 504         case PROP_LABEL:
 505             g_value_set_string (value, priv->text);
 506             break;
 507
 508         case PROP_ICON:
 509             g_value_set_object (value, priv->icon);
 510             break;
 511
 512         case PROP_STATUS:
 513             g_value_set_enum (value, priv->status);
 514             break;
 515
 516         case PROP_ICON_POSITION:
 517             g_value_set_enum (value, priv->icon_position);
 518             break;
 519
 520         case PROP_SIZE_GROUP:
 521             g_value_set_object (value, priv->group);
 522             break;
 523
 524         case PROP_SEPARATOR:
 525             g_value_set_string (value, priv->separator);
 526             break;
 527
 528         default:
 529             G_OBJECT_WARN_INVALID_PROPERTY_ID(object, param_id, pspec);
 530             break;
 531     }
 532 }
 533
 534 static void
 535 hildon_caption_set_child_property               (GtkContainer *container,
 536                                                  GtkWidget *child,
 537                                                  guint property_id,
 538                                                  const GValue *value,
 539                                                  GParamSpec *pspec)
 540 {
 541     switch (property_id)
 542     {
 543         case CHILD_PROP_EXPAND:
 544             hildon_caption_set_child_expand (HILDON_CAPTION (container),
 545                     g_value_get_boolean (value));
 546             break;
 547
 548         default:
 549             G_OBJECT_WARN_INVALID_PROPERTY_ID (container, property_id, pspec);
 550             break;
 551     }
 552 }
 553
 554 static void
 555 hildon_caption_get_child_property               (GtkContainer *container,
 556                                                  GtkWidget *child,
 557                                                  guint property_id,
 558                                                  GValue *value,
 559                                                  GParamSpec *pspec)
 560 {
 561     switch (property_id)
 562     {
 563         case CHILD_PROP_EXPAND:
 564             g_value_set_boolean (value, hildon_caption_get_child_expand(
 565                         HILDON_CAPTION (container)));
 566             break;
 567
 568         default:
 569             G_OBJECT_WARN_INVALID_PROPERTY_ID(container, property_id, pspec);
 570             break;
 571     }
 572 }
 573
 574 /* We want to activate out child control on button press */
 575 static gboolean
 576 hildon_caption_button_press                     (GtkWidget *widget,
 577                                                  GdkEventButton *event)
 578 {
 579     HildonCaptionPrivate *priv = HILDON_CAPTION_GET_PRIVATE (widget);
 580     g_assert (priv);
 581
 582     priv->is_focused = TRUE;
 583     gtk_widget_grab_focus (GTK_BIN (widget)->child);
 584
 585     return FALSE;
 586 }
 587
 588 static void
 589 hildon_caption_init                             (HildonCaption *caption)
 590 {
 591     HildonCaptionPrivate *priv = NULL;
 592
 593     /* Initialize startup state */
 594     priv = HILDON_CAPTION_GET_PRIVATE (caption);
 595     g_assert (priv);
 596
 597     priv->status = HILDON_CAPTION_OPTIONAL;
 598     priv->icon = NULL;
 599     priv->group = NULL;
 600     priv->is_focused = FALSE;
 601     priv->text = NULL;
 602
 603     priv->separator = g_strdup(_("ecdg_ti_caption_separator"));
 604
 605     gtk_widget_push_composite_child();
 606
 607     /* Create caption text */
 608     priv->caption_area = gtk_hbox_new (FALSE, HILDON_CAPTION_SPACING);
 609     priv->label = gtk_label_new (NULL);
 610     priv->icon_align = gtk_alignment_new (0.5f, 0.5f, 0.0f, 0.0f);
 611     priv->icon_position = HILDON_CAPTION_POSITION_RIGHT;
 612
 613     /* We want to receive button presses for child widget activation */
 614     gtk_event_box_set_above_child (GTK_EVENT_BOX (caption), FALSE);
 615     gtk_widget_add_events (GTK_WIDGET (caption), GDK_BUTTON_PRESS_MASK);
 616
 617     /* Pack text label caption layout */
 618     gtk_box_pack_end (GTK_BOX (priv->caption_area), priv->icon_align, FALSE, FALSE, 0);
 619     gtk_box_pack_end (GTK_BOX (priv->caption_area), priv->label, FALSE, FALSE, 0);
 620     gtk_widget_set_parent (priv->caption_area, GTK_WIDGET (caption));
 621
 622     gtk_widget_pop_composite_child ();
 623
 624     hildon_caption_set_child_expand (caption, TRUE);
 625
 626     gtk_widget_show_all (priv->caption_area);
 627 }
 628
 629 static void
 630 hildon_caption_set_focus                        (GtkWindow *window,
 631                                                  GtkWidget *widget,
 632                                                  GtkWidget *caption)
 633 {
 634     HildonCaptionPrivate *priv = HILDON_CAPTION_GET_PRIVATE (caption);
 635     g_assert (priv);
 636
 637     /* check if ancestor gone */
 638     if (! widget)
 639     {
 640         return;
 641     }
 642
 643     /* Try to find caption among the ancestors of widget */
 644     if (gtk_widget_is_ancestor (widget, caption))
 645     {
 646         priv->is_focused = TRUE;
 647         gtk_widget_queue_draw (caption);
 648         return;
 649     }
 650
 651     if (priv->is_focused == TRUE)
 652     {
 653         /* Caption wasn't found, so cannot focus */
 654         priv->is_focused = FALSE;
 655         gtk_widget_queue_draw (caption);
 656     }
 657 }
 658
 659 /* We need to connect/disconnect signal handlers to toplevel window
 660    in which we reside. Ww want to update connected signals if our
 661    parent changes */
 662 static void
 663 hildon_caption_hierarchy_changed                (GtkWidget *widget,
 664                                                  GtkWidget *previous_toplevel)
 665 {
 666     GtkWidget *current_ancestor;
 667     HildonCaptionPrivate *priv;
 668
 669     priv = HILDON_CAPTION_GET_PRIVATE (widget);
 670     g_assert (priv);
 671
 672     if (GTK_WIDGET_CLASS (parent_class)->hierarchy_changed)
 673         GTK_WIDGET_CLASS (parent_class)->hierarchy_changed (widget, previous_toplevel);
 674
 675     /* If we already were inside a window, remove old handler */
 676     if (previous_toplevel) {
 677         /* This is a compilation workaround for gcc > 3.3 since glib is buggy */
 678         /* see http://bugzilla.gnome.org/show_bug.cgi?id=310175 */
 679 #ifdef __GNUC__
 680         __extension__
 681 #endif
 682             g_signal_handlers_disconnect_by_func
 683             (previous_toplevel, (gpointer) hildon_caption_set_focus, widget);
 684     }
 685
 686     current_ancestor = gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW);
 687
 688     /* Install new handler for focus movement */
 689     if (current_ancestor)
 690         g_signal_connect( current_ancestor, "set-focus",
 691                 G_CALLBACK (hildon_caption_set_focus), widget );
 692 }
 693
 694 static void
 695 hildon_caption_size_request                     (GtkWidget *widget,
 696                                                  GtkRequisition *requisition)
 697 {
 698     GtkRequisition req;
 699     HildonCaptionPrivate *priv = NULL;
 700     g_return_if_fail (HILDON_IS_CAPTION(widget));
 701
 702     priv = HILDON_CAPTION_GET_PRIVATE (widget);
 703     g_assert (priv);
 704
 705     /* Use the same size requisition for the main box of the caption */
 706     gtk_widget_size_request (priv->caption_area, &req);
 707
 708     if (GTK_WIDGET_CLASS (parent_class)->size_request)
 709         GTK_WIDGET_CLASS (parent_class)->size_request (widget, requisition);
 710
 711     requisition->width += req.width + HILDON_CAPTION_SPACING * 3;
 712
 713     if ((req.height + (2 * widget->style->ythickness)) > requisition->height)
 714         requisition->height = req.height + (2 * widget->style->ythickness);
 715 }
 716
 717 /* We use HILDON_CAPTION_SPACING to make it look a bit nicer */
 718 static void
 719 hildon_caption_size_allocate                    (GtkWidget *widget,
 720                                                  GtkAllocation *allocation)
 721 {
 722     GtkAllocation child_alloc;
 723     GtkAllocation caption_alloc;
 724     GtkRequisition req;
 725     GtkWidget *child = NULL;
 726     HildonCaptionPrivate *priv = NULL;
 727
 728     g_assert (HILDON_IS_CAPTION (widget));
 729     priv = HILDON_CAPTION_GET_PRIVATE (widget);
 730     g_assert (priv);
 731
 732     /* Position the caption to its allocated location */
 733     if (GTK_WIDGET_REALIZED (widget))
 734         gdk_window_move_resize (widget->window,
 735                 allocation->x + GTK_CONTAINER (widget)->border_width,
 736                 allocation->y + GTK_CONTAINER (widget)->border_width,
 737                 MAX (allocation->width - GTK_CONTAINER (widget)->border_width * 2, 0),
 738                 MAX (allocation->height - GTK_CONTAINER (widget)->border_width * 2, 0));
 739
 740     child = GTK_BIN (widget)->child;
 741
 742     widget->allocation = *allocation;
 743     gtk_widget_get_child_requisition (priv->caption_area, &req);
 744
 745     child_alloc.height = caption_alloc.height = allocation->height;
 746     child_alloc.width  = caption_alloc.width  = allocation->width;
 747     child_alloc.x = caption_alloc.x = caption_alloc.y = child_alloc.y = 0;
 748
 749     /* Center the captioned widget */
 750     if (child_alloc.width > req.width + HILDON_CAPTION_SPACING)
 751     {
 752         child_alloc.x += req.width + HILDON_CAPTION_SPACING * 2;
 753         caption_alloc.width = req.width;
 754     }
 755
 756     /* Leave at least the space of the HILDON_CAPTION_SPACING in the left */
 757     caption_alloc.x = HILDON_CAPTION_SPACING;
 758
 759     /* Leave room for the other drawable parts of the caption control */
 760     child_alloc.width -= req.width + HILDON_CAPTION_SPACING * 2;
 761
 762     /* Give the child at least its minimum requisition, unless it is expandable */
 763     if (! priv->expand && child && GTK_WIDGET_VISIBLE(child))
 764     {
 765         GtkRequisition child_req;
 766         gtk_widget_get_child_requisition (child, &child_req);
 767         child_alloc.width  = MIN (child_alloc.width,  child_req.width);
 768         child_alloc.height = MIN (child_alloc.height, child_req.height);
 769         /* Center the child */
 770         child_alloc.y = (allocation->height - child_alloc.height -
 771                          2 * GTK_CONTAINER (widget)->border_width)/2;
 772     }
 773
 774     /* Ensure there are no negative dimensions */
 775     if (child_alloc.width < 0)
 776     {
 777         caption_alloc.width = req.width + child_alloc.width;
 778         child_alloc.width = 0;
 779         caption_alloc.width = MAX (caption_alloc.width, 0);
 780     }
 781
 782     child_alloc.height = MAX (child_alloc.height, 0);
 783     caption_alloc.height = MAX (caption_alloc.height, 0);
 784
 785     if (child && GTK_WIDGET_VISIBLE(child) )
 786         gtk_widget_size_allocate (child, &child_alloc );
 787
 788     gtk_widget_size_allocate (priv->caption_area, &caption_alloc);
 789 }
 790
 791 static void
 792 hildon_caption_forall                           (GtkContainer *container,
 793                                                  gboolean include_internals,
 794                                                  GtkCallback callback,
 795                                                  gpointer data)
 796 {
 797     HildonCaptionPrivate *priv = NULL;
 798
 799     g_assert (HILDON_IS_CAPTION (container));
 800     g_assert (callback != NULL);
 801
 802     priv = HILDON_CAPTION_GET_PRIVATE (container);
 803     g_assert (priv);
 804
 805     /* Execute callback for the child widgets */
 806     if (GTK_CONTAINER_CLASS (parent_class)->forall)
 807         GTK_CONTAINER_CLASS (parent_class)->forall (container, include_internals, callback, data);
 808
 809     if (include_internals)
 810         /* Execute callback for the parent box as well */
 811         (*callback) (priv->caption_area, data);
 812 }
 813
 814 /**
 815  * hildon_caption_set_size_group:
 816  * @caption : a #HildonCaption
 817  * @new_group : a #GtkSizeGroup
 818  *
 819  * Sets a #GtkSizeGroup of a given captioned control.
 820  *
 821  */
 822 void
 823 hildon_caption_set_size_group                   (const HildonCaption *self,
 824                                                  GtkSizeGroup *group)
 825 {
 826     g_object_set (G_OBJECT(self), "size_group", group, NULL);
 827 }
 828
 829 /**
 830  * hildon_caption_get_size_group:
 831  * @caption : a #HildonCaption
 832  *
 833  * Query given captioned control for the #GtkSizeGroup assigned to it.
 834  *
 835  * @Returns : a #GtkSizeGroup
 836  *
 837  */
 838 GtkSizeGroup*
 839 hildon_caption_get_size_group                   (const HildonCaption *self)
 840 {
 841     HildonCaptionPrivate *priv;
 842     g_return_val_if_fail (HILDON_IS_CAPTION (self), NULL);
 843
 844     priv = HILDON_CAPTION_GET_PRIVATE(self);
 845     g_assert (priv);
 846
 847     return priv->group;
 848 }
 849
 850 /**
 851  * hildon_caption_new:
 852  * @group : a #GtkSizeGroup for controlling the size of related captions,
 853  *          Can be NULL
 854  * @value : the caption text to accompany the text entry.  The widget makes
 855  *          a copy of this text.
 856  * @control : the control that is to be captioned
 857  * @icon : an icon to accompany the label - can be NULL in which case no
 858  *         icon is displayed
 859  * @flag : indicates whether this captioned control is mandatory or
 860  *         optional
 861  *
 862  * Creates a new instance of hildon_caption widget, with a specific
 863  * control and image.
 864  * Note: Clicking on a focused caption will trigger the activate signal.
 865  * The default behaviour for the caption's activate signal is to call
 866  * gtk_widget_activate on it's control.
 867  *
 868  * @Returns : a #GtkWidget pointer of Caption
 869  */
 870 GtkWidget*
 871 hildon_caption_new                              (GtkSizeGroup *group,
 872                                                  const gchar *value,
 873                                                  GtkWidget *child,
 874                                                  GtkWidget *icon,
 875                                                  HildonCaptionStatus flag)
 876 {
 877     GtkWidget *widget;
 878     g_return_val_if_fail (GTK_IS_WIDGET (child), NULL);
 879
 880     widget = g_object_new (HILDON_TYPE_CAPTION,
 881             "label", value,
 882             "child", child,
 883             "size_group", group,
 884             "icon", icon,
 885             "status", flag,
 886             NULL);
 887
 888     /* Do not expand GtkCheckButton by default, we want to reduce its activation area */
 889     if (GTK_IS_CHECK_BUTTON (child))
 890       hildon_caption_set_child_expand (HILDON_CAPTION (widget), FALSE);
 891
 892     return widget;
 893 }
 894
 895 /**
 896  * hildon_caption_is_mandatory:
 897  * @caption : a #HildonCaption
 898  *
 899  * Query #HildonCaption whether this captioned control is a mandatory one.
 900  *
 901  * @Returns : is this captioned control a mandatory one?
 902  */
 903 gboolean
 904 hildon_caption_is_mandatory                     (const HildonCaption *caption)
 905 {
 906     HildonCaptionPrivate *priv;
 907
 908     g_return_val_if_fail (HILDON_IS_CAPTION (caption), FALSE);
 909
 910     priv = HILDON_CAPTION_GET_PRIVATE (caption);
 911     g_assert (priv);
 912
 913     return (priv->status == HILDON_CAPTION_MANDATORY);
 914 }
 915
 916 /**
 917  * hildon_caption_set_icon_position:
 918  * @caption : a #HildonCaption
 919  * @pos : one of the values from #HildonCaptionIconPosition
 920  *
 921  * Sets #HildonCaption icon position.
 922  *
 923  */
 924 void
 925 hildon_caption_set_icon_position                (HildonCaption *caption,
 926                                                  HildonCaptionIconPosition pos)
 927 {
 928     g_return_if_fail (HILDON_IS_CAPTION (caption));
 929     HildonCaptionPrivate *priv = HILDON_CAPTION_GET_PRIVATE (caption);
 930     g_assert (priv);
 931
 932     g_return_if_fail (priv->caption_area != NULL);
 933
 934     int order = (pos == HILDON_CAPTION_POSITION_LEFT) ? -1 : 0;
 935     gtk_box_reorder_child (GTK_BOX (priv->caption_area), priv->icon_align, order);
 936
 937     priv->icon_position = pos;
 938 }
 939
 940 /**
 941  * hildon_caption_get_icon_position:
 942  * @caption : a #HildonCaption
 943  *
 944  * Gets #HildonCaption icon position.
 945  *
 946  * @Returns : one of the values from #HildonCaptionIconPosition.
 947  *
 948  */
 949
 950 HildonCaptionIconPosition
 951 hildon_caption_get_icon_position                (const HildonCaption *caption)
 952 {
 953     g_return_val_if_fail (HILDON_IS_CAPTION (caption), 0);
 954
 955     HildonCaptionPrivate *priv = HILDON_CAPTION_GET_PRIVATE (caption);
 956     g_assert (priv);
 957
 958     return priv->icon_position;
 959 }
 960
 961 /**
 962  * hildon_caption_set_status:
 963  * @caption : a #HildonCaption
 964  * @flag : one of the values from #HildonCaptionStatus
 965  *
 966  * Sets #HildonCaption status.
 967  */
 968 void
 969 hildon_caption_set_status                       (HildonCaption *caption,
 970                                                  HildonCaptionStatus flag)
 971 {
 972     g_return_if_fail (HILDON_IS_CAPTION(caption));
 973
 974     g_object_set (G_OBJECT(caption), "status", flag, NULL);
 975 }
 976
 977 /**
 978  * hildon_caption_get_status:
 979  * @caption : a #HildonCaption
 980  *
 981  * Gets #HildonCaption status.
 982  *
 983  * @Returns : one of the values from #HildonCaptionStatus
 984  */
 985 HildonCaptionStatus
 986 hildon_caption_get_status                       (const HildonCaption *caption)
 987 {
 988     HildonCaptionPrivate *priv;
 989     g_return_val_if_fail (HILDON_IS_CAPTION (caption), HILDON_CAPTION_OPTIONAL);
 990
 991     priv = HILDON_CAPTION_GET_PRIVATE(caption);
 992     g_assert (priv);
 993
 994     return priv->status;
 995 }
 996
 997 /**
 998  * hildon_caption_set_icon_image:
 999  * @caption : a #HildonCaption
1000  * @icon : the #GtkImage to use as the icon.
1001  *         calls gtk_widget_show on the icon if !GTK_WIDGET_VISIBLE(icon)
1002  *
1003  * Sets the icon image widget to be used by this hildon_caption widget.
1004  */
1005 void
1006 hildon_caption_set_icon_image                   (HildonCaption *caption,
1007                                                  GtkWidget *icon)
1008 {
1009     g_return_if_fail (HILDON_IS_CAPTION(caption));
1010
1011     g_object_set (G_OBJECT(caption), "icon", icon, NULL);
1012 }
1013
1014 /**
1015  * hildon_caption_get_icon_image:
1016  * @caption : a #HildonCaption
1017  *
1018  * Gets icon of #HildonCaption
1019  *
1020  * @Returns : the #GtkImage widget that is being used as the icon by the
1021  *            hildon_caption, or NULL if no icon image is in use.
1022  */
1023 GtkWidget*
1024 hildon_caption_get_icon_image                   (const HildonCaption *caption)
1025 {
1026     HildonCaptionPrivate *priv;
1027
1028     g_return_val_if_fail (HILDON_IS_CAPTION (caption), NULL);
1029
1030     priv = HILDON_CAPTION_GET_PRIVATE (caption);
1031     g_assert (priv);
1032
1033     return priv->icon;
1034 }
1035
1036 /**
1037  * hildon_caption_set_label:
1038  * @caption : a #HildonCaption
1039  * @label : the text to use
1040  *
1041  * Sets the label text that appears before the control.
1042  * Separator character is added to the end of the label string. By default
1043  * the separator is ":".
1044  */
1045 void
1046 hildon_caption_set_label                        (HildonCaption *caption,
1047                                                  const gchar *label)
1048 {
1049     g_return_if_fail (HILDON_IS_CAPTION (caption));
1050
1051     g_object_set (G_OBJECT(caption), "label", label, NULL);
1052 }
1053
1054 /**
1055  * hildon_caption_set_label_markup:
1056  * @caption : a #HildonCaption
1057  * @markup : the markup text to use
1058  *
1059  * Sets the label markup text that appears before the control. It acts like
1060  * #hildon_caption_set_label but is using the markup text that allows to specify
1061  * text properties such as bold or italic.
1062  */
1063 void
1064 hildon_caption_set_label_markup                 (HildonCaption *caption,
1065                                                  const gchar *markup)
1066 {
1067     g_return_if_fail (HILDON_IS_CAPTION (caption));
1068
1069     g_object_set (G_OBJECT(caption), "markup", markup, NULL);
1070 }
1071
1072 /**
1073  * hildon_caption_get_label:
1074  * @caption : a #HildonCaption
1075  *
1076  * Gets label of #HildonCaption
1077  *
1078  * @Returns : the text currently being used as the label of the caption
1079  *  control. The string is owned by the label and the caller should never
1080  *  free or modify this value.
1081  */
1082 gchar*
1083 hildon_caption_get_label                        (const HildonCaption *caption)
1084 {
1085     HildonCaptionPrivate *priv;
1086     g_return_val_if_fail (HILDON_IS_CAPTION (caption), "");
1087     priv = HILDON_CAPTION_GET_PRIVATE (caption);
1088     g_assert (priv);
1089
1090     return (gchar*) gtk_label_get_text (GTK_LABEL (priv->label));
1091 }
1092
1093 /**
1094  * hildon_caption_set_separator:
1095  * @caption : a #HildonCaption
1096  * @separator : the separator to use
1097  *
1098  * Sets the separator character that appears after the label.
1099  * The default seaparator character is ":"
1100  * separately.
1101  */
1102 void
1103 hildon_caption_set_separator                    (HildonCaption *caption,
1104                                                  const gchar *separator)
1105 {
1106     g_return_if_fail (HILDON_IS_CAPTION (caption));
1107
1108     g_object_set (G_OBJECT (caption), "separator", separator, NULL);
1109 }
1110
1111 /**
1112  * hildon_caption_get_separator:
1113  * @caption : a #HildonCaption
1114  *
1115  * Gets separator string of #HildonCaption
1116  *
1117  * @Returns : the text currently being used as the separator of the caption
1118  *  control. The string is owned by the caption control and the caller should
1119  *  never free or modify this value.
1120  */
1121 gchar*
1122 hildon_caption_get_separator                    (const HildonCaption *caption)
1123 {
1124     HildonCaptionPrivate *priv;
1125     g_return_val_if_fail (HILDON_IS_CAPTION (caption), "");
1126
1127     priv = HILDON_CAPTION_GET_PRIVATE (caption);
1128     g_assert (priv);
1129
1130     return priv->separator;
1131 }
1132
1133 /* Activates the child control
1134  * We have this signal so that if needed an application can
1135  * know when we've been activated (useful for captions with
1136  * multiple children
1137  * FIXME: There never are multiple children. Possibly activate
1138  *  signal could be removed entirely? (does anyone use it?)
1139  */
1140 static void
1141 hildon_caption_activate                         (GtkWidget *widget)
1142 {
1143     GtkWidget *child = GTK_BIN (widget)->child;
1144     gtk_widget_grab_focus (child);
1145 }
1146
1147 static void
1148 hildon_caption_grab_focus                       (GtkWidget *widget)
1149 {
1150     gtk_widget_grab_focus (GTK_BIN (widget)->child);
1151 }
1152
1153 /**
1154  * hildon_caption_set_child_expand:
1155  * @caption : a #HildonCaption
1156  * @expand : gboolean to determine if the child is expandable
1157  *
1158  * Sets child expandability.
1159  */
1160 void
1161 hildon_caption_set_child_expand                 (HildonCaption *caption,
1162                                                  gboolean expand)
1163 {
1164     HildonCaptionPrivate *priv = NULL;
1165     GtkWidget *child = NULL;
1166     g_return_if_fail (HILDON_IS_CAPTION (caption));
1167
1168     priv = HILDON_CAPTION_GET_PRIVATE (caption);
1169     g_assert (priv);
1170
1171     /* Did the setting really change? */
1172     if (priv->expand == expand)
1173         return;
1174
1175     priv->expand = expand;
1176     child = GTK_BIN (caption)->child;
1177
1178     /* We do not have a child, nothing to do */
1179     if (! GTK_IS_WIDGET (child))
1180         return;
1181
1182     if (GTK_WIDGET_VISIBLE (child) && GTK_WIDGET_VISIBLE (caption))
1183         gtk_widget_queue_resize (child);
1184
1185     gtk_widget_child_notify (child, "expand");
1186 }
1187
1188 /**
1189  * hildon_caption_get_child_expand:
1190  * @caption : a #HildonCaption
1191  *
1192  * Gets childs expandability.
1193  *
1194  * @Returns : wheter the child is expandable or not.
1195  */
1196 gboolean
1197 hildon_caption_get_child_expand                 (const HildonCaption *caption)
1198 {
1199     HildonCaptionPrivate *priv = NULL;
1200     g_return_val_if_fail (HILDON_IS_CAPTION (caption), FALSE);
1201
1202     priv = HILDON_CAPTION_GET_PRIVATE (caption);
1203     g_assert (priv);
1204
1205     return priv->expand;
1206 }
1207
1208 static void
1209 hildon_caption_set_label_text                   (HildonCaptionPrivate *priv,
1210                                                  gboolean markup)
1211 {
1212     gchar *tmp = NULL;
1213     g_assert (priv != NULL);
1214
1215     if (priv->text)
1216     {
1217         if (priv->separator)
1218         {
1219             /* Don't duplicate the separator, if the string already contains one */
1220             if (g_str_has_suffix (priv->text, priv->separator))
1221             {
1222                 if (markup)
1223                     gtk_label_set_markup (GTK_LABEL (priv->label), priv->text);
1224                 else
1225                     gtk_label_set_text (GTK_LABEL (priv->label), priv->text);
1226             }
1227             else
1228             {
1229                 /* Append separator and set text */
1230                 tmp = g_strconcat( priv->text, priv->separator, NULL );
1231
1232                 if (markup)
1233                     gtk_label_set_markup (GTK_LABEL (priv->label), tmp);
1234                 else
1235                     gtk_label_set_text (GTK_LABEL (priv->label), tmp);
1236
1237                 g_free (tmp);
1238             }
1239         }
1240         else
1241         {
1242             if (markup)
1243                 gtk_label_set_markup (GTK_LABEL (priv->label), priv->text);
1244             else
1245                 gtk_label_set_text (GTK_LABEL (priv->label), priv->text);
1246         }
1247     }
1248     else
1249     {
1250         /* Clear the label */
1251         if (markup)
1252             gtk_label_set_markup (GTK_LABEL (priv->label), "");
1253         else
1254             gtk_label_set_text (GTK_LABEL (priv->label), "" );
1255     }
1256 }
1257
1258 /**
1259  * hildon_caption_set_label_alignment:
1260  * @caption: a #HildonCaption widget
1261  * @alignment: new vertical alignment
1262  *
1263  * Sets the vertical alignment to be used for the
1264  * text part of the caption. Applications need to
1265  * align the child control themselves.
1266  *
1267  */
1268 void
1269 hildon_caption_set_label_alignment              (HildonCaption *caption,
1270                                                  gfloat alignment)
1271 {
1272     HildonCaptionPrivate *priv;
1273
1274     g_return_if_fail (HILDON_IS_CAPTION (caption));
1275
1276     priv = HILDON_CAPTION_GET_PRIVATE (caption);
1277     g_assert (priv);
1278
1279     g_object_set (priv->label, "yalign", alignment, NULL);
1280     g_object_set (priv->icon_align, "yalign", alignment, NULL);
1281
1282 }
1283
1284 /**
1285  * hildon_caption_get_label_alignment:
1286  * @caption: a #HildonCaption widget
1287  *
1288  * Gets current vertical alignment for the text part.
1289  *
1290  * Returns: vertical alignment
1291  *
1292  */
1293 gfloat
1294 hildon_caption_get_label_alignment              (HildonCaption *caption)
1295 {
1296     HildonCaptionPrivate *priv;
1297     gfloat result;
1298
1299     g_return_val_if_fail (HILDON_IS_CAPTION (caption), 0);
1300     priv = HILDON_CAPTION_GET_PRIVATE (caption);
1301     g_assert (priv);
1302
1303     g_object_get (priv->label, "yalign", &result, NULL);
1304
1305     return result;
1306 }