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/.
29 #include "gtksignal.h"
30 #include "gtktogglebutton.h"
33 #define DEFAULT_LEFT_POS 4
34 #define DEFAULT_TOP_POS 4
35 #define DEFAULT_SPACING 7
50 static void gtk_toggle_button_class_init (GtkToggleButtonClass *klass);
51 static void gtk_toggle_button_init (GtkToggleButton *toggle_button);
52 static void gtk_toggle_button_paint (GtkWidget *widget,
54 static void gtk_toggle_button_size_allocate (GtkWidget *widget,
55 GtkAllocation *allocation);
56 static gint gtk_toggle_button_expose (GtkWidget *widget,
57 GdkEventExpose *event);
58 static void gtk_toggle_button_pressed (GtkButton *button);
59 static void gtk_toggle_button_released (GtkButton *button);
60 static void gtk_toggle_button_clicked (GtkButton *button);
61 static void gtk_toggle_button_enter (GtkButton *button);
62 static void gtk_toggle_button_leave (GtkButton *button);
63 static void gtk_toggle_button_set_property (GObject *object,
67 static void gtk_toggle_button_get_property (GObject *object,
71 static void gtk_toggle_button_leave (GtkButton *button);
72 static void gtk_toggle_button_realize (GtkWidget *widget);
73 static void gtk_toggle_button_unrealize (GtkWidget *widget);
74 static void gtk_toggle_button_map (GtkWidget *widget);
75 static void gtk_toggle_button_unmap (GtkWidget *widget);
77 static guint toggle_button_signals[LAST_SIGNAL] = { 0 };
78 static GtkContainerClass *parent_class = NULL;
81 gtk_toggle_button_get_type (void)
83 static GtkType toggle_button_type = 0;
85 if (!toggle_button_type)
87 static const GtkTypeInfo toggle_button_info =
90 sizeof (GtkToggleButton),
91 sizeof (GtkToggleButtonClass),
92 (GtkClassInitFunc) gtk_toggle_button_class_init,
93 (GtkObjectInitFunc) gtk_toggle_button_init,
94 /* reserved_1 */ NULL,
95 /* reserved_2 */ NULL,
96 (GtkClassInitFunc) NULL,
99 toggle_button_type = gtk_type_unique (GTK_TYPE_BUTTON, &toggle_button_info);
102 return toggle_button_type;
106 gtk_toggle_button_class_init (GtkToggleButtonClass *class)
108 GtkObjectClass *object_class;
109 GObjectClass *gobject_class;
110 GtkWidgetClass *widget_class;
111 GtkContainerClass *container_class;
112 GtkButtonClass *button_class;
114 object_class = (GtkObjectClass*) class;
115 gobject_class = G_OBJECT_CLASS (class);
116 widget_class = (GtkWidgetClass*) class;
117 container_class = (GtkContainerClass*) class;
118 button_class = (GtkButtonClass*) class;
120 parent_class = gtk_type_class (GTK_TYPE_BUTTON);
123 gobject_class->set_property = gtk_toggle_button_set_property;
124 gobject_class->get_property = gtk_toggle_button_get_property;
126 widget_class->size_allocate = gtk_toggle_button_size_allocate;
127 widget_class->expose_event = gtk_toggle_button_expose;
128 widget_class->realize = gtk_toggle_button_realize;
129 widget_class->unrealize = gtk_toggle_button_unrealize;
130 widget_class->map = gtk_toggle_button_map;
131 widget_class->unmap = gtk_toggle_button_unmap;
133 button_class->pressed = gtk_toggle_button_pressed;
134 button_class->released = gtk_toggle_button_released;
135 button_class->clicked = gtk_toggle_button_clicked;
136 button_class->enter = gtk_toggle_button_enter;
137 button_class->leave = gtk_toggle_button_leave;
139 class->toggled = NULL;
141 g_object_class_install_property (gobject_class,
143 g_param_spec_boolean ("active",
145 _("If the toggle button should be pressed in or not"),
149 g_object_class_install_property (gobject_class,
151 g_param_spec_boolean ("inconsistent",
153 _("If the toggle button is in an \"in between\" state."),
157 g_object_class_install_property (gobject_class,
159 g_param_spec_boolean ("draw_indicator",
161 _("If the toggle part of the button is displayed"),
165 toggle_button_signals[TOGGLED] =
166 gtk_signal_new ("toggled",
168 GTK_CLASS_TYPE (object_class),
169 GTK_SIGNAL_OFFSET (GtkToggleButtonClass, toggled),
170 gtk_marshal_VOID__VOID,
175 gtk_toggle_button_init (GtkToggleButton *toggle_button)
177 toggle_button->active = FALSE;
178 toggle_button->draw_indicator = FALSE;
179 GTK_WIDGET_UNSET_FLAGS (toggle_button, GTK_NO_WINDOW);
184 gtk_toggle_button_new (void)
186 return GTK_WIDGET (gtk_type_new (gtk_toggle_button_get_type ()));
190 gtk_toggle_button_new_with_label (const gchar *label)
192 GtkWidget *toggle_button;
193 GtkWidget *label_widget;
195 toggle_button = gtk_toggle_button_new ();
196 label_widget = gtk_label_new (label);
197 gtk_misc_set_alignment (GTK_MISC (label_widget), 0.5, 0.5);
199 gtk_container_add (GTK_CONTAINER (toggle_button), label_widget);
200 gtk_widget_show (label_widget);
202 return toggle_button;
206 gtk_toggle_button_set_property (GObject *object,
213 tb = GTK_TOGGLE_BUTTON (object);
218 gtk_toggle_button_set_active (tb, g_value_get_boolean (value));
220 case PROP_INCONSISTENT:
221 gtk_toggle_button_set_inconsistent (tb, g_value_get_boolean (value));
223 case PROP_DRAW_INDICATOR:
224 gtk_toggle_button_set_mode (tb, g_value_get_boolean (value));
232 gtk_toggle_button_get_property (GObject *object,
239 tb = GTK_TOGGLE_BUTTON (object);
244 g_value_set_boolean (value, tb->active);
246 case PROP_INCONSISTENT:
247 g_value_set_boolean (value, tb->inconsistent);
249 case PROP_DRAW_INDICATOR:
250 g_value_set_boolean (value, tb->draw_indicator);
253 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
259 gtk_toggle_button_set_mode (GtkToggleButton *toggle_button,
260 gboolean draw_indicator)
264 g_return_if_fail (toggle_button != NULL);
265 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button));
267 widget = GTK_WIDGET (toggle_button);
269 draw_indicator = draw_indicator ? TRUE : FALSE;
271 if (toggle_button->draw_indicator != draw_indicator)
273 if (GTK_WIDGET_REALIZED (toggle_button))
275 gboolean visible = GTK_WIDGET_VISIBLE (toggle_button);
278 gtk_widget_hide (widget);
280 gtk_widget_unrealize (widget);
281 toggle_button->draw_indicator = draw_indicator;
283 if (toggle_button->draw_indicator)
284 GTK_WIDGET_SET_FLAGS (toggle_button, GTK_NO_WINDOW);
286 GTK_WIDGET_UNSET_FLAGS (toggle_button, GTK_NO_WINDOW);
288 gtk_widget_realize (widget);
291 gtk_widget_show (widget);
295 toggle_button->draw_indicator = draw_indicator;
297 if (toggle_button->draw_indicator)
298 GTK_WIDGET_SET_FLAGS (toggle_button, GTK_NO_WINDOW);
300 GTK_WIDGET_UNSET_FLAGS (toggle_button, GTK_NO_WINDOW);
303 if (GTK_WIDGET_VISIBLE (toggle_button))
304 gtk_widget_queue_resize (GTK_WIDGET (toggle_button));
306 g_object_notify (G_OBJECT (toggle_button), "draw_indicator");
312 gtk_toggle_button_set_active (GtkToggleButton *toggle_button,
315 g_return_if_fail (toggle_button != NULL);
316 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button));
318 is_active = is_active != FALSE;
320 if (toggle_button->active != is_active)
321 gtk_button_clicked (GTK_BUTTON (toggle_button));
326 gtk_toggle_button_get_active (GtkToggleButton *toggle_button)
328 g_return_val_if_fail (toggle_button != NULL, FALSE);
329 g_return_val_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button), FALSE);
331 return (toggle_button->active) ? TRUE : FALSE;
336 gtk_toggle_button_toggled (GtkToggleButton *toggle_button)
338 g_return_if_fail (toggle_button != NULL);
339 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button));
341 gtk_signal_emit (GTK_OBJECT (toggle_button), toggle_button_signals[TOGGLED]);
345 * gtk_toggle_button_set_inconsistent:
346 * @toggle_button: a #GtkToggleButton
347 * @setting: %TRUE if state is inconsistent
349 * If the user has selected a range of elements (such as some text or
350 * spreadsheet cells) that are affected by a toggle button, and the
351 * current values in that range are inconsistent, you may want to
352 * display the toggle in an "in between" state. This function turns on
353 * "in between" display. Normally you would turn off the inconsistent
354 * state again if the user toggles the toggle button. This has to be
355 * done manually, gtk_toggle_button_set_inconsistent() only affects
356 * visual appearance, it doesn't affect the semantics of the button.
360 gtk_toggle_button_set_inconsistent (GtkToggleButton *toggle_button,
363 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button));
365 setting = setting != FALSE;
367 if (setting != toggle_button->inconsistent)
369 toggle_button->inconsistent = setting;
370 gtk_widget_queue_draw (GTK_WIDGET (toggle_button));
372 g_object_notify (G_OBJECT (toggle_button), "inconsistent");
377 * gtk_toggle_button_get_inconsistent:
378 * @toggle_button: a #GtkToggleButton
380 * Gets the value set by gtk_toggle_button_set_inconsistent().
382 * Return value: %TRUE if the button is displayed as inconsistent, %FALSE otherwise
385 gtk_toggle_button_get_inconsistent (GtkToggleButton *toggle_button)
387 g_return_val_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button), FALSE);
389 return toggle_button->inconsistent;
393 gtk_toggle_button_paint (GtkWidget *widget,
397 GtkToggleButton *toggle_button;
398 GtkShadowType shadow_type;
399 GtkStateType state_type;
401 gboolean interior_focus;
404 button = GTK_BUTTON (widget);
405 toggle_button = GTK_TOGGLE_BUTTON (widget);
407 if (GTK_WIDGET_DRAWABLE (widget))
409 gtk_widget_style_get (widget, "interior_focus", &interior_focus, NULL);
413 width = widget->allocation.width - GTK_CONTAINER (widget)->border_width * 2;
414 height = widget->allocation.height - GTK_CONTAINER (widget)->border_width * 2;
416 gdk_window_set_back_pixmap (widget->window, NULL, TRUE);
417 gdk_window_clear_area (widget->window, area->x, area->y, area->width, area->height);
419 if (GTK_WIDGET_HAS_DEFAULT (widget) &&
420 GTK_BUTTON (widget)->relief == GTK_RELIEF_NORMAL)
422 gtk_paint_box (widget->style, widget->window,
423 GTK_STATE_NORMAL, GTK_SHADOW_IN,
424 area, widget, "togglebuttondefault",
425 x, y, width, height);
428 if (GTK_WIDGET_CAN_DEFAULT (widget))
430 x += widget->style->xthickness;
431 y += widget->style->ythickness;
432 width -= 2 * x + DEFAULT_SPACING;
433 height -= 2 * y + DEFAULT_SPACING;
434 x += DEFAULT_LEFT_POS;
435 y += DEFAULT_TOP_POS;
438 if (GTK_WIDGET_HAS_FOCUS (widget) && !interior_focus)
446 state_type = GTK_WIDGET_STATE (widget);
448 if (toggle_button->inconsistent)
450 if (state_type == GTK_STATE_ACTIVE)
451 state_type = GTK_STATE_NORMAL;
452 shadow_type = GTK_SHADOW_ETCHED_IN;
454 else if ((GTK_WIDGET_STATE (widget) == GTK_STATE_ACTIVE) ||
455 toggle_button->active)
456 shadow_type = GTK_SHADOW_IN;
458 shadow_type = GTK_SHADOW_OUT;
460 if (button->relief != GTK_RELIEF_NONE ||
461 (GTK_WIDGET_STATE(widget) != GTK_STATE_NORMAL &&
462 GTK_WIDGET_STATE(widget) != GTK_STATE_INSENSITIVE))
463 gtk_paint_box (widget->style, widget->window,
465 shadow_type, area, widget, "togglebutton",
466 x, y, width, height);
468 if (GTK_WIDGET_HAS_FOCUS (widget))
472 x += widget->style->xthickness + 1;
473 y += widget->style->xthickness + 1;
474 width -= 2 * (widget->style->xthickness + 1);
475 height -= 2 * (widget->style->ythickness + 1);
485 gtk_paint_focus (widget->style, widget->window,
486 area, widget, "togglebutton",
487 x, y, width - 1, height - 1);
493 gtk_toggle_button_size_allocate (GtkWidget *widget,
494 GtkAllocation *allocation)
496 if (!GTK_WIDGET_NO_WINDOW (widget) &&
497 GTK_WIDGET_CLASS (parent_class)->size_allocate)
498 GTK_WIDGET_CLASS (parent_class)->size_allocate (widget, allocation);
502 gtk_toggle_button_expose (GtkWidget *widget,
503 GdkEventExpose *event)
505 if (GTK_WIDGET_DRAWABLE (widget))
507 GtkWidget *child = GTK_BIN (widget)->child;
509 gtk_toggle_button_paint (widget, &event->area);
512 gtk_container_propagate_expose (GTK_CONTAINER (widget), child, event);
519 gtk_toggle_button_pressed (GtkButton *button)
521 GtkToggleButton *toggle_button;
522 GtkStateType new_state;
524 g_return_if_fail (button != NULL);
525 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (button));
527 toggle_button = GTK_TOGGLE_BUTTON (button);
529 button->button_down = TRUE;
531 if (toggle_button->active)
532 new_state = (button->in_button ? GTK_STATE_NORMAL : GTK_STATE_ACTIVE);
534 new_state = (button->in_button ? GTK_STATE_ACTIVE : GTK_STATE_NORMAL);
536 if (GTK_WIDGET_STATE (button) != new_state)
537 gtk_widget_set_state (GTK_WIDGET (button), new_state);
541 gtk_toggle_button_released (GtkButton *button)
543 GtkToggleButton *toggle_button;
544 GtkStateType new_state;
546 g_return_if_fail (button != NULL);
547 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (button));
549 if (button->button_down)
551 toggle_button = GTK_TOGGLE_BUTTON (button);
553 button->button_down = FALSE;
555 if (button->in_button)
557 gtk_button_clicked (button);
561 if (toggle_button->active)
562 new_state = (button->in_button ? GTK_STATE_PRELIGHT : GTK_STATE_ACTIVE);
564 new_state = (button->in_button ? GTK_STATE_PRELIGHT : GTK_STATE_NORMAL);
566 if (GTK_WIDGET_STATE (button) != new_state)
567 gtk_widget_set_state (GTK_WIDGET (button), new_state);
573 gtk_toggle_button_clicked (GtkButton *button)
575 GtkToggleButton *toggle_button;
576 GtkStateType new_state;
578 g_return_if_fail (button != NULL);
579 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (button));
581 toggle_button = GTK_TOGGLE_BUTTON (button);
582 toggle_button->active = !toggle_button->active;
584 gtk_toggle_button_toggled (toggle_button);
586 if (toggle_button->active)
587 new_state = (button->in_button ? GTK_STATE_PRELIGHT : GTK_STATE_ACTIVE);
589 new_state = (button->in_button ? GTK_STATE_PRELIGHT : GTK_STATE_NORMAL);
591 if (GTK_WIDGET_STATE (button) != new_state)
592 gtk_widget_set_state (GTK_WIDGET (button), new_state);
594 gtk_widget_queue_draw (GTK_WIDGET (button));
596 g_object_notify (G_OBJECT (toggle_button), "active");
600 gtk_toggle_button_enter (GtkButton *button)
602 GtkToggleButton *toggle_button;
603 GtkStateType new_state;
605 g_return_if_fail (button != NULL);
606 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (button));
608 toggle_button = GTK_TOGGLE_BUTTON (button);
610 if (toggle_button->active)
611 new_state = (button->button_down ? GTK_STATE_NORMAL : GTK_STATE_PRELIGHT);
613 new_state = (button->button_down ? GTK_STATE_ACTIVE : GTK_STATE_PRELIGHT);
615 if (GTK_WIDGET_STATE (button) != new_state)
616 gtk_widget_set_state (GTK_WIDGET (button), new_state);
620 gtk_toggle_button_leave (GtkButton *button)
622 GtkToggleButton *toggle_button;
623 GtkStateType new_state;
625 g_return_if_fail (button != NULL);
626 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (button));
628 toggle_button = GTK_TOGGLE_BUTTON (button);
630 new_state = (toggle_button->active ? GTK_STATE_ACTIVE : GTK_STATE_NORMAL);
632 if (GTK_WIDGET_STATE (button) != new_state)
633 gtk_widget_set_state (GTK_WIDGET (button), new_state);
637 gtk_toggle_button_realize (GtkWidget *widget)
639 GtkToggleButton *toggle_button;
640 GdkWindowAttr attributes;
641 gint attributes_mask;
644 g_return_if_fail (widget != NULL);
645 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (widget));
647 toggle_button = GTK_TOGGLE_BUTTON (widget);
648 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
650 border_width = GTK_CONTAINER (widget)->border_width;
652 attributes.window_type = GDK_WINDOW_CHILD;
653 attributes.x = widget->allocation.x + border_width;
654 attributes.y = widget->allocation.y + border_width;
655 attributes.width = widget->allocation.width - border_width * 2;
656 attributes.height = widget->allocation.height - border_width * 2;
657 attributes.event_mask = gtk_widget_get_events (widget);
658 attributes.event_mask |= (GDK_EXPOSURE_MASK |
659 GDK_BUTTON_PRESS_MASK |
660 GDK_BUTTON_RELEASE_MASK |
661 GDK_ENTER_NOTIFY_MASK |
662 GDK_LEAVE_NOTIFY_MASK);
664 if (GTK_WIDGET_NO_WINDOW (widget))
666 attributes.wclass = GDK_INPUT_ONLY;
667 attributes_mask = GDK_WA_X | GDK_WA_Y;
669 widget->window = gtk_widget_get_parent_window (widget);
670 gdk_window_ref (widget->window);
672 toggle_button->event_window = gdk_window_new (gtk_widget_get_parent_window (widget),
673 &attributes, attributes_mask);
674 gdk_window_set_user_data (toggle_button->event_window, toggle_button);
678 attributes.wclass = GDK_INPUT_OUTPUT;
679 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
680 attributes.visual = gtk_widget_get_visual (widget);
681 attributes.colormap = gtk_widget_get_colormap (widget);
682 widget->window = gdk_window_new (gtk_widget_get_parent_window (widget),
683 &attributes, attributes_mask);
684 gdk_window_set_user_data (widget->window, toggle_button);
687 widget->style = gtk_style_attach (widget->style, widget->window);
689 if (!GTK_WIDGET_NO_WINDOW (widget))
690 gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
694 gtk_toggle_button_unrealize (GtkWidget *widget)
696 GtkToggleButton *toggle_button;
698 g_return_if_fail (widget != NULL);
699 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (widget));
701 toggle_button = GTK_TOGGLE_BUTTON (widget);
703 if (GTK_WIDGET_NO_WINDOW (widget))
705 gdk_window_set_user_data (toggle_button->event_window, NULL);
706 gdk_window_destroy (toggle_button->event_window);
707 toggle_button->event_window = NULL;
710 if (GTK_WIDGET_CLASS (parent_class)->unrealize)
711 (* GTK_WIDGET_CLASS (parent_class)->unrealize) (widget);
715 gtk_toggle_button_map (GtkWidget *widget)
717 g_return_if_fail (widget != NULL);
718 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (widget));
720 if (GTK_WIDGET_NO_WINDOW (widget))
721 gdk_window_show (GTK_TOGGLE_BUTTON (widget)->event_window);
723 GTK_WIDGET_CLASS (parent_class)->map (widget);
727 gtk_toggle_button_unmap (GtkWidget *widget)
729 g_return_if_fail (widget != NULL);
730 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (widget));
732 if (GTK_WIDGET_NO_WINDOW (widget))
733 gdk_window_hide (GTK_TOGGLE_BUTTON (widget)->event_window);
735 GTK_WIDGET_CLASS (parent_class)->unmap (widget);