1 /* GTK - The GIMP Toolkit
3 * Copyright (C) 2003 Sun Microsystems, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
21 * Mark McLoughlin <mark@skynet.ie>
26 #include "gtkexpander.h"
29 #include "gtkcontainer.h"
30 #include "gtkmarshalers.h"
33 #include "gtkprivate.h"
34 #include <gdk/gdkkeysyms.h>
38 #define GTK_EXPANDER_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_EXPANDER, GtkExpanderPrivate))
40 #define DEFAULT_EXPANDER_SIZE 10
41 #define DEFAULT_EXPANDER_SPACING 2
54 struct _GtkExpanderPrivate
56 GtkWidget *label_widget;
57 GdkWindow *event_window;
60 GtkExpanderStyle expander_style;
61 guint animation_timeout;
65 guint use_underline : 1;
67 guint button_down : 1;
71 static void gtk_expander_set_property (GObject *object,
75 static void gtk_expander_get_property (GObject *object,
80 static void gtk_expander_destroy (GtkObject *object);
82 static void gtk_expander_realize (GtkWidget *widget);
83 static void gtk_expander_unrealize (GtkWidget *widget);
84 static void gtk_expander_size_request (GtkWidget *widget,
85 GtkRequisition *requisition);
86 static void gtk_expander_size_allocate (GtkWidget *widget,
87 GtkAllocation *allocation);
88 static void gtk_expander_map (GtkWidget *widget);
89 static void gtk_expander_unmap (GtkWidget *widget);
90 static gboolean gtk_expander_expose (GtkWidget *widget,
91 GdkEventExpose *event);
92 static gboolean gtk_expander_button_press (GtkWidget *widget,
93 GdkEventButton *event);
94 static gboolean gtk_expander_button_release (GtkWidget *widget,
95 GdkEventButton *event);
96 static gboolean gtk_expander_enter_notify (GtkWidget *widget,
97 GdkEventCrossing *event);
98 static gboolean gtk_expander_leave_notify (GtkWidget *widget,
99 GdkEventCrossing *event);
100 static gboolean gtk_expander_focus (GtkWidget *widget,
101 GtkDirectionType direction);
102 static void gtk_expander_grab_notify (GtkWidget *widget,
103 gboolean was_grabbed);
104 static void gtk_expander_state_changed (GtkWidget *widget,
105 GtkStateType previous_state);
106 static gboolean gtk_expander_drag_motion (GtkWidget *widget,
107 GdkDragContext *context,
111 static void gtk_expander_drag_leave (GtkWidget *widget,
112 GdkDragContext *context,
115 static void gtk_expander_add (GtkContainer *container,
117 static void gtk_expander_remove (GtkContainer *container,
119 static void gtk_expander_forall (GtkContainer *container,
120 gboolean include_internals,
121 GtkCallback callback,
122 gpointer callback_data);
124 static void gtk_expander_activate (GtkExpander *expander);
126 static void get_expander_bounds (GtkExpander *expander,
129 G_DEFINE_TYPE (GtkExpander, gtk_expander, GTK_TYPE_BIN)
132 gtk_expander_class_init (GtkExpanderClass *klass)
134 GObjectClass *gobject_class;
135 GtkObjectClass *object_class;
136 GtkWidgetClass *widget_class;
137 GtkContainerClass *container_class;
139 gobject_class = (GObjectClass *) klass;
140 object_class = (GtkObjectClass *) klass;
141 widget_class = (GtkWidgetClass *) klass;
142 container_class = (GtkContainerClass *) klass;
144 gobject_class->set_property = gtk_expander_set_property;
145 gobject_class->get_property = gtk_expander_get_property;
147 object_class->destroy = gtk_expander_destroy;
149 widget_class->realize = gtk_expander_realize;
150 widget_class->unrealize = gtk_expander_unrealize;
151 widget_class->size_request = gtk_expander_size_request;
152 widget_class->size_allocate = gtk_expander_size_allocate;
153 widget_class->map = gtk_expander_map;
154 widget_class->unmap = gtk_expander_unmap;
155 widget_class->expose_event = gtk_expander_expose;
156 widget_class->button_press_event = gtk_expander_button_press;
157 widget_class->button_release_event = gtk_expander_button_release;
158 widget_class->enter_notify_event = gtk_expander_enter_notify;
159 widget_class->leave_notify_event = gtk_expander_leave_notify;
160 widget_class->focus = gtk_expander_focus;
161 widget_class->grab_notify = gtk_expander_grab_notify;
162 widget_class->state_changed = gtk_expander_state_changed;
163 widget_class->drag_motion = gtk_expander_drag_motion;
164 widget_class->drag_leave = gtk_expander_drag_leave;
166 container_class->add = gtk_expander_add;
167 container_class->remove = gtk_expander_remove;
168 container_class->forall = gtk_expander_forall;
170 klass->activate = gtk_expander_activate;
172 g_type_class_add_private (klass, sizeof (GtkExpanderPrivate));
174 g_object_class_install_property (gobject_class,
176 g_param_spec_boolean ("expanded",
178 P_("Whether the expander has been opened to reveal the child widget"),
180 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
182 g_object_class_install_property (gobject_class,
184 g_param_spec_string ("label",
186 P_("Text of the expander's label"),
188 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
190 g_object_class_install_property (gobject_class,
192 g_param_spec_boolean ("use-underline",
194 P_("If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key"),
196 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
198 g_object_class_install_property (gobject_class,
200 g_param_spec_boolean ("use-markup",
202 P_("The text of the label includes XML markup. See pango_parse_markup()"),
204 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
206 g_object_class_install_property (gobject_class,
208 g_param_spec_int ("spacing",
210 P_("Space to put between the label and the child"),
214 GTK_PARAM_READWRITE));
216 g_object_class_install_property (gobject_class,
218 g_param_spec_object ("label-widget",
220 P_("A widget to display in place of the usual expander label"),
222 GTK_PARAM_READWRITE));
224 gtk_widget_class_install_style_property (widget_class,
225 g_param_spec_int ("expander-size",
227 P_("Size of the expander arrow"),
230 DEFAULT_EXPANDER_SIZE,
231 GTK_PARAM_READABLE));
233 gtk_widget_class_install_style_property (widget_class,
234 g_param_spec_int ("expander-spacing",
235 P_("Indicator Spacing"),
236 P_("Spacing around expander arrow"),
239 DEFAULT_EXPANDER_SPACING,
240 GTK_PARAM_READABLE));
242 widget_class->activate_signal =
243 g_signal_new (I_("activate"),
244 G_TYPE_FROM_CLASS (gobject_class),
245 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
246 G_STRUCT_OFFSET (GtkExpanderClass, activate),
248 _gtk_marshal_VOID__VOID,
253 gtk_expander_init (GtkExpander *expander)
255 GtkExpanderPrivate *priv;
257 expander->priv = priv = GTK_EXPANDER_GET_PRIVATE (expander);
259 GTK_WIDGET_SET_FLAGS (expander, GTK_CAN_FOCUS);
260 GTK_WIDGET_SET_FLAGS (expander, GTK_NO_WINDOW);
262 priv->label_widget = NULL;
263 priv->event_window = NULL;
266 priv->expander_style = GTK_EXPANDER_COLLAPSED;
267 priv->animation_timeout = 0;
269 priv->expanded = FALSE;
270 priv->use_underline = FALSE;
271 priv->use_markup = FALSE;
272 priv->button_down = FALSE;
273 priv->prelight = FALSE;
274 priv->expand_timer = 0;
276 gtk_drag_dest_set (GTK_WIDGET (expander), 0, NULL, 0, 0);
277 gtk_drag_dest_set_track_motion (GTK_WIDGET (expander), TRUE);
281 gtk_expander_set_property (GObject *object,
286 GtkExpander *expander = GTK_EXPANDER (object);
291 gtk_expander_set_expanded (expander, g_value_get_boolean (value));
294 gtk_expander_set_label (expander, g_value_get_string (value));
296 case PROP_USE_UNDERLINE:
297 gtk_expander_set_use_underline (expander, g_value_get_boolean (value));
299 case PROP_USE_MARKUP:
300 gtk_expander_set_use_markup (expander, g_value_get_boolean (value));
303 gtk_expander_set_spacing (expander, g_value_get_int (value));
305 case PROP_LABEL_WIDGET:
306 gtk_expander_set_label_widget (expander, g_value_get_object (value));
309 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
315 gtk_expander_get_property (GObject *object,
320 GtkExpander *expander = GTK_EXPANDER (object);
321 GtkExpanderPrivate *priv = expander->priv;
326 g_value_set_boolean (value, priv->expanded);
329 g_value_set_string (value, gtk_expander_get_label (expander));
331 case PROP_USE_UNDERLINE:
332 g_value_set_boolean (value, priv->use_underline);
334 case PROP_USE_MARKUP:
335 g_value_set_boolean (value, priv->use_markup);
338 g_value_set_int (value, priv->spacing);
340 case PROP_LABEL_WIDGET:
341 g_value_set_object (value,
343 G_OBJECT (priv->label_widget) : NULL);
346 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
352 gtk_expander_destroy (GtkObject *object)
354 GtkExpanderPrivate *priv = GTK_EXPANDER (object)->priv;
356 if (priv->animation_timeout)
358 g_source_remove (priv->animation_timeout);
359 priv->animation_timeout = 0;
362 GTK_OBJECT_CLASS (gtk_expander_parent_class)->destroy (object);
366 gtk_expander_realize (GtkWidget *widget)
368 GtkExpanderPrivate *priv;
369 GdkWindowAttr attributes;
370 gint attributes_mask;
372 GdkRectangle expander_rect;
375 priv = GTK_EXPANDER (widget)->priv;
376 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
378 border_width = GTK_CONTAINER (widget)->border_width;
380 get_expander_bounds (GTK_EXPANDER (widget), &expander_rect);
382 if (priv->label_widget && GTK_WIDGET_VISIBLE (priv->label_widget))
384 GtkRequisition label_requisition;
386 gtk_widget_get_child_requisition (priv->label_widget, &label_requisition);
387 label_height = label_requisition.height;
392 attributes.window_type = GDK_WINDOW_CHILD;
393 attributes.x = widget->allocation.x + border_width;
394 attributes.y = widget->allocation.y + border_width;
395 attributes.width = MAX (widget->allocation.width - 2 * border_width, 1);
396 attributes.height = MAX (expander_rect.height, label_height - 2 * border_width);
397 attributes.wclass = GDK_INPUT_ONLY;
398 attributes.event_mask = gtk_widget_get_events (widget) |
399 GDK_BUTTON_PRESS_MASK |
400 GDK_BUTTON_RELEASE_MASK |
401 GDK_ENTER_NOTIFY_MASK |
402 GDK_LEAVE_NOTIFY_MASK;
404 attributes_mask = GDK_WA_X | GDK_WA_Y;
406 widget->window = gtk_widget_get_parent_window (widget);
407 g_object_ref (widget->window);
409 priv->event_window = gdk_window_new (gtk_widget_get_parent_window (widget),
410 &attributes, attributes_mask);
411 gdk_window_set_user_data (priv->event_window, widget);
413 widget->style = gtk_style_attach (widget->style, widget->window);
414 gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
418 gtk_expander_unrealize (GtkWidget *widget)
420 GtkExpanderPrivate *priv = GTK_EXPANDER (widget)->priv;
422 if (priv->event_window)
424 gdk_window_set_user_data (priv->event_window, NULL);
425 gdk_window_destroy (priv->event_window);
426 priv->event_window = NULL;
429 GTK_WIDGET_CLASS (gtk_expander_parent_class)->unrealize (widget);
433 gtk_expander_size_request (GtkWidget *widget,
434 GtkRequisition *requisition)
436 GtkExpander *expander;
438 GtkExpanderPrivate *priv;
441 gint expander_spacing;
442 gboolean interior_focus;
446 bin = GTK_BIN (widget);
447 expander = GTK_EXPANDER (widget);
448 priv = expander->priv;
450 border_width = GTK_CONTAINER (widget)->border_width;
452 gtk_widget_style_get (widget,
453 "interior-focus", &interior_focus,
454 "focus-line-width", &focus_width,
455 "focus-padding", &focus_pad,
456 "expander-size", &expander_size,
457 "expander-spacing", &expander_spacing,
460 requisition->width = expander_size + 2 * expander_spacing +
461 2 * focus_width + 2 * focus_pad;
462 requisition->height = interior_focus ? (2 * focus_width + 2 * focus_pad) : 0;
464 if (priv->label_widget && GTK_WIDGET_VISIBLE (priv->label_widget))
466 GtkRequisition label_requisition;
468 gtk_widget_size_request (priv->label_widget, &label_requisition);
470 requisition->width += label_requisition.width;
471 requisition->height += label_requisition.height;
474 requisition->height = MAX (expander_size + 2 * expander_spacing, requisition->height);
477 requisition->height += 2 * focus_width + 2 * focus_pad;
479 if (bin->child && GTK_WIDGET_CHILD_VISIBLE (bin->child))
481 GtkRequisition child_requisition;
483 gtk_widget_size_request (bin->child, &child_requisition);
485 requisition->width = MAX (requisition->width, child_requisition.width);
486 requisition->height += child_requisition.height + priv->spacing;
489 requisition->width += 2 * border_width;
490 requisition->height += 2 * border_width;
494 get_expander_bounds (GtkExpander *expander,
498 GtkExpanderPrivate *priv;
501 gint expander_spacing;
502 gboolean interior_focus;
507 widget = GTK_WIDGET (expander);
508 priv = expander->priv;
510 border_width = GTK_CONTAINER (expander)->border_width;
512 gtk_widget_style_get (widget,
513 "interior-focus", &interior_focus,
514 "focus-line-width", &focus_width,
515 "focus-padding", &focus_pad,
516 "expander-size", &expander_size,
517 "expander-spacing", &expander_spacing,
520 ltr = gtk_widget_get_direction (widget) != GTK_TEXT_DIR_RTL;
522 rect->x = widget->allocation.x + border_width;
523 rect->y = widget->allocation.y + border_width;
526 rect->x += expander_spacing;
528 rect->x += widget->allocation.width - 2 * border_width -
529 expander_spacing - expander_size;
531 if (priv->label_widget && GTK_WIDGET_VISIBLE (priv->label_widget))
533 GtkAllocation label_allocation;
535 label_allocation = priv->label_widget->allocation;
537 if (expander_size < label_allocation.height)
538 rect->y += focus_width + focus_pad + (label_allocation.height - expander_size) / 2;
540 rect->y += expander_spacing;
544 rect->y += expander_spacing;
550 rect->x += focus_width + focus_pad;
552 rect->x -= focus_width + focus_pad;
553 rect->y += focus_width + focus_pad;
556 rect->width = rect->height = expander_size;
560 gtk_expander_size_allocate (GtkWidget *widget,
561 GtkAllocation *allocation)
563 GtkExpander *expander;
565 GtkExpanderPrivate *priv;
566 GtkRequisition child_requisition;
567 gboolean child_visible = FALSE;
570 gint expander_spacing;
571 gboolean interior_focus;
576 expander = GTK_EXPANDER (widget);
577 bin = GTK_BIN (widget);
578 priv = expander->priv;
580 border_width = GTK_CONTAINER (widget)->border_width;
582 gtk_widget_style_get (widget,
583 "interior-focus", &interior_focus,
584 "focus-line-width", &focus_width,
585 "focus-padding", &focus_pad,
586 "expander-size", &expander_size,
587 "expander-spacing", &expander_spacing,
590 child_requisition.width = 0;
591 child_requisition.height = 0;
592 if (bin->child && GTK_WIDGET_CHILD_VISIBLE (bin->child))
594 child_visible = TRUE;
595 gtk_widget_get_child_requisition (bin->child, &child_requisition);
598 widget->allocation = *allocation;
600 if (priv->label_widget && GTK_WIDGET_VISIBLE (priv->label_widget))
602 GtkAllocation label_allocation;
603 GtkRequisition label_requisition;
606 gtk_widget_get_child_requisition (priv->label_widget, &label_requisition);
608 ltr = gtk_widget_get_direction (widget) != GTK_TEXT_DIR_RTL;
611 label_allocation.x = (widget->allocation.x +
612 border_width + focus_width + focus_pad +
613 expander_size + 2 * expander_spacing);
615 label_allocation.x = (widget->allocation.x + widget->allocation.width -
616 (label_requisition.width +
617 border_width + focus_width + focus_pad +
618 expander_size + 2 * expander_spacing));
620 label_allocation.y = widget->allocation.y + border_width + focus_width + focus_pad;
622 label_allocation.width = MIN (label_requisition.width,
623 allocation->width - 2 * border_width -
624 expander_size - 2 * expander_spacing -
625 2 * focus_width - 2 * focus_pad);
626 label_allocation.width = MAX (label_allocation.width, 1);
628 label_allocation.height = MIN (label_requisition.height,
629 allocation->height - 2 * border_width -
630 2 * focus_width - 2 * focus_pad -
631 (child_visible ? priv->spacing : 0));
632 label_allocation.height = MAX (label_allocation.height, 1);
634 gtk_widget_size_allocate (priv->label_widget, &label_allocation);
636 label_height = label_allocation.height;
643 if (GTK_WIDGET_REALIZED (widget))
647 get_expander_bounds (expander, &rect);
649 gdk_window_move_resize (priv->event_window,
650 allocation->x + border_width,
651 allocation->y + border_width,
652 MAX (allocation->width - 2 * border_width, 1),
653 MAX (rect.height, label_height - 2 * border_width));
658 GtkAllocation child_allocation;
661 top_height = MAX (2 * expander_spacing + expander_size,
663 (interior_focus ? 2 * focus_width + 2 * focus_pad : 0));
665 child_allocation.x = widget->allocation.x + border_width;
666 child_allocation.y = widget->allocation.y + border_width + top_height + priv->spacing;
669 child_allocation.y += 2 * focus_width + 2 * focus_pad;
671 child_allocation.width = MAX (allocation->width - 2 * border_width, 1);
673 child_allocation.height = allocation->height - top_height -
674 2 * border_width - priv->spacing -
675 (!interior_focus ? 2 * focus_width + 2 * focus_pad : 0);
676 child_allocation.height = MAX (child_allocation.height, 1);
678 gtk_widget_size_allocate (bin->child, &child_allocation);
683 gtk_expander_map (GtkWidget *widget)
685 GtkExpanderPrivate *priv = GTK_EXPANDER (widget)->priv;
687 if (priv->label_widget)
688 gtk_widget_map (priv->label_widget);
690 GTK_WIDGET_CLASS (gtk_expander_parent_class)->map (widget);
692 if (priv->event_window)
693 gdk_window_show (priv->event_window);
697 gtk_expander_unmap (GtkWidget *widget)
699 GtkExpanderPrivate *priv = GTK_EXPANDER (widget)->priv;
701 if (priv->event_window)
702 gdk_window_hide (priv->event_window);
704 GTK_WIDGET_CLASS (gtk_expander_parent_class)->unmap (widget);
706 if (priv->label_widget)
707 gtk_widget_unmap (priv->label_widget);
711 gtk_expander_paint_prelight (GtkExpander *expander)
714 GtkContainer *container;
715 GtkExpanderPrivate *priv;
717 gboolean interior_focus;
721 int expander_spacing;
723 priv = expander->priv;
724 widget = GTK_WIDGET (expander);
725 container = GTK_CONTAINER (expander);
727 gtk_widget_style_get (widget,
728 "interior-focus", &interior_focus,
729 "focus-line-width", &focus_width,
730 "focus-padding", &focus_pad,
731 "expander-size", &expander_size,
732 "expander-spacing", &expander_spacing,
735 area.x = widget->allocation.x + container->border_width;
736 area.y = widget->allocation.y + container->border_width;
737 area.width = widget->allocation.width - (2 * container->border_width);
739 if (priv->label_widget && GTK_WIDGET_VISIBLE (priv->label_widget))
740 area.height = priv->label_widget->allocation.height;
744 area.height += interior_focus ? (focus_width + focus_pad) * 2 : 0;
745 area.height = MAX (area.height, expander_size + 2 * expander_spacing);
746 area.height += !interior_focus ? (focus_width + focus_pad) * 2 : 0;
748 gtk_paint_flat_box (widget->style, widget->window,
750 GTK_SHADOW_ETCHED_OUT,
751 &area, widget, "expander",
753 area.width, area.height);
757 gtk_expander_paint (GtkExpander *expander)
763 widget = GTK_WIDGET (expander);
765 get_expander_bounds (expander, &clip);
767 state = widget->state;
768 if (expander->priv->prelight)
770 state = GTK_STATE_PRELIGHT;
772 gtk_expander_paint_prelight (expander);
775 gtk_paint_expander (widget->style,
781 clip.x + clip.width / 2,
782 clip.y + clip.height / 2,
783 expander->priv->expander_style);
787 gtk_expander_paint_focus (GtkExpander *expander,
791 GtkExpanderPrivate *priv;
792 gint x, y, width, height;
793 gboolean interior_focus;
798 gint expander_spacing;
801 widget = GTK_WIDGET (expander);
802 priv = expander->priv;
804 border_width = GTK_CONTAINER (widget)->border_width;
806 gtk_widget_style_get (widget,
807 "interior-focus", &interior_focus,
808 "focus-line-width", &focus_width,
809 "focus-padding", &focus_pad,
810 "expander-size", &expander_size,
811 "expander-spacing", &expander_spacing,
814 ltr = gtk_widget_get_direction (widget) != GTK_TEXT_DIR_RTL;
818 if (priv->label_widget && GTK_WIDGET_VISIBLE (priv->label_widget))
820 GtkAllocation label_allocation = priv->label_widget->allocation;
822 width = label_allocation.width;
823 height = label_allocation.height;
826 width += 2 * focus_pad + 2 * focus_width;
827 height += 2 * focus_pad + 2 * focus_width;
829 x = widget->allocation.x + border_width;
830 y = widget->allocation.y + border_width;
835 x += expander_spacing * 2 + expander_size;
839 x += widget->allocation.width - 2 * border_width
840 - expander_spacing * 2 - expander_size - width;
845 width += expander_size + 2 * expander_spacing;
846 height = MAX (height, expander_size + 2 * expander_spacing);
849 gtk_paint_focus (widget->style, widget->window, GTK_WIDGET_STATE (widget),
850 area, widget, "expander",
851 x, y, width, height);
855 gtk_expander_expose (GtkWidget *widget,
856 GdkEventExpose *event)
858 if (GTK_WIDGET_DRAWABLE (widget))
860 GtkExpander *expander = GTK_EXPANDER (widget);
862 gtk_expander_paint (expander);
864 if (GTK_WIDGET_HAS_FOCUS (expander))
865 gtk_expander_paint_focus (expander, &event->area);
867 GTK_WIDGET_CLASS (gtk_expander_parent_class)->expose_event (widget, event);
874 gtk_expander_button_press (GtkWidget *widget,
875 GdkEventButton *event)
877 GtkExpander *expander = GTK_EXPANDER (widget);
879 if (event->button == 1 && event->window == expander->priv->event_window)
881 expander->priv->button_down = TRUE;
889 gtk_expander_button_release (GtkWidget *widget,
890 GdkEventButton *event)
892 GtkExpander *expander = GTK_EXPANDER (widget);
894 if (event->button == 1 && expander->priv->button_down)
896 gtk_widget_activate (widget);
897 expander->priv->button_down = FALSE;
905 gtk_expander_grab_notify (GtkWidget *widget,
906 gboolean was_grabbed)
909 GTK_EXPANDER (widget)->priv->button_down = FALSE;
913 gtk_expander_state_changed (GtkWidget *widget,
914 GtkStateType previous_state)
916 if (!GTK_WIDGET_IS_SENSITIVE (widget))
917 GTK_EXPANDER (widget)->priv->button_down = FALSE;
921 gtk_expander_redraw_expander (GtkExpander *expander)
925 widget = GTK_WIDGET (expander);
927 if (GTK_WIDGET_REALIZED (widget))
928 gdk_window_invalidate_rect (widget->window, &widget->allocation, FALSE);
932 gtk_expander_enter_notify (GtkWidget *widget,
933 GdkEventCrossing *event)
935 GtkExpander *expander = GTK_EXPANDER (widget);
936 GtkWidget *event_widget;
938 event_widget = gtk_get_event_widget ((GdkEvent *) event);
940 if (event_widget == widget &&
941 event->detail != GDK_NOTIFY_INFERIOR)
943 expander->priv->prelight = TRUE;
945 if (expander->priv->label_widget)
946 gtk_widget_set_state (expander->priv->label_widget, GTK_STATE_PRELIGHT);
948 gtk_expander_redraw_expander (expander);
955 gtk_expander_leave_notify (GtkWidget *widget,
956 GdkEventCrossing *event)
958 GtkExpander *expander = GTK_EXPANDER (widget);
959 GtkWidget *event_widget;
961 event_widget = gtk_get_event_widget ((GdkEvent *) event);
963 if (event_widget == widget &&
964 event->detail != GDK_NOTIFY_INFERIOR)
966 expander->priv->prelight = FALSE;
968 if (expander->priv->label_widget)
969 gtk_widget_set_state (expander->priv->label_widget, GTK_STATE_NORMAL);
971 gtk_expander_redraw_expander (expander);
978 expand_timeout (gpointer data)
980 GtkExpander *expander = GTK_EXPANDER (data);
981 GtkExpanderPrivate *priv = expander->priv;
983 priv->expand_timer = 0;
984 gtk_expander_set_expanded (expander, TRUE);
990 gtk_expander_drag_motion (GtkWidget *widget,
991 GdkDragContext *context,
996 GtkExpander *expander = GTK_EXPANDER (widget);
997 GtkExpanderPrivate *priv = expander->priv;
999 if (!priv->expanded && !priv->expand_timer)
1001 GtkSettings *settings;
1004 settings = gtk_widget_get_settings (widget);
1005 g_object_get (settings, "gtk-timeout-expand", &timeout, NULL);
1007 priv->expand_timer = gdk_threads_add_timeout (timeout, (GSourceFunc) expand_timeout, expander);
1014 gtk_expander_drag_leave (GtkWidget *widget,
1015 GdkDragContext *context,
1018 GtkExpander *expander = GTK_EXPANDER (widget);
1019 GtkExpanderPrivate *priv = expander->priv;
1021 if (priv->expand_timer)
1023 g_source_remove (priv->expand_timer);
1024 priv->expand_timer = 0;
1037 focus_current_site (GtkExpander *expander,
1038 GtkDirectionType direction)
1040 GtkWidget *current_focus;
1042 current_focus = GTK_CONTAINER (expander)->focus_child;
1047 return gtk_widget_child_focus (current_focus, direction);
1051 focus_in_site (GtkExpander *expander,
1053 GtkDirectionType direction)
1058 gtk_widget_grab_focus (GTK_WIDGET (expander));
1061 if (expander->priv->label_widget)
1062 return gtk_widget_child_focus (expander->priv->label_widget, direction);
1067 GtkWidget *child = gtk_bin_get_child (GTK_BIN (expander));
1069 if (child && GTK_WIDGET_CHILD_VISIBLE (child))
1070 return gtk_widget_child_focus (child, direction);
1078 g_assert_not_reached ();
1083 get_next_site (GtkExpander *expander,
1085 GtkDirectionType direction)
1089 ltr = gtk_widget_get_direction (GTK_WIDGET (expander)) != GTK_TEXT_DIR_RTL;
1096 case GTK_DIR_TAB_BACKWARD:
1100 case GTK_DIR_TAB_FORWARD:
1103 return FOCUS_WIDGET;
1108 case GTK_DIR_TAB_BACKWARD:
1112 return ltr ? FOCUS_NONE : FOCUS_LABEL;
1113 case GTK_DIR_TAB_FORWARD:
1117 return ltr ? FOCUS_LABEL : FOCUS_NONE;
1123 case GTK_DIR_TAB_BACKWARD:
1125 return FOCUS_WIDGET;
1127 return ltr ? FOCUS_WIDGET : FOCUS_CHILD;
1128 case GTK_DIR_TAB_FORWARD:
1132 return ltr ? FOCUS_CHILD : FOCUS_WIDGET;
1138 case GTK_DIR_TAB_BACKWARD:
1142 case GTK_DIR_TAB_FORWARD:
1149 g_assert_not_reached ();
1154 gtk_expander_focus (GtkWidget *widget,
1155 GtkDirectionType direction)
1157 GtkExpander *expander = GTK_EXPANDER (widget);
1159 if (!focus_current_site (expander, direction))
1161 GtkWidget *old_focus_child;
1162 gboolean widget_is_focus;
1163 FocusSite site = FOCUS_NONE;
1165 widget_is_focus = gtk_widget_is_focus (widget);
1166 old_focus_child = GTK_CONTAINER (widget)->focus_child;
1168 if (old_focus_child && old_focus_child == expander->priv->label_widget)
1170 else if (old_focus_child)
1172 else if (widget_is_focus)
1173 site = FOCUS_WIDGET;
1175 while ((site = get_next_site (expander, site, direction)) != FOCUS_NONE)
1177 if (focus_in_site (expander, site, direction))
1188 gtk_expander_add (GtkContainer *container,
1191 GTK_CONTAINER_CLASS (gtk_expander_parent_class)->add (container, widget);
1193 gtk_widget_set_child_visible (widget, GTK_EXPANDER (container)->priv->expanded);
1194 gtk_widget_queue_resize (GTK_WIDGET (container));
1198 gtk_expander_remove (GtkContainer *container,
1201 GtkExpander *expander = GTK_EXPANDER (container);
1203 if (GTK_EXPANDER (expander)->priv->label_widget == widget)
1204 gtk_expander_set_label_widget (expander, NULL);
1206 GTK_CONTAINER_CLASS (gtk_expander_parent_class)->remove (container, widget);
1210 gtk_expander_forall (GtkContainer *container,
1211 gboolean include_internals,
1212 GtkCallback callback,
1213 gpointer callback_data)
1215 GtkBin *bin = GTK_BIN (container);
1216 GtkExpanderPrivate *priv = GTK_EXPANDER (container)->priv;
1219 (* callback) (bin->child, callback_data);
1221 if (priv->label_widget)
1222 (* callback) (priv->label_widget, callback_data);
1226 gtk_expander_activate (GtkExpander *expander)
1228 gtk_expander_set_expanded (expander, !expander->priv->expanded);
1233 * @label: the text of the label
1235 * Creates a new expander using @label as the text of the label.
1237 * Return value: a new #GtkExpander widget.
1242 gtk_expander_new (const gchar *label)
1244 return g_object_new (GTK_TYPE_EXPANDER, "label", label, NULL);
1248 * gtk_expander_new_with_mnemonic:
1249 * @label: the text of the label with an underscore in front of the
1250 * mnemonic character
1252 * Creates a new expander using @label as the text of the label.
1253 * If characters in @label are preceded by an underscore, they are underlined.
1254 * If you need a literal underscore character in a label, use '__' (two
1255 * underscores). The first underlined character represents a keyboard
1256 * accelerator called a mnemonic.
1257 * Pressing Alt and that key activates the button.
1259 * Return value: a new #GtkExpander widget.
1264 gtk_expander_new_with_mnemonic (const gchar *label)
1266 return g_object_new (GTK_TYPE_EXPANDER,
1268 "use-underline", TRUE,
1273 gtk_expander_animation_timeout (GtkExpander *expander)
1275 GtkExpanderPrivate *priv = expander->priv;
1277 gboolean finish = FALSE;
1279 if (GTK_WIDGET_REALIZED (expander))
1281 get_expander_bounds (expander, &area);
1282 gdk_window_invalidate_rect (GTK_WIDGET (expander)->window, &area, TRUE);
1287 if (priv->expander_style == GTK_EXPANDER_COLLAPSED)
1289 priv->expander_style = GTK_EXPANDER_SEMI_EXPANDED;
1293 priv->expander_style = GTK_EXPANDER_EXPANDED;
1299 if (priv->expander_style == GTK_EXPANDER_EXPANDED)
1301 priv->expander_style = GTK_EXPANDER_SEMI_COLLAPSED;
1305 priv->expander_style = GTK_EXPANDER_COLLAPSED;
1312 priv->animation_timeout = 0;
1313 if (GTK_BIN (expander)->child)
1314 gtk_widget_set_child_visible (GTK_BIN (expander)->child, priv->expanded);
1315 gtk_widget_queue_resize (GTK_WIDGET (expander));
1322 gtk_expander_start_animation (GtkExpander *expander)
1324 GtkExpanderPrivate *priv = expander->priv;
1326 if (priv->animation_timeout)
1327 g_source_remove (priv->animation_timeout);
1329 priv->animation_timeout =
1330 gdk_threads_add_timeout (50,
1331 (GSourceFunc) gtk_expander_animation_timeout,
1336 * gtk_expander_set_expanded:
1337 * @expander: a #GtkExpander
1338 * @expanded: whether the child widget is revealed
1340 * Sets the state of the expander. Set to %TRUE, if you want
1341 * the child widget to be revealed, and %FALSE if you want the
1342 * child widget to be hidden.
1347 gtk_expander_set_expanded (GtkExpander *expander,
1350 GtkExpanderPrivate *priv;
1352 g_return_if_fail (GTK_IS_EXPANDER (expander));
1354 priv = expander->priv;
1356 expanded = expanded != FALSE;
1358 if (priv->expanded != expanded)
1360 GtkSettings *settings = gtk_widget_get_settings (GTK_WIDGET (expander));
1361 gboolean enable_animations;
1363 priv->expanded = expanded;
1365 g_object_get (settings, "gtk-enable-animations", &enable_animations, NULL);
1367 if (enable_animations && GTK_WIDGET_REALIZED (expander))
1369 gtk_expander_start_animation (expander);
1373 priv->expander_style = expanded ? GTK_EXPANDER_EXPANDED :
1374 GTK_EXPANDER_COLLAPSED;
1376 if (GTK_BIN (expander)->child)
1378 gtk_widget_set_child_visible (GTK_BIN (expander)->child, priv->expanded);
1379 gtk_widget_queue_resize (GTK_WIDGET (expander));
1383 g_object_notify (G_OBJECT (expander), "expanded");
1388 * gtk_expander_get_expanded:
1389 * @expander:a #GtkExpander
1391 * Queries a #GtkExpander and returns its current state. Returns %TRUE
1392 * if the child widget is revealed.
1394 * See gtk_expander_set_expanded().
1396 * Return value: the current state of the expander.
1401 gtk_expander_get_expanded (GtkExpander *expander)
1403 g_return_val_if_fail (GTK_IS_EXPANDER (expander), FALSE);
1405 return expander->priv->expanded;
1409 * gtk_expander_set_spacing:
1410 * @expander: a #GtkExpander
1411 * @spacing: distance between the expander and child in pixels.
1413 * Sets the spacing field of @expander, which is the number of pixels to
1414 * place between expander and the child.
1419 gtk_expander_set_spacing (GtkExpander *expander,
1422 g_return_if_fail (GTK_IS_EXPANDER (expander));
1423 g_return_if_fail (spacing >= 0);
1425 if (expander->priv->spacing != spacing)
1427 expander->priv->spacing = spacing;
1429 gtk_widget_queue_resize (GTK_WIDGET (expander));
1431 g_object_notify (G_OBJECT (expander), "spacing");
1436 * gtk_expander_get_spacing:
1437 * @expander: a #GtkExpander
1439 * Gets the value set by gtk_expander_set_spacing().
1441 * Return value: spacing between the expander and child.
1446 gtk_expander_get_spacing (GtkExpander *expander)
1448 g_return_val_if_fail (GTK_IS_EXPANDER (expander), 0);
1450 return expander->priv->spacing;
1454 * gtk_expander_set_label:
1455 * @expander: a #GtkExpander
1458 * Sets the text of the label of the expander to @label.
1460 * This will also clear any previously set labels.
1465 gtk_expander_set_label (GtkExpander *expander,
1468 g_return_if_fail (GTK_IS_EXPANDER (expander));
1472 gtk_expander_set_label_widget (expander, NULL);
1478 child = gtk_label_new (label);
1479 gtk_label_set_use_underline (GTK_LABEL (child), expander->priv->use_underline);
1480 gtk_label_set_use_markup (GTK_LABEL (child), expander->priv->use_markup);
1481 gtk_widget_show (child);
1483 gtk_expander_set_label_widget (expander, child);
1486 g_object_notify (G_OBJECT (expander), "label");
1490 * gtk_expander_get_label:
1491 * @expander: a #GtkExpander
1493 * Fetches the text from the label of the expander, as set by
1494 * gtk_expander_set_label(). If the label text has not
1495 * been set the return value will be %NULL. This will be the
1496 * case if you create an empty button with gtk_button_new() to
1497 * use as a container.
1499 * Return value: The text of the label widget. This string is owned
1500 * by the widget and must not be modified or freed.
1504 G_CONST_RETURN char *
1505 gtk_expander_get_label (GtkExpander *expander)
1507 GtkExpanderPrivate *priv;
1509 g_return_val_if_fail (GTK_IS_EXPANDER (expander), NULL);
1511 priv = expander->priv;
1513 if (priv->label_widget && GTK_IS_LABEL (priv->label_widget))
1514 return gtk_label_get_text (GTK_LABEL (priv->label_widget));
1520 * gtk_expander_set_use_underline:
1521 * @expander: a #GtkExpander
1522 * @use_underline: %TRUE if underlines in the text indicate mnemonics
1524 * If true, an underline in the text of the expander label indicates
1525 * the next character should be used for the mnemonic accelerator key.
1530 gtk_expander_set_use_underline (GtkExpander *expander,
1531 gboolean use_underline)
1533 GtkExpanderPrivate *priv;
1535 g_return_if_fail (GTK_IS_EXPANDER (expander));
1537 priv = expander->priv;
1539 use_underline = use_underline != FALSE;
1541 if (priv->use_underline != use_underline)
1543 priv->use_underline = use_underline;
1545 if (priv->label_widget && GTK_IS_LABEL (priv->label_widget))
1546 gtk_label_set_use_underline (GTK_LABEL (priv->label_widget), use_underline);
1548 g_object_notify (G_OBJECT (expander), "use-underline");
1553 * gtk_expander_get_use_underline:
1554 * @expander: a #GtkExpander
1556 * Returns whether an embedded underline in the expander label indicates a
1557 * mnemonic. See gtk_expander_set_use_underline().
1559 * Return value: %TRUE if an embedded underline in the expander label
1560 * indicates the mnemonic accelerator keys.
1565 gtk_expander_get_use_underline (GtkExpander *expander)
1567 g_return_val_if_fail (GTK_IS_EXPANDER (expander), FALSE);
1569 return expander->priv->use_underline;
1573 * gtk_expander_set_use_markup:
1574 * @expander: a #GtkExpander
1575 * @use_markup: %TRUE if the label's text should be parsed for markup
1577 * Sets whether the text of the label contains markup in <link
1578 * linkend="PangoMarkupFormat">Pango's text markup
1579 * language</link>. See gtk_label_set_markup().
1584 gtk_expander_set_use_markup (GtkExpander *expander,
1585 gboolean use_markup)
1587 GtkExpanderPrivate *priv;
1589 g_return_if_fail (GTK_IS_EXPANDER (expander));
1591 priv = expander->priv;
1593 use_markup = use_markup != FALSE;
1595 if (priv->use_markup != use_markup)
1597 priv->use_markup = use_markup;
1599 if (priv->label_widget && GTK_IS_LABEL (priv->label_widget))
1600 gtk_label_set_use_markup (GTK_LABEL (priv->label_widget), use_markup);
1602 g_object_notify (G_OBJECT (expander), "use-markup");
1607 * gtk_expander_get_use_markup:
1608 * @expander: a #GtkExpander
1610 * Returns whether the label's text is interpreted as marked up with
1611 * the <link linkend="PangoMarkupFormat">Pango text markup
1612 * language</link>. See gtk_expander_set_use_markup ().
1614 * Return value: %TRUE if the label's text will be parsed for markup
1619 gtk_expander_get_use_markup (GtkExpander *expander)
1621 g_return_val_if_fail (GTK_IS_EXPANDER (expander), FALSE);
1623 return expander->priv->use_markup;
1627 * gtk_expander_set_label_widget:
1628 * @expander: a #GtkExpander
1629 * @label_widget: the new label widget
1631 * Set the label widget for the expander. This is the widget
1632 * that will appear embedded alongside the expander arrow.
1637 gtk_expander_set_label_widget (GtkExpander *expander,
1638 GtkWidget *label_widget)
1640 GtkExpanderPrivate *priv;
1642 g_return_if_fail (GTK_IS_EXPANDER (expander));
1643 g_return_if_fail (label_widget == NULL || GTK_IS_WIDGET (label_widget));
1644 g_return_if_fail (label_widget == NULL || label_widget->parent == NULL);
1646 priv = expander->priv;
1648 if (priv->label_widget == label_widget)
1651 if (priv->label_widget)
1653 gtk_widget_set_state (priv->label_widget, GTK_STATE_NORMAL);
1654 gtk_widget_unparent (priv->label_widget);
1657 priv->label_widget = label_widget;
1661 priv->label_widget = label_widget;
1663 gtk_widget_set_parent (label_widget, GTK_WIDGET (expander));
1666 gtk_widget_set_state (label_widget, GTK_STATE_PRELIGHT);
1669 if (GTK_WIDGET_VISIBLE (expander))
1670 gtk_widget_queue_resize (GTK_WIDGET (expander));
1672 g_object_freeze_notify (G_OBJECT (expander));
1673 g_object_notify (G_OBJECT (expander), "label-widget");
1674 g_object_notify (G_OBJECT (expander), "label");
1675 g_object_thaw_notify (G_OBJECT (expander));
1679 * gtk_expander_get_label_widget:
1680 * @expander: a #GtkExpander
1682 * Retrieves the label widget for the frame. See
1683 * gtk_expander_set_label_widget().
1685 * Return value: the label widget, or %NULL if there is none.
1690 gtk_expander_get_label_widget (GtkExpander *expander)
1692 g_return_val_if_fail (GTK_IS_EXPANDER (expander), NULL);
1694 return expander->priv->label_widget;
1697 #define __GTK_EXPANDER_C__
1698 #include "gtkaliasdef.c"