]> Pileus Git - ~andy/gtk/blob - gtk/gtkframe.c
Add a function gdk_window_invalidate_maybe_recurse() for use in "shallow
[~andy/gtk] / gtk / gtkframe.c
1 /* GTK - The GIMP Toolkit
2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
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., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  */
19
20 /*
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/. 
25  */
26
27 #include <string.h>
28 #include "gtkframe.h"
29 #include "gtklabel.h"
30 #include "gtkintl.h"
31
32 #define LABEL_PAD 1
33 #define LABEL_SIDE_PAD 2
34
35 enum {
36   PROP_0,
37   PROP_LABEL,
38   PROP_LABEL_XALIGN,
39   PROP_LABEL_YALIGN,
40   PROP_SHADOW,
41   PROP_SHADOW_TYPE,
42   PROP_LABEL_WIDGET
43 };
44
45
46 static void gtk_frame_class_init    (GtkFrameClass  *klass);
47 static void gtk_frame_init          (GtkFrame       *frame);
48 static void gtk_frame_set_property (GObject      *object,
49                                     guint         param_id,
50                                     const GValue *value,
51                                     GParamSpec   *pspec);
52 static void gtk_frame_get_property (GObject     *object,
53                                     guint        param_id,
54                                     GValue      *value,
55                                     GParamSpec  *pspec);
56 static void gtk_frame_paint         (GtkWidget      *widget,
57                                      GdkRectangle   *area);
58 static gint gtk_frame_expose        (GtkWidget      *widget,
59                                      GdkEventExpose *event);
60 static void gtk_frame_size_request  (GtkWidget      *widget,
61                                      GtkRequisition *requisition);
62 static void gtk_frame_size_allocate (GtkWidget      *widget,
63                                      GtkAllocation  *allocation);
64 static void gtk_frame_remove        (GtkContainer   *container,
65                                      GtkWidget      *child);
66 static void gtk_frame_forall        (GtkContainer   *container,
67                                      gboolean        include_internals,
68                                      GtkCallback     callback,
69                                      gpointer        callback_data);
70
71 static void gtk_frame_compute_child_allocation      (GtkFrame      *frame,
72                                                      GtkAllocation *child_allocation);
73 static void gtk_frame_real_compute_child_allocation (GtkFrame      *frame,
74                                                      GtkAllocation *child_allocation);
75
76 static GtkBinClass *parent_class = NULL;
77
78
79 GtkType
80 gtk_frame_get_type (void)
81 {
82   static GtkType frame_type = 0;
83
84   if (!frame_type)
85     {
86       static const GtkTypeInfo frame_info =
87       {
88         "GtkFrame",
89         sizeof (GtkFrame),
90         sizeof (GtkFrameClass),
91         (GtkClassInitFunc) gtk_frame_class_init,
92         (GtkObjectInitFunc) gtk_frame_init,
93         /* reserved_1 */ NULL,
94         /* reserved_2 */ NULL,
95         (GtkClassInitFunc) NULL,
96       };
97
98       frame_type = gtk_type_unique (gtk_bin_get_type (), &frame_info);
99     }
100
101   return frame_type;
102 }
103
104 static void
105 gtk_frame_class_init (GtkFrameClass *class)
106 {
107   GObjectClass *gobject_class;
108   GtkObjectClass *object_class;
109   GtkWidgetClass *widget_class;
110   GtkContainerClass *container_class;
111
112   gobject_class = (GObjectClass*) class;
113   object_class = GTK_OBJECT_CLASS (class);
114   widget_class = GTK_WIDGET_CLASS (class);
115   container_class = GTK_CONTAINER_CLASS (class);
116
117   parent_class = gtk_type_class (gtk_bin_get_type ());
118
119   gobject_class->set_property = gtk_frame_set_property;
120   gobject_class->get_property = gtk_frame_get_property;
121
122   g_object_class_install_property (gobject_class,
123                                    PROP_LABEL,
124                                    g_param_spec_string ("label",
125                                                         _("Label"),
126                                                         _("Text of the frame's label."),
127                                                         NULL,
128                                                         G_PARAM_READABLE |
129                                                         G_PARAM_WRITABLE));
130   g_object_class_install_property (gobject_class,
131                                    PROP_LABEL_XALIGN,
132                                    g_param_spec_double ("label_xalign",
133                                                         _("Label xalign"),
134                                                         _("The horizontal alignment of the label."),
135                                                         0.0,
136                                                         1.0,
137                                                         0.5,
138                                                         G_PARAM_READABLE |
139                                                         G_PARAM_WRITABLE));
140   g_object_class_install_property (gobject_class,
141                                    PROP_LABEL_YALIGN,
142                                    g_param_spec_double ("label_yalign",
143                                                         _("Label yalign"),
144                                                         _("The vertical alignment of the label."),
145                                                         0.0,
146                                                         1.0,
147                                                         0.5,
148                                                         G_PARAM_READABLE |
149                                                         G_PARAM_WRITABLE));
150   g_object_class_install_property (gobject_class,
151                                    PROP_SHADOW,
152                                    g_param_spec_enum ("shadow", NULL,
153                                                       _("Deprecated property, use shadow_type instead."),
154                                                       GTK_TYPE_SHADOW_TYPE,
155                                                       GTK_SHADOW_ETCHED_IN,
156                                                       G_PARAM_READABLE | G_PARAM_WRITABLE));
157   g_object_class_install_property (gobject_class,
158                                    PROP_SHADOW_TYPE,
159                                    g_param_spec_enum ("shadow_type",
160                                                       _("Frame shadow"),
161                                                       _("Appearance of the frame border."),
162                                                       GTK_TYPE_SHADOW_TYPE,
163                                                       GTK_SHADOW_ETCHED_IN,
164                                                       G_PARAM_READABLE | G_PARAM_WRITABLE));
165
166   g_object_class_install_property (gobject_class,
167                                    PROP_LABEL_WIDGET,
168                                    g_param_spec_object ("label_widget",
169                                                         _("Label widget"),
170                                                         _("A widget to display in place of the usual frame label."),
171                                                         GTK_TYPE_WIDGET,
172                                                         G_PARAM_READABLE | G_PARAM_WRITABLE));
173   
174   widget_class->expose_event = gtk_frame_expose;
175   widget_class->size_request = gtk_frame_size_request;
176   widget_class->size_allocate = gtk_frame_size_allocate;
177
178   container_class->remove = gtk_frame_remove;
179   container_class->forall = gtk_frame_forall;
180
181   class->compute_child_allocation = gtk_frame_real_compute_child_allocation;
182 }
183
184 static void
185 gtk_frame_init (GtkFrame *frame)
186 {
187   frame->label_widget = NULL;
188   frame->shadow_type = GTK_SHADOW_ETCHED_IN;
189   frame->label_xalign = 0.0;
190   frame->label_yalign = 0.5;
191 }
192
193 static void 
194 gtk_frame_set_property (GObject         *object,
195                         guint            prop_id,
196                         const GValue    *value,
197                         GParamSpec      *pspec)
198 {
199   GtkFrame *frame;
200
201   frame = GTK_FRAME (object);
202
203   switch (prop_id)
204     {
205     case PROP_LABEL:
206       gtk_frame_set_label (frame, g_value_get_string (value));
207       break;
208     case PROP_LABEL_XALIGN:
209       gtk_frame_set_label_align (frame, g_value_get_double (value), 
210                                  frame->label_yalign);
211       break;
212     case PROP_LABEL_YALIGN:
213       gtk_frame_set_label_align (frame, frame->label_xalign, 
214                                  g_value_get_double (value));
215       break;
216     case PROP_SHADOW:
217     case PROP_SHADOW_TYPE:
218       gtk_frame_set_shadow_type (frame, g_value_get_enum (value));
219       break;
220     case PROP_LABEL_WIDGET:
221       gtk_frame_set_label_widget (frame, g_value_get_object (value));
222       break;
223     default:      
224       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
225       break;
226     }
227 }
228
229 static void 
230 gtk_frame_get_property (GObject         *object,
231                         guint            prop_id,
232                         GValue          *value,
233                         GParamSpec      *pspec)
234 {
235   GtkFrame *frame;
236
237   frame = GTK_FRAME (object);
238
239   switch (prop_id)
240     {
241     case PROP_LABEL:
242       g_value_set_string (value, gtk_frame_get_label (frame));
243       break;
244     case PROP_LABEL_XALIGN:
245       g_value_set_double (value, frame->label_xalign);
246       break;
247     case PROP_LABEL_YALIGN:
248       g_value_set_double (value, frame->label_yalign);
249       break;
250     case PROP_SHADOW:
251     case PROP_SHADOW_TYPE:
252       g_value_set_enum (value, frame->shadow_type);
253       break;
254     case PROP_LABEL_WIDGET:
255       g_value_set_object (value,
256                           frame->label_widget ?
257                           G_OBJECT (frame->label_widget) : NULL);
258       break;
259     default:
260       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
261       break;
262     }
263 }
264
265 GtkWidget*
266 gtk_frame_new (const gchar *label)
267 {
268   GtkFrame *frame;
269
270   frame = gtk_type_new (gtk_frame_get_type ());
271
272   gtk_frame_set_label (frame, label);
273
274   return GTK_WIDGET (frame);
275 }
276
277 static void
278 gtk_frame_remove (GtkContainer *container,
279                   GtkWidget    *child)
280 {
281   GtkFrame *frame = GTK_FRAME (container);
282
283   if (frame->label_widget == child)
284     gtk_frame_set_label_widget (frame, NULL);
285   else
286     GTK_CONTAINER_CLASS (parent_class)->remove (container, child);
287 }
288
289 static void
290 gtk_frame_forall (GtkContainer *container,
291                   gboolean      include_internals,
292                   GtkCallback   callback,
293                   gpointer      callback_data)
294 {
295   GtkBin *bin = GTK_BIN (container);
296   GtkFrame *frame = GTK_FRAME (container);
297
298   if (bin->child)
299     (* callback) (bin->child, callback_data);
300
301   if (frame->label_widget)
302     (* callback) (frame->label_widget, callback_data);
303 }
304
305 void
306 gtk_frame_set_label (GtkFrame *frame,
307                      const gchar *label)
308 {
309   g_return_if_fail (GTK_IS_FRAME (frame));
310
311   if (!label)
312     {
313       gtk_frame_set_label_widget (frame, NULL);
314     }
315   else
316     {
317       GtkWidget *child = gtk_label_new (label);
318       gtk_widget_show (child);
319
320       gtk_frame_set_label_widget (frame, child);
321     }
322
323   g_object_notify (G_OBJECT (frame), "label");
324 }
325
326 /**
327  * gtk_frame_get_label:
328  * @frame: a #GtkFrame
329  * 
330  * If the frame's label widget is a #GtkLabel, return the
331  * text in the label widget. (The frame will have a #GtkLabel
332  * for the label widget if a non-%NULL argument was passed
333  * to gtk_frame_new().)
334  * 
335  * Return value: the text in the label, or %NULL if there
336  *               was no label widget or the lable widget was not
337  *               a #GtkLabel. This value must be freed with g_free().
338  **/
339 G_CONST_RETURN gchar *
340 gtk_frame_get_label (GtkFrame *frame)
341 {
342   g_return_val_if_fail (GTK_IS_FRAME (frame), NULL);
343
344   if (frame->label_widget && GTK_IS_LABEL (frame->label_widget))
345     return gtk_label_get_text (GTK_LABEL (frame->label_widget));
346   else
347     return NULL;
348 }
349
350 /**
351  * gtk_frame_set_label_widget:
352  * @frame: a #GtkFrame
353  * @label_widget: the new label widget
354  * 
355  * Set the label widget for the frame. This is the widget that
356  * will appear embedded in the top edge of the frame as a
357  * title.
358  **/
359 void
360 gtk_frame_set_label_widget (GtkFrame  *frame,
361                             GtkWidget *label_widget)
362 {
363   gboolean need_resize = FALSE;
364   
365   g_return_if_fail (GTK_IS_FRAME (frame));
366   g_return_if_fail (label_widget == NULL || GTK_IS_WIDGET (label_widget));
367   g_return_if_fail (label_widget == NULL || label_widget->parent == NULL);
368   
369   if (frame->label_widget == label_widget)
370     return;
371   
372   if (frame->label_widget)
373     {
374       need_resize = GTK_WIDGET_VISIBLE (frame->label_widget);
375       gtk_widget_unparent (frame->label_widget);
376     }
377
378   frame->label_widget = label_widget;
379     
380   if (label_widget)
381     {
382       frame->label_widget = label_widget;
383       gtk_widget_set_parent (label_widget, GTK_WIDGET (frame));
384       need_resize |= GTK_WIDGET_VISIBLE (label_widget);
385     }
386   
387   if (GTK_WIDGET_VISIBLE (frame) && need_resize)
388     gtk_widget_queue_resize (GTK_WIDGET (frame));
389
390   g_object_notify (G_OBJECT (frame), "label_widget");
391 }
392
393 /**
394  * gtk_frame_get_label_widget:
395  * @frame: a #GtkFrame
396  *
397  * Retrieves the label widget for the frame. See
398  * gtk_frame_set_label_widget().
399  *
400  * Return value: the label widget, or %NULL if there is none.
401  **/
402 GtkWidget *
403 gtk_frame_get_label_widget (GtkFrame *frame)
404 {
405   g_return_val_if_fail (GTK_IS_FRAME (frame), NULL);
406
407   return frame->label_widget;
408 }
409
410 void
411 gtk_frame_set_label_align (GtkFrame *frame,
412                            gfloat    xalign,
413                            gfloat    yalign)
414 {
415   g_return_if_fail (GTK_IS_FRAME (frame));
416
417   xalign = CLAMP (xalign, 0.0, 1.0);
418   yalign = CLAMP (yalign, 0.0, 1.0);
419
420   if (xalign != frame->label_xalign)
421     {
422       frame->label_xalign = xalign;
423       g_object_notify (G_OBJECT (frame), "label_xalign");
424     }
425
426   if (yalign != frame->label_yalign)
427     {
428       frame->label_yalign = yalign;
429       g_object_notify (G_OBJECT (frame), "label_yalign");
430     }
431
432   gtk_widget_queue_resize (GTK_WIDGET (frame));
433 }
434
435 /**
436  * gtk_frame_get_label_align:
437  * @frame: a #GtkFrame
438  * @xalign: location to store X alignment of frame's label, or %NULL
439  * @yalign: location to store X alignment of frame's label, or %NULL
440  * 
441  * Retrieves the X and Y alignment of the frame's label. See
442  * gtk_frame_set_label_align().
443  **/
444 void
445 gtk_frame_get_label_align (GtkFrame *frame,
446                            gfloat   *xalign,
447                            gfloat   *yalign)
448 {
449   g_return_if_fail (GTK_IS_FRAME (frame));
450
451   if (xalign)
452     *xalign = frame->label_xalign;
453   if (yalign)
454     *yalign = frame->label_yalign;
455 }
456
457 void
458 gtk_frame_set_shadow_type (GtkFrame      *frame,
459                            GtkShadowType  type)
460 {
461   g_return_if_fail (GTK_IS_FRAME (frame));
462
463   if ((GtkShadowType) frame->shadow_type != type)
464     {
465       frame->shadow_type = type;
466       g_object_notify (G_OBJECT (frame), "shadow_type");
467
468       if (GTK_WIDGET_DRAWABLE (frame))
469         {
470           gtk_widget_queue_clear (GTK_WIDGET (frame));
471         }
472       
473       gtk_widget_queue_resize (GTK_WIDGET (frame));
474     }
475 }
476
477 /**
478  * gtk_frame_get_shadow_type:
479  * @frame: a #GtkFrame
480  *
481  * Retrieves the shadow type of the frame. See
482  * gtk_frame_set_shadow_type().
483  *
484  * Return value: the current shadow type of the frame.
485  **/
486 GtkShadowType
487 gtk_frame_get_shadow_type (GtkFrame *frame)
488 {
489   g_return_val_if_fail (GTK_IS_FRAME (frame), GTK_SHADOW_ETCHED_IN);
490
491   return frame->shadow_type;
492 }
493
494 static void
495 gtk_frame_paint (GtkWidget    *widget,
496                  GdkRectangle *area)
497 {
498   GtkFrame *frame;
499   gint x, y, width, height;
500
501   if (GTK_WIDGET_DRAWABLE (widget))
502     {
503       frame = GTK_FRAME (widget);
504
505       x = frame->child_allocation.x - widget->style->xthickness;
506       y = frame->child_allocation.y - widget->style->ythickness;
507       width = frame->child_allocation.width + 2 * widget->style->xthickness;
508       height =  frame->child_allocation.height + 2 * widget->style->ythickness;
509
510       if (frame->label_widget)
511         {
512           GtkRequisition child_requisition;
513           gfloat xalign;
514           gint height_extra;
515           gint x2;
516
517           gtk_widget_get_child_requisition (frame->label_widget, &child_requisition);
518
519           if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)
520             xalign = frame->label_xalign;
521           else
522             xalign = 1 - frame->label_xalign;
523
524           height_extra = MAX (0, child_requisition.height - widget->style->xthickness);
525           y -= height_extra * (1 - frame->label_yalign);
526           height += height_extra * (1 - frame->label_yalign);
527           
528           x2 = widget->style->xthickness + (frame->child_allocation.width - child_requisition.width - 2 * LABEL_PAD - 2 * LABEL_SIDE_PAD) * xalign + LABEL_SIDE_PAD;
529
530           
531           gtk_paint_shadow_gap (widget->style, widget->window,
532                                 GTK_STATE_NORMAL, frame->shadow_type,
533                                 area, widget, "frame",
534                                 x, y, width, height,
535                                 GTK_POS_TOP, 
536                                 x2, child_requisition.width + 2 * LABEL_PAD);
537         }
538        else
539          gtk_paint_shadow (widget->style, widget->window,
540                            GTK_STATE_NORMAL, frame->shadow_type,
541                            area, widget, "frame",
542                            x, y, width, height);
543     }
544 }
545
546 static gboolean
547 gtk_frame_expose (GtkWidget      *widget,
548                   GdkEventExpose *event)
549 {
550   if (GTK_WIDGET_DRAWABLE (widget))
551     {
552       gtk_frame_paint (widget, &event->area);
553
554       (* GTK_WIDGET_CLASS (parent_class)->expose_event) (widget, event);
555     }
556
557   return FALSE;
558 }
559
560 static void
561 gtk_frame_size_request (GtkWidget      *widget,
562                         GtkRequisition *requisition)
563 {
564   GtkFrame *frame = GTK_FRAME (widget);
565   GtkBin *bin = GTK_BIN (widget);
566   GtkRequisition child_requisition;
567   
568   if (frame->label_widget && GTK_WIDGET_VISIBLE (frame->label_widget))
569     {
570       gtk_widget_size_request (frame->label_widget, &child_requisition);
571
572       requisition->width = child_requisition.width + 2 * LABEL_PAD + 2 * LABEL_SIDE_PAD;
573       requisition->height =
574         MAX (0, child_requisition.height - GTK_WIDGET (widget)->style->xthickness);
575     }
576   else
577     {
578       requisition->width = 0;
579       requisition->height = 0;
580     }
581   
582   if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
583     {
584       gtk_widget_size_request (bin->child, &child_requisition);
585
586       requisition->width = MAX (requisition->width, child_requisition.width);
587       requisition->height += child_requisition.height;
588     }
589
590   requisition->width += (GTK_CONTAINER (widget)->border_width +
591                          GTK_WIDGET (widget)->style->xthickness) * 2;
592   requisition->height += (GTK_CONTAINER (widget)->border_width +
593                           GTK_WIDGET (widget)->style->ythickness) * 2;
594 }
595
596 static void
597 gtk_frame_size_allocate (GtkWidget     *widget,
598                          GtkAllocation *allocation)
599 {
600   GtkFrame *frame = GTK_FRAME (widget);
601   GtkBin *bin = GTK_BIN (widget);
602   GtkAllocation new_allocation;
603
604   widget->allocation = *allocation;
605
606   gtk_frame_compute_child_allocation (frame, &new_allocation);
607   
608   /* If the child allocation changed, that means that the frame is drawn
609    * in a new place, so we must redraw the entire widget.
610    */
611   if (GTK_WIDGET_MAPPED (widget) &&
612       (new_allocation.x != frame->child_allocation.x ||
613        new_allocation.y != frame->child_allocation.y ||
614        new_allocation.width != frame->child_allocation.width ||
615        new_allocation.height != frame->child_allocation.height))
616     gdk_window_invalidate_rect (widget->window, &widget->allocation, FALSE);
617   
618   if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
619     gtk_widget_size_allocate (bin->child, &new_allocation);
620   
621   frame->child_allocation = new_allocation;
622   
623   if (frame->label_widget && GTK_WIDGET_VISIBLE (frame->label_widget))
624     {
625       GtkRequisition child_requisition;
626       GtkAllocation child_allocation;
627       gfloat xalign;
628
629       gtk_widget_get_child_requisition (frame->label_widget, &child_requisition);
630
631       if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)
632         xalign = frame->label_xalign;
633       else
634         xalign = 1 - frame->label_xalign;
635       
636       child_allocation.x = frame->child_allocation.x + LABEL_SIDE_PAD +
637         (frame->child_allocation.width - child_requisition.width - 2 * LABEL_PAD - 2 * LABEL_SIDE_PAD) * xalign + LABEL_PAD;
638       child_allocation.width = child_requisition.width;
639
640       child_allocation.y = frame->child_allocation.y - child_requisition.height;
641       child_allocation.height = child_requisition.height;
642
643       gtk_widget_size_allocate (frame->label_widget, &child_allocation);
644     }
645 }
646
647 static void
648 gtk_frame_compute_child_allocation (GtkFrame      *frame,
649                                     GtkAllocation *child_allocation)
650 {
651   g_return_if_fail (GTK_IS_FRAME (frame));
652   g_return_if_fail (child_allocation != NULL);
653
654   GTK_FRAME_GET_CLASS (frame)->compute_child_allocation (frame, child_allocation);
655 }
656
657 static void
658 gtk_frame_real_compute_child_allocation (GtkFrame      *frame,
659                                          GtkAllocation *child_allocation)
660 {
661   GtkWidget *widget = GTK_WIDGET (frame);
662   GtkAllocation *allocation = &widget->allocation;
663   GtkRequisition child_requisition;
664   gint top_margin;
665
666   if (frame->label_widget)
667     {
668       gtk_widget_get_child_requisition (frame->label_widget, &child_requisition);
669       top_margin = MAX (child_requisition.height, widget->style->ythickness);
670     }
671   else
672     top_margin = widget->style->ythickness;
673   
674   child_allocation->x = (GTK_CONTAINER (frame)->border_width +
675                          widget->style->xthickness);
676   child_allocation->width = MAX(1, (gint)allocation->width - child_allocation->x * 2);
677   
678   child_allocation->y = (GTK_CONTAINER (frame)->border_width + top_margin);
679   child_allocation->height = MAX (1, ((gint)allocation->height - child_allocation->y -
680                                       (gint)GTK_CONTAINER (frame)->border_width -
681                                       (gint)widget->style->ythickness));
682   
683   child_allocation->x += allocation->x;
684   child_allocation->y += allocation->y;
685 }