1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
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.
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.
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., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
31 #include "gtkprivate.h"
33 #include "gtkbuildable.h"
34 #include "gtksizerequest.h"
37 #define LABEL_SIDE_PAD 2
42 GtkWidget *label_widget;
49 GtkAllocation child_allocation;
62 static void gtk_frame_set_property (GObject *object,
66 static void gtk_frame_get_property (GObject *object,
70 static void gtk_frame_paint (GtkWidget *widget,
72 static gint gtk_frame_expose (GtkWidget *widget,
73 GdkEventExpose *event);
74 static void gtk_frame_size_allocate (GtkWidget *widget,
75 GtkAllocation *allocation);
76 static void gtk_frame_remove (GtkContainer *container,
78 static void gtk_frame_forall (GtkContainer *container,
79 gboolean include_internals,
81 gpointer callback_data);
83 static void gtk_frame_compute_child_allocation (GtkFrame *frame,
84 GtkAllocation *child_allocation);
85 static void gtk_frame_real_compute_child_allocation (GtkFrame *frame,
86 GtkAllocation *child_allocation);
89 static void gtk_frame_buildable_init (GtkBuildableIface *iface);
90 static void gtk_frame_buildable_add_child (GtkBuildable *buildable,
95 static void gtk_frame_size_request_init (GtkSizeRequestIface *iface);
96 static void gtk_frame_get_width (GtkSizeRequest *widget,
99 static void gtk_frame_get_height (GtkSizeRequest *widget,
103 G_DEFINE_TYPE_WITH_CODE (GtkFrame, gtk_frame, GTK_TYPE_BIN,
104 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
105 gtk_frame_buildable_init)
106 G_IMPLEMENT_INTERFACE (GTK_TYPE_SIZE_REQUEST,
107 gtk_frame_size_request_init))
110 gtk_frame_class_init (GtkFrameClass *class)
112 GObjectClass *gobject_class;
113 GtkWidgetClass *widget_class;
114 GtkContainerClass *container_class;
116 gobject_class = (GObjectClass*) class;
117 widget_class = GTK_WIDGET_CLASS (class);
118 container_class = GTK_CONTAINER_CLASS (class);
120 gobject_class->set_property = gtk_frame_set_property;
121 gobject_class->get_property = gtk_frame_get_property;
123 g_object_class_install_property (gobject_class,
125 g_param_spec_string ("label",
127 P_("Text of the frame's label"),
130 GTK_PARAM_WRITABLE));
131 g_object_class_install_property (gobject_class,
133 g_param_spec_float ("label-xalign",
135 P_("The horizontal alignment of the label"),
139 GTK_PARAM_READWRITE));
140 g_object_class_install_property (gobject_class,
142 g_param_spec_float ("label-yalign",
144 P_("The vertical alignment of the label"),
148 GTK_PARAM_READWRITE));
149 g_object_class_install_property (gobject_class,
151 g_param_spec_enum ("shadow", NULL,
152 P_("Deprecated property, use shadow_type instead"),
153 GTK_TYPE_SHADOW_TYPE,
154 GTK_SHADOW_ETCHED_IN,
155 GTK_PARAM_READWRITE));
156 g_object_class_install_property (gobject_class,
158 g_param_spec_enum ("shadow-type",
160 P_("Appearance of the frame border"),
161 GTK_TYPE_SHADOW_TYPE,
162 GTK_SHADOW_ETCHED_IN,
163 GTK_PARAM_READWRITE));
165 g_object_class_install_property (gobject_class,
167 g_param_spec_object ("label-widget",
169 P_("A widget to display in place of the usual frame label"),
171 GTK_PARAM_READWRITE));
173 widget_class->expose_event = gtk_frame_expose;
174 widget_class->size_allocate = gtk_frame_size_allocate;
176 container_class->remove = gtk_frame_remove;
177 container_class->forall = gtk_frame_forall;
179 class->compute_child_allocation = gtk_frame_real_compute_child_allocation;
181 g_type_class_add_private (class, sizeof (GtkFramePriv));
185 gtk_frame_buildable_init (GtkBuildableIface *iface)
187 iface->add_child = gtk_frame_buildable_add_child;
191 gtk_frame_buildable_add_child (GtkBuildable *buildable,
196 if (type && strcmp (type, "label") == 0)
197 gtk_frame_set_label_widget (GTK_FRAME (buildable), GTK_WIDGET (child));
199 gtk_container_add (GTK_CONTAINER (buildable), GTK_WIDGET (child));
201 GTK_BUILDER_WARN_INVALID_CHILD_TYPE (GTK_FRAME (buildable), type);
205 gtk_frame_init (GtkFrame *frame)
209 frame->priv = G_TYPE_INSTANCE_GET_PRIVATE (frame,
214 priv->label_widget = NULL;
215 priv->shadow_type = GTK_SHADOW_ETCHED_IN;
216 priv->label_xalign = 0.0;
217 priv->label_yalign = 0.5;
221 gtk_frame_set_property (GObject *object,
226 GtkFrame *frame = GTK_FRAME (object);
227 GtkFramePriv *priv = frame->priv;
232 gtk_frame_set_label (frame, g_value_get_string (value));
234 case PROP_LABEL_XALIGN:
235 gtk_frame_set_label_align (frame, g_value_get_float (value),
238 case PROP_LABEL_YALIGN:
239 gtk_frame_set_label_align (frame, priv->label_xalign,
240 g_value_get_float (value));
243 case PROP_SHADOW_TYPE:
244 gtk_frame_set_shadow_type (frame, g_value_get_enum (value));
246 case PROP_LABEL_WIDGET:
247 gtk_frame_set_label_widget (frame, g_value_get_object (value));
250 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
256 gtk_frame_get_property (GObject *object,
261 GtkFrame *frame = GTK_FRAME (object);
262 GtkFramePriv *priv = frame->priv;
267 g_value_set_string (value, gtk_frame_get_label (frame));
269 case PROP_LABEL_XALIGN:
270 g_value_set_float (value, priv->label_xalign);
272 case PROP_LABEL_YALIGN:
273 g_value_set_float (value, priv->label_yalign);
276 case PROP_SHADOW_TYPE:
277 g_value_set_enum (value, priv->shadow_type);
279 case PROP_LABEL_WIDGET:
280 g_value_set_object (value,
282 G_OBJECT (priv->label_widget) : NULL);
285 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
292 * @label: the text to use as the label of the frame
294 * Creates a new #GtkFrame, with optional label @label.
295 * If @label is %NULL, the label is omitted.
297 * Return value: a new #GtkFrame widget
300 gtk_frame_new (const gchar *label)
302 return g_object_new (GTK_TYPE_FRAME, "label", label, NULL);
306 gtk_frame_remove (GtkContainer *container,
309 GtkFrame *frame = GTK_FRAME (container);
310 GtkFramePriv *priv = frame->priv;
312 if (priv->label_widget == child)
313 gtk_frame_set_label_widget (frame, NULL);
315 GTK_CONTAINER_CLASS (gtk_frame_parent_class)->remove (container, child);
319 gtk_frame_forall (GtkContainer *container,
320 gboolean include_internals,
321 GtkCallback callback,
322 gpointer callback_data)
324 GtkBin *bin = GTK_BIN (container);
325 GtkFrame *frame = GTK_FRAME (container);
326 GtkFramePriv *priv = frame->priv;
329 child = gtk_bin_get_child (bin);
331 (* callback) (child, callback_data);
333 if (priv->label_widget)
334 (* callback) (priv->label_widget, callback_data);
338 * gtk_frame_set_label:
339 * @frame: a #GtkFrame
340 * @label: (allow-none): the text to use as the label of the frame
342 * Sets the text of the label. If @label is %NULL,
343 * the current label is removed.
346 gtk_frame_set_label (GtkFrame *frame,
349 g_return_if_fail (GTK_IS_FRAME (frame));
353 gtk_frame_set_label_widget (frame, NULL);
357 GtkWidget *child = gtk_label_new (label);
358 gtk_widget_show (child);
360 gtk_frame_set_label_widget (frame, child);
365 * gtk_frame_get_label:
366 * @frame: a #GtkFrame
368 * If the frame's label widget is a #GtkLabel, returns the
369 * text in the label widget. (The frame will have a #GtkLabel
370 * for the label widget if a non-%NULL argument was passed
371 * to gtk_frame_new().)
373 * Return value: the text in the label, or %NULL if there
374 * was no label widget or the lable widget was not
375 * a #GtkLabel. This string is owned by GTK+ and
376 * must not be modified or freed.
378 G_CONST_RETURN gchar *
379 gtk_frame_get_label (GtkFrame *frame)
383 g_return_val_if_fail (GTK_IS_FRAME (frame), NULL);
387 if (GTK_IS_LABEL (priv->label_widget))
388 return gtk_label_get_text (GTK_LABEL (priv->label_widget));
394 * gtk_frame_set_label_widget:
395 * @frame: a #GtkFrame
396 * @label_widget: the new label widget
398 * Sets the label widget for the frame. This is the widget that
399 * will appear embedded in the top edge of the frame as a
403 gtk_frame_set_label_widget (GtkFrame *frame,
404 GtkWidget *label_widget)
407 gboolean need_resize = FALSE;
409 g_return_if_fail (GTK_IS_FRAME (frame));
410 g_return_if_fail (label_widget == NULL || GTK_IS_WIDGET (label_widget));
411 g_return_if_fail (label_widget == NULL || label_widget->parent == NULL);
415 if (priv->label_widget == label_widget)
418 if (priv->label_widget)
420 need_resize = gtk_widget_get_visible (priv->label_widget);
421 gtk_widget_unparent (priv->label_widget);
424 priv->label_widget = label_widget;
428 priv->label_widget = label_widget;
429 gtk_widget_set_parent (label_widget, GTK_WIDGET (frame));
430 need_resize |= gtk_widget_get_visible (label_widget);
433 if (gtk_widget_get_visible (GTK_WIDGET (frame)) && need_resize)
434 gtk_widget_queue_resize (GTK_WIDGET (frame));
436 g_object_freeze_notify (G_OBJECT (frame));
437 g_object_notify (G_OBJECT (frame), "label-widget");
438 g_object_notify (G_OBJECT (frame), "label");
439 g_object_thaw_notify (G_OBJECT (frame));
443 * gtk_frame_get_label_widget:
444 * @frame: a #GtkFrame
446 * Retrieves the label widget for the frame. See
447 * gtk_frame_set_label_widget().
449 * Return value: the label widget, or %NULL if there is none.
452 gtk_frame_get_label_widget (GtkFrame *frame)
454 g_return_val_if_fail (GTK_IS_FRAME (frame), NULL);
456 return frame->priv->label_widget;
460 * gtk_frame_set_label_align:
461 * @frame: a #GtkFrame
462 * @xalign: The position of the label along the top edge
463 * of the widget. A value of 0.0 represents left alignment;
464 * 1.0 represents right alignment.
465 * @yalign: The y alignment of the label. A value of 0.0 aligns under
466 * the frame; 1.0 aligns above the frame. If the values are exactly
467 * 0.0 or 1.0 the gap in the frame won't be painted because the label
468 * will be completely above or below the frame.
470 * Sets the alignment of the frame widget's label. The
471 * default values for a newly created frame are 0.0 and 0.5.
474 gtk_frame_set_label_align (GtkFrame *frame,
480 g_return_if_fail (GTK_IS_FRAME (frame));
484 xalign = CLAMP (xalign, 0.0, 1.0);
485 yalign = CLAMP (yalign, 0.0, 1.0);
487 g_object_freeze_notify (G_OBJECT (frame));
488 if (xalign != priv->label_xalign)
490 priv->label_xalign = xalign;
491 g_object_notify (G_OBJECT (frame), "label-xalign");
494 if (yalign != priv->label_yalign)
496 priv->label_yalign = yalign;
497 g_object_notify (G_OBJECT (frame), "label-yalign");
500 g_object_thaw_notify (G_OBJECT (frame));
501 gtk_widget_queue_resize (GTK_WIDGET (frame));
505 * gtk_frame_get_label_align:
506 * @frame: a #GtkFrame
507 * @xalign: (allow-none): location to store X alignment of frame's label, or %NULL
508 * @yalign: (allow-none): location to store X alignment of frame's label, or %NULL
510 * Retrieves the X and Y alignment of the frame's label. See
511 * gtk_frame_set_label_align().
514 gtk_frame_get_label_align (GtkFrame *frame,
520 g_return_if_fail (GTK_IS_FRAME (frame));
525 *xalign = priv->label_xalign;
527 *yalign = priv->label_yalign;
531 * gtk_frame_set_shadow_type:
532 * @frame: a #GtkFrame
533 * @type: the new #GtkShadowType
535 * Sets the shadow type for @frame.
538 gtk_frame_set_shadow_type (GtkFrame *frame,
544 g_return_if_fail (GTK_IS_FRAME (frame));
548 if ((GtkShadowType) priv->shadow_type != type)
550 widget = GTK_WIDGET (frame);
551 priv->shadow_type = type;
552 g_object_notify (G_OBJECT (frame), "shadow-type");
554 if (gtk_widget_is_drawable (widget))
556 gtk_widget_queue_draw (widget);
559 gtk_widget_queue_resize (widget);
564 * gtk_frame_get_shadow_type:
565 * @frame: a #GtkFrame
567 * Retrieves the shadow type of the frame. See
568 * gtk_frame_set_shadow_type().
570 * Return value: the current shadow type of the frame.
573 gtk_frame_get_shadow_type (GtkFrame *frame)
575 g_return_val_if_fail (GTK_IS_FRAME (frame), GTK_SHADOW_ETCHED_IN);
577 return frame->priv->shadow_type;
581 gtk_frame_paint (GtkWidget *widget,
586 gint x, y, width, height;
588 if (gtk_widget_is_drawable (widget))
590 frame = GTK_FRAME (widget);
593 x = priv->child_allocation.x - widget->style->xthickness;
594 y = priv->child_allocation.y - widget->style->ythickness;
595 width = priv->child_allocation.width + 2 * widget->style->xthickness;
596 height = priv->child_allocation.height + 2 * widget->style->ythickness;
598 if (priv->label_widget)
600 GtkRequisition child_requisition;
605 gtk_widget_get_child_requisition (priv->label_widget, &child_requisition);
607 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)
608 xalign = priv->label_xalign;
610 xalign = 1 - priv->label_xalign;
612 height_extra = MAX (0, child_requisition.height - widget->style->ythickness)
613 - priv->label_yalign * child_requisition.height;
615 height += height_extra;
617 x2 = widget->style->xthickness + (priv->child_allocation.width - child_requisition.width - 2 * LABEL_PAD - 2 * LABEL_SIDE_PAD) * xalign + LABEL_SIDE_PAD;
619 /* If the label is completely over or under the frame we can omit the gap */
620 if (priv->label_yalign == 0.0 || priv->label_yalign == 1.0)
621 gtk_paint_shadow (widget->style, widget->window,
622 widget->state, priv->shadow_type,
623 area, widget, "frame",
624 x, y, width, height);
626 gtk_paint_shadow_gap (widget->style, widget->window,
627 widget->state, priv->shadow_type,
628 area, widget, "frame",
631 x2, child_requisition.width + 2 * LABEL_PAD);
634 gtk_paint_shadow (widget->style, widget->window,
635 widget->state, priv->shadow_type,
636 area, widget, "frame",
637 x, y, width, height);
642 gtk_frame_expose (GtkWidget *widget,
643 GdkEventExpose *event)
645 if (gtk_widget_is_drawable (widget))
647 gtk_frame_paint (widget, &event->area);
649 GTK_WIDGET_CLASS (gtk_frame_parent_class)->expose_event (widget, event);
656 gtk_frame_size_allocate (GtkWidget *widget,
657 GtkAllocation *allocation)
659 GtkFrame *frame = GTK_FRAME (widget);
660 GtkFramePriv *priv = frame->priv;
661 GtkBin *bin = GTK_BIN (widget);
662 GtkAllocation new_allocation;
665 widget->allocation = *allocation;
667 gtk_frame_compute_child_allocation (frame, &new_allocation);
669 /* If the child allocation changed, that means that the frame is drawn
670 * in a new place, so we must redraw the entire widget.
672 if (gtk_widget_get_mapped (widget)
675 (new_allocation.x != priv->child_allocation.x ||
676 new_allocation.y != priv->child_allocation.y ||
677 new_allocation.width != priv->child_allocation.width ||
678 new_allocation.height != priv->child_allocation.height)
681 gdk_window_invalidate_rect (widget->window, &widget->allocation, FALSE);
683 child = gtk_bin_get_child (bin);
684 if (child && gtk_widget_get_visible (child))
685 gtk_widget_size_allocate (child, &new_allocation);
687 priv->child_allocation = new_allocation;
689 if (priv->label_widget && gtk_widget_get_visible (priv->label_widget))
691 GtkRequisition child_requisition;
692 GtkAllocation child_allocation;
695 gtk_widget_get_child_requisition (priv->label_widget, &child_requisition);
697 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)
698 xalign = priv->label_xalign;
700 xalign = 1 - priv->label_xalign;
702 child_allocation.x = priv->child_allocation.x + LABEL_SIDE_PAD +
703 (priv->child_allocation.width - child_requisition.width - 2 * LABEL_PAD - 2 * LABEL_SIDE_PAD) * xalign + LABEL_PAD;
704 child_allocation.width = MIN (child_requisition.width, new_allocation.width - 2 * LABEL_PAD - 2 * LABEL_SIDE_PAD);
706 child_allocation.y = priv->child_allocation.y - MAX (child_requisition.height, widget->style->ythickness);
707 child_allocation.height = child_requisition.height;
709 gtk_widget_size_allocate (priv->label_widget, &child_allocation);
714 gtk_frame_compute_child_allocation (GtkFrame *frame,
715 GtkAllocation *child_allocation)
717 g_return_if_fail (GTK_IS_FRAME (frame));
718 g_return_if_fail (child_allocation != NULL);
720 GTK_FRAME_GET_CLASS (frame)->compute_child_allocation (frame, child_allocation);
724 gtk_frame_real_compute_child_allocation (GtkFrame *frame,
725 GtkAllocation *child_allocation)
727 GtkFramePriv *priv = frame->priv;
728 GtkWidget *widget = GTK_WIDGET (frame);
729 GtkAllocation *allocation = &widget->allocation;
730 GtkRequisition child_requisition;
734 if (priv->label_widget)
736 gtk_widget_get_child_requisition (priv->label_widget, &child_requisition);
737 top_margin = MAX (child_requisition.height, widget->style->ythickness);
740 top_margin = widget->style->ythickness;
742 border_width = gtk_container_get_border_width (GTK_CONTAINER (frame));
744 child_allocation->x = border_width + widget->style->xthickness;
745 child_allocation->width = MAX(1, (gint)allocation->width - child_allocation->x * 2);
747 child_allocation->y = border_width + top_margin;
748 child_allocation->height = MAX (1, ((gint)allocation->height - child_allocation->y -
750 (gint)widget->style->ythickness));
752 child_allocation->x += allocation->x;
753 child_allocation->y += allocation->y;
757 gtk_frame_get_size (GtkSizeRequest *request,
758 GtkOrientation orientation,
762 GtkWidget *widget = GTK_WIDGET (request);
764 GtkFrame *frame = GTK_FRAME (widget);
765 GtkFramePriv *priv = frame->priv;
766 GtkBin *bin = GTK_BIN (widget);
767 gint child_min, child_nat;
768 gint minimum, natural;
771 if (priv->label_widget && gtk_widget_get_visible (priv->label_widget))
773 if (orientation == GTK_ORIENTATION_HORIZONTAL)
775 gtk_size_request_get_width (GTK_SIZE_REQUEST (priv->label_widget),
776 &child_min, &child_nat);
777 minimum = child_min + 2 * LABEL_PAD + 2 * LABEL_SIDE_PAD;
778 natural = child_nat + 2 * LABEL_PAD + 2 * LABEL_SIDE_PAD;
782 gtk_size_request_get_height (GTK_SIZE_REQUEST (priv->label_widget),
783 &child_min, &child_nat);
784 minimum = MAX (0, child_min - widget->style->ythickness);
785 natural = MAX (0, child_nat - widget->style->ythickness);
794 child = gtk_bin_get_child (bin);
795 if (child && gtk_widget_get_visible (child))
797 if (orientation == GTK_ORIENTATION_HORIZONTAL)
799 gtk_size_request_get_width (GTK_SIZE_REQUEST (child),
800 &child_min, &child_nat);
801 minimum = MAX (minimum, child_min);
802 natural = MAX (natural, child_nat);
806 gtk_size_request_get_height (GTK_SIZE_REQUEST (child),
807 &child_min, &child_nat);
808 minimum += child_min;
809 natural += child_nat;
813 border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));
815 if (orientation == GTK_ORIENTATION_HORIZONTAL)
817 minimum += (border_width + GTK_WIDGET (widget)->style->xthickness) * 2;
818 natural += (border_width + GTK_WIDGET (widget)->style->xthickness) * 2;
822 minimum += (border_width + GTK_WIDGET (widget)->style->ythickness) * 2;
823 natural += (border_width + GTK_WIDGET (widget)->style->ythickness) * 2;
827 *minimum_size = minimum;
830 *natural_size = natural;
834 gtk_frame_get_width (GtkSizeRequest *widget,
838 gtk_frame_get_size (widget, GTK_ORIENTATION_HORIZONTAL, minimum_size, natural_size);
842 gtk_frame_get_height (GtkSizeRequest *widget,
846 gtk_frame_get_size (widget, GTK_ORIENTATION_VERTICAL, minimum_size, natural_size);
850 gtk_frame_size_request_init (GtkSizeRequestIface *iface)
852 iface->get_width = gtk_frame_get_width;
853 iface->get_height = gtk_frame_get_height;