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_new_with_mnemonic:
207 * @label: the text of the button, with an underscore in front of the
209 * @returns: a new #GtkToggleButton
211 * Creates a new #GtkToggleButton containing a label. The label
212 * will be created using gtk_label_new_with_mnemonic(), so underscores
213 * in @label indicate the mnemonic for the button.
216 gtk_toggle_button_new_with_mnemonic (const gchar *label)
218 GtkWidget *toggle_button;
219 GtkWidget *label_widget;
221 toggle_button = gtk_toggle_button_new ();
222 label_widget = gtk_label_new_with_mnemonic (label);
223 gtk_misc_set_alignment (GTK_MISC (label_widget), 0.5, 0.5);
225 gtk_container_add (GTK_CONTAINER (toggle_button), label_widget);
226 gtk_widget_show (label_widget);
228 return toggle_button;
232 gtk_toggle_button_set_property (GObject *object,
239 tb = GTK_TOGGLE_BUTTON (object);
244 gtk_toggle_button_set_active (tb, g_value_get_boolean (value));
246 case PROP_INCONSISTENT:
247 gtk_toggle_button_set_inconsistent (tb, g_value_get_boolean (value));
249 case PROP_DRAW_INDICATOR:
250 gtk_toggle_button_set_mode (tb, g_value_get_boolean (value));
258 gtk_toggle_button_get_property (GObject *object,
265 tb = GTK_TOGGLE_BUTTON (object);
270 g_value_set_boolean (value, tb->active);
272 case PROP_INCONSISTENT:
273 g_value_set_boolean (value, tb->inconsistent);
275 case PROP_DRAW_INDICATOR:
276 g_value_set_boolean (value, tb->draw_indicator);
279 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
285 gtk_toggle_button_set_mode (GtkToggleButton *toggle_button,
286 gboolean draw_indicator)
290 g_return_if_fail (toggle_button != NULL);
291 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button));
293 widget = GTK_WIDGET (toggle_button);
295 draw_indicator = draw_indicator ? TRUE : FALSE;
297 if (toggle_button->draw_indicator != draw_indicator)
299 if (GTK_WIDGET_REALIZED (toggle_button))
301 gboolean visible = GTK_WIDGET_VISIBLE (toggle_button);
304 gtk_widget_hide (widget);
306 gtk_widget_unrealize (widget);
307 toggle_button->draw_indicator = draw_indicator;
309 if (toggle_button->draw_indicator)
310 GTK_WIDGET_SET_FLAGS (toggle_button, GTK_NO_WINDOW);
312 GTK_WIDGET_UNSET_FLAGS (toggle_button, GTK_NO_WINDOW);
314 gtk_widget_realize (widget);
317 gtk_widget_show (widget);
321 toggle_button->draw_indicator = draw_indicator;
323 if (toggle_button->draw_indicator)
324 GTK_WIDGET_SET_FLAGS (toggle_button, GTK_NO_WINDOW);
326 GTK_WIDGET_UNSET_FLAGS (toggle_button, GTK_NO_WINDOW);
329 if (GTK_WIDGET_VISIBLE (toggle_button))
330 gtk_widget_queue_resize (GTK_WIDGET (toggle_button));
332 g_object_notify (G_OBJECT (toggle_button), "draw_indicator");
338 gtk_toggle_button_set_active (GtkToggleButton *toggle_button,
341 g_return_if_fail (toggle_button != NULL);
342 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button));
344 is_active = is_active != FALSE;
346 if (toggle_button->active != is_active)
347 gtk_button_clicked (GTK_BUTTON (toggle_button));
352 gtk_toggle_button_get_active (GtkToggleButton *toggle_button)
354 g_return_val_if_fail (toggle_button != NULL, FALSE);
355 g_return_val_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button), FALSE);
357 return (toggle_button->active) ? TRUE : FALSE;
362 gtk_toggle_button_toggled (GtkToggleButton *toggle_button)
364 g_return_if_fail (toggle_button != NULL);
365 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button));
367 gtk_signal_emit (GTK_OBJECT (toggle_button), toggle_button_signals[TOGGLED]);
371 * gtk_toggle_button_set_inconsistent:
372 * @toggle_button: a #GtkToggleButton
373 * @setting: %TRUE if state is inconsistent
375 * If the user has selected a range of elements (such as some text or
376 * spreadsheet cells) that are affected by a toggle button, and the
377 * current values in that range are inconsistent, you may want to
378 * display the toggle in an "in between" state. This function turns on
379 * "in between" display. Normally you would turn off the inconsistent
380 * state again if the user toggles the toggle button. This has to be
381 * done manually, gtk_toggle_button_set_inconsistent() only affects
382 * visual appearance, it doesn't affect the semantics of the button.
386 gtk_toggle_button_set_inconsistent (GtkToggleButton *toggle_button,
389 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button));
391 setting = setting != FALSE;
393 if (setting != toggle_button->inconsistent)
395 toggle_button->inconsistent = setting;
396 gtk_widget_queue_draw (GTK_WIDGET (toggle_button));
398 g_object_notify (G_OBJECT (toggle_button), "inconsistent");
403 * gtk_toggle_button_get_inconsistent:
404 * @toggle_button: a #GtkToggleButton
406 * Gets the value set by gtk_toggle_button_set_inconsistent().
408 * Return value: %TRUE if the button is displayed as inconsistent, %FALSE otherwise
411 gtk_toggle_button_get_inconsistent (GtkToggleButton *toggle_button)
413 g_return_val_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button), FALSE);
415 return toggle_button->inconsistent;
419 gtk_toggle_button_paint (GtkWidget *widget,
423 GtkToggleButton *toggle_button;
424 GtkShadowType shadow_type;
425 GtkStateType state_type;
427 gboolean interior_focus;
430 button = GTK_BUTTON (widget);
431 toggle_button = GTK_TOGGLE_BUTTON (widget);
433 if (GTK_WIDGET_DRAWABLE (widget))
435 gtk_widget_style_get (widget, "interior_focus", &interior_focus, NULL);
439 width = widget->allocation.width - GTK_CONTAINER (widget)->border_width * 2;
440 height = widget->allocation.height - GTK_CONTAINER (widget)->border_width * 2;
442 gdk_window_set_back_pixmap (widget->window, NULL, TRUE);
443 gdk_window_clear_area (widget->window, area->x, area->y, area->width, area->height);
445 if (GTK_WIDGET_HAS_DEFAULT (widget) &&
446 GTK_BUTTON (widget)->relief == GTK_RELIEF_NORMAL)
448 gtk_paint_box (widget->style, widget->window,
449 GTK_STATE_NORMAL, GTK_SHADOW_IN,
450 area, widget, "togglebuttondefault",
451 x, y, width, height);
454 if (GTK_WIDGET_CAN_DEFAULT (widget))
456 x += widget->style->xthickness;
457 y += widget->style->ythickness;
458 width -= 2 * x + DEFAULT_SPACING;
459 height -= 2 * y + DEFAULT_SPACING;
460 x += DEFAULT_LEFT_POS;
461 y += DEFAULT_TOP_POS;
464 if (GTK_WIDGET_HAS_FOCUS (widget) && !interior_focus)
472 state_type = GTK_WIDGET_STATE (widget);
474 if (toggle_button->inconsistent)
476 if (state_type == GTK_STATE_ACTIVE)
477 state_type = GTK_STATE_NORMAL;
478 shadow_type = GTK_SHADOW_ETCHED_IN;
480 else if ((GTK_WIDGET_STATE (widget) == GTK_STATE_ACTIVE) ||
481 toggle_button->active)
482 shadow_type = GTK_SHADOW_IN;
484 shadow_type = GTK_SHADOW_OUT;
486 if (button->relief != GTK_RELIEF_NONE ||
487 (GTK_WIDGET_STATE(widget) != GTK_STATE_NORMAL &&
488 GTK_WIDGET_STATE(widget) != GTK_STATE_INSENSITIVE))
489 gtk_paint_box (widget->style, widget->window,
491 shadow_type, area, widget, "togglebutton",
492 x, y, width, height);
494 if (GTK_WIDGET_HAS_FOCUS (widget))
498 x += widget->style->xthickness + 1;
499 y += widget->style->xthickness + 1;
500 width -= 2 * (widget->style->xthickness + 1);
501 height -= 2 * (widget->style->ythickness + 1);
511 gtk_paint_focus (widget->style, widget->window,
512 area, widget, "togglebutton",
513 x, y, width - 1, height - 1);
519 gtk_toggle_button_size_allocate (GtkWidget *widget,
520 GtkAllocation *allocation)
522 if (!GTK_WIDGET_NO_WINDOW (widget) &&
523 GTK_WIDGET_CLASS (parent_class)->size_allocate)
524 GTK_WIDGET_CLASS (parent_class)->size_allocate (widget, allocation);
528 gtk_toggle_button_expose (GtkWidget *widget,
529 GdkEventExpose *event)
531 if (GTK_WIDGET_DRAWABLE (widget))
533 GtkWidget *child = GTK_BIN (widget)->child;
535 gtk_toggle_button_paint (widget, &event->area);
538 gtk_container_propagate_expose (GTK_CONTAINER (widget), child, event);
545 gtk_toggle_button_pressed (GtkButton *button)
547 GtkToggleButton *toggle_button;
548 GtkStateType new_state;
550 g_return_if_fail (button != NULL);
551 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (button));
553 toggle_button = GTK_TOGGLE_BUTTON (button);
555 button->button_down = TRUE;
557 if (toggle_button->active)
558 new_state = (button->in_button ? GTK_STATE_NORMAL : GTK_STATE_ACTIVE);
560 new_state = (button->in_button ? GTK_STATE_ACTIVE : GTK_STATE_NORMAL);
562 if (GTK_WIDGET_STATE (button) != new_state)
563 gtk_widget_set_state (GTK_WIDGET (button), new_state);
567 gtk_toggle_button_released (GtkButton *button)
569 GtkToggleButton *toggle_button;
570 GtkStateType new_state;
572 g_return_if_fail (button != NULL);
573 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (button));
575 if (button->button_down)
577 toggle_button = GTK_TOGGLE_BUTTON (button);
579 button->button_down = FALSE;
581 if (button->in_button)
583 gtk_button_clicked (button);
587 if (toggle_button->active)
588 new_state = (button->in_button ? GTK_STATE_PRELIGHT : GTK_STATE_ACTIVE);
590 new_state = (button->in_button ? GTK_STATE_PRELIGHT : GTK_STATE_NORMAL);
592 if (GTK_WIDGET_STATE (button) != new_state)
593 gtk_widget_set_state (GTK_WIDGET (button), new_state);
599 gtk_toggle_button_clicked (GtkButton *button)
601 GtkToggleButton *toggle_button;
602 GtkStateType new_state;
604 g_return_if_fail (button != NULL);
605 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (button));
607 toggle_button = GTK_TOGGLE_BUTTON (button);
608 toggle_button->active = !toggle_button->active;
610 gtk_toggle_button_toggled (toggle_button);
612 if (toggle_button->active)
613 new_state = (button->in_button ? GTK_STATE_PRELIGHT : GTK_STATE_ACTIVE);
615 new_state = (button->in_button ? GTK_STATE_PRELIGHT : GTK_STATE_NORMAL);
617 if (GTK_WIDGET_STATE (button) != new_state)
618 gtk_widget_set_state (GTK_WIDGET (button), new_state);
620 gtk_widget_queue_draw (GTK_WIDGET (button));
622 g_object_notify (G_OBJECT (toggle_button), "active");
626 gtk_toggle_button_enter (GtkButton *button)
628 GtkToggleButton *toggle_button;
629 GtkStateType new_state;
631 g_return_if_fail (button != NULL);
632 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (button));
634 toggle_button = GTK_TOGGLE_BUTTON (button);
636 if (toggle_button->active)
637 new_state = (button->button_down ? GTK_STATE_NORMAL : GTK_STATE_PRELIGHT);
639 new_state = (button->button_down ? GTK_STATE_ACTIVE : GTK_STATE_PRELIGHT);
641 if (GTK_WIDGET_STATE (button) != new_state)
642 gtk_widget_set_state (GTK_WIDGET (button), new_state);
646 gtk_toggle_button_leave (GtkButton *button)
648 GtkToggleButton *toggle_button;
649 GtkStateType new_state;
651 g_return_if_fail (button != NULL);
652 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (button));
654 toggle_button = GTK_TOGGLE_BUTTON (button);
656 new_state = (toggle_button->active ? GTK_STATE_ACTIVE : GTK_STATE_NORMAL);
658 if (GTK_WIDGET_STATE (button) != new_state)
659 gtk_widget_set_state (GTK_WIDGET (button), new_state);
663 gtk_toggle_button_realize (GtkWidget *widget)
665 GtkToggleButton *toggle_button;
666 GdkWindowAttr attributes;
667 gint attributes_mask;
670 g_return_if_fail (widget != NULL);
671 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (widget));
673 toggle_button = GTK_TOGGLE_BUTTON (widget);
674 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
676 border_width = GTK_CONTAINER (widget)->border_width;
678 attributes.window_type = GDK_WINDOW_CHILD;
679 attributes.x = widget->allocation.x + border_width;
680 attributes.y = widget->allocation.y + border_width;
681 attributes.width = widget->allocation.width - border_width * 2;
682 attributes.height = widget->allocation.height - border_width * 2;
683 attributes.event_mask = gtk_widget_get_events (widget);
684 attributes.event_mask |= (GDK_EXPOSURE_MASK |
685 GDK_BUTTON_PRESS_MASK |
686 GDK_BUTTON_RELEASE_MASK |
687 GDK_ENTER_NOTIFY_MASK |
688 GDK_LEAVE_NOTIFY_MASK);
690 if (GTK_WIDGET_NO_WINDOW (widget))
692 attributes.wclass = GDK_INPUT_ONLY;
693 attributes_mask = GDK_WA_X | GDK_WA_Y;
695 widget->window = gtk_widget_get_parent_window (widget);
696 gdk_window_ref (widget->window);
698 toggle_button->event_window = gdk_window_new (gtk_widget_get_parent_window (widget),
699 &attributes, attributes_mask);
700 gdk_window_set_user_data (toggle_button->event_window, toggle_button);
704 attributes.wclass = GDK_INPUT_OUTPUT;
705 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
706 attributes.visual = gtk_widget_get_visual (widget);
707 attributes.colormap = gtk_widget_get_colormap (widget);
708 widget->window = gdk_window_new (gtk_widget_get_parent_window (widget),
709 &attributes, attributes_mask);
710 gdk_window_set_user_data (widget->window, toggle_button);
713 widget->style = gtk_style_attach (widget->style, widget->window);
715 if (!GTK_WIDGET_NO_WINDOW (widget))
716 gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
720 gtk_toggle_button_unrealize (GtkWidget *widget)
722 GtkToggleButton *toggle_button;
724 g_return_if_fail (widget != NULL);
725 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (widget));
727 toggle_button = GTK_TOGGLE_BUTTON (widget);
729 if (GTK_WIDGET_NO_WINDOW (widget))
731 gdk_window_set_user_data (toggle_button->event_window, NULL);
732 gdk_window_destroy (toggle_button->event_window);
733 toggle_button->event_window = NULL;
736 if (GTK_WIDGET_CLASS (parent_class)->unrealize)
737 (* GTK_WIDGET_CLASS (parent_class)->unrealize) (widget);
741 gtk_toggle_button_map (GtkWidget *widget)
743 g_return_if_fail (widget != NULL);
744 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (widget));
746 if (GTK_WIDGET_NO_WINDOW (widget))
747 gdk_window_show (GTK_TOGGLE_BUTTON (widget)->event_window);
749 GTK_WIDGET_CLASS (parent_class)->map (widget);
753 gtk_toggle_button_unmap (GtkWidget *widget)
755 g_return_if_fail (widget != NULL);
756 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (widget));
758 if (GTK_WIDGET_NO_WINDOW (widget))
759 gdk_window_hide (GTK_TOGGLE_BUTTON (widget)->event_window);
761 GTK_WIDGET_CLASS (parent_class)->unmap (widget);