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
49 static void gtk_toggle_button_class_init (GtkToggleButtonClass *klass);
50 static void gtk_toggle_button_init (GtkToggleButton *toggle_button);
51 static void gtk_toggle_button_paint (GtkWidget *widget,
53 static void gtk_toggle_button_size_allocate (GtkWidget *widget,
54 GtkAllocation *allocation);
55 static gint gtk_toggle_button_expose (GtkWidget *widget,
56 GdkEventExpose *event);
57 static void gtk_toggle_button_pressed (GtkButton *button);
58 static void gtk_toggle_button_released (GtkButton *button);
59 static void gtk_toggle_button_clicked (GtkButton *button);
60 static void gtk_toggle_button_enter (GtkButton *button);
61 static void gtk_toggle_button_leave (GtkButton *button);
62 static void gtk_toggle_button_set_arg (GtkObject *object,
65 static void gtk_toggle_button_get_arg (GtkObject *object,
68 static void gtk_toggle_button_leave (GtkButton *button);
69 static void gtk_toggle_button_realize (GtkWidget *widget);
70 static void gtk_toggle_button_unrealize (GtkWidget *widget);
71 static void gtk_toggle_button_map (GtkWidget *widget);
72 static void gtk_toggle_button_unmap (GtkWidget *widget);
74 static guint toggle_button_signals[LAST_SIGNAL] = { 0 };
75 static GtkContainerClass *parent_class = NULL;
78 gtk_toggle_button_get_type (void)
80 static GtkType toggle_button_type = 0;
82 if (!toggle_button_type)
84 static const GtkTypeInfo toggle_button_info =
87 sizeof (GtkToggleButton),
88 sizeof (GtkToggleButtonClass),
89 (GtkClassInitFunc) gtk_toggle_button_class_init,
90 (GtkObjectInitFunc) gtk_toggle_button_init,
91 /* reserved_1 */ NULL,
92 /* reserved_2 */ NULL,
93 (GtkClassInitFunc) NULL,
96 toggle_button_type = gtk_type_unique (GTK_TYPE_BUTTON, &toggle_button_info);
99 return toggle_button_type;
103 gtk_toggle_button_class_init (GtkToggleButtonClass *class)
105 GtkObjectClass *object_class;
106 GtkWidgetClass *widget_class;
107 GtkContainerClass *container_class;
108 GtkButtonClass *button_class;
110 object_class = (GtkObjectClass*) class;
111 widget_class = (GtkWidgetClass*) class;
112 container_class = (GtkContainerClass*) class;
113 button_class = (GtkButtonClass*) class;
115 parent_class = gtk_type_class (GTK_TYPE_BUTTON);
118 object_class->set_arg = gtk_toggle_button_set_arg;
119 object_class->get_arg = gtk_toggle_button_get_arg;
121 widget_class->size_allocate = gtk_toggle_button_size_allocate;
122 widget_class->expose_event = gtk_toggle_button_expose;
123 widget_class->realize = gtk_toggle_button_realize;
124 widget_class->unrealize = gtk_toggle_button_unrealize;
125 widget_class->map = gtk_toggle_button_map;
126 widget_class->unmap = gtk_toggle_button_unmap;
128 button_class->pressed = gtk_toggle_button_pressed;
129 button_class->released = gtk_toggle_button_released;
130 button_class->clicked = gtk_toggle_button_clicked;
131 button_class->enter = gtk_toggle_button_enter;
132 button_class->leave = gtk_toggle_button_leave;
134 class->toggled = NULL;
136 gtk_object_add_arg_type ("GtkToggleButton::active", GTK_TYPE_BOOL, GTK_ARG_READWRITE, ARG_ACTIVE);
137 gtk_object_add_arg_type ("GtkToggleButton::draw_indicator", GTK_TYPE_BOOL, GTK_ARG_READWRITE, ARG_DRAW_INDICATOR);
139 toggle_button_signals[TOGGLED] =
140 gtk_signal_new ("toggled",
142 GTK_CLASS_TYPE (object_class),
143 GTK_SIGNAL_OFFSET (GtkToggleButtonClass, toggled),
144 gtk_marshal_VOID__VOID,
149 gtk_toggle_button_init (GtkToggleButton *toggle_button)
151 toggle_button->active = FALSE;
152 toggle_button->draw_indicator = FALSE;
153 GTK_WIDGET_UNSET_FLAGS (toggle_button, GTK_NO_WINDOW);
158 gtk_toggle_button_new (void)
160 return GTK_WIDGET (gtk_type_new (gtk_toggle_button_get_type ()));
164 gtk_toggle_button_new_with_label (const gchar *label)
166 GtkWidget *toggle_button;
167 GtkWidget *label_widget;
169 toggle_button = gtk_toggle_button_new ();
170 label_widget = gtk_label_new (label);
171 gtk_misc_set_alignment (GTK_MISC (label_widget), 0.5, 0.5);
173 gtk_container_add (GTK_CONTAINER (toggle_button), label_widget);
174 gtk_widget_show (label_widget);
176 return toggle_button;
180 gtk_toggle_button_set_arg (GtkObject *object,
186 tb = GTK_TOGGLE_BUTTON (object);
191 gtk_toggle_button_set_active (tb, GTK_VALUE_BOOL (*arg));
193 case ARG_DRAW_INDICATOR:
194 gtk_toggle_button_set_mode (tb, GTK_VALUE_BOOL (*arg));
202 gtk_toggle_button_get_arg (GtkObject *object,
208 tb = GTK_TOGGLE_BUTTON (object);
213 GTK_VALUE_BOOL (*arg) = tb->active;
215 case ARG_DRAW_INDICATOR:
216 GTK_VALUE_BOOL (*arg) = tb->draw_indicator;
219 arg->type = GTK_TYPE_INVALID;
225 gtk_toggle_button_set_mode (GtkToggleButton *toggle_button,
226 gboolean draw_indicator)
230 g_return_if_fail (toggle_button != NULL);
231 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button));
233 widget = GTK_WIDGET (toggle_button);
235 draw_indicator = draw_indicator ? TRUE : FALSE;
237 if (toggle_button->draw_indicator != draw_indicator)
239 if (GTK_WIDGET_REALIZED (toggle_button))
241 gboolean visible = GTK_WIDGET_VISIBLE (toggle_button);
244 gtk_widget_hide (widget);
246 gtk_widget_unrealize (widget);
247 toggle_button->draw_indicator = draw_indicator;
249 if (toggle_button->draw_indicator)
250 GTK_WIDGET_SET_FLAGS (toggle_button, GTK_NO_WINDOW);
252 GTK_WIDGET_UNSET_FLAGS (toggle_button, GTK_NO_WINDOW);
254 gtk_widget_realize (widget);
257 gtk_widget_show (widget);
261 toggle_button->draw_indicator = draw_indicator;
263 if (toggle_button->draw_indicator)
264 GTK_WIDGET_SET_FLAGS (toggle_button, GTK_NO_WINDOW);
266 GTK_WIDGET_UNSET_FLAGS (toggle_button, GTK_NO_WINDOW);
269 if (GTK_WIDGET_VISIBLE (toggle_button))
270 gtk_widget_queue_resize (GTK_WIDGET (toggle_button));
276 gtk_toggle_button_set_active (GtkToggleButton *toggle_button,
279 g_return_if_fail (toggle_button != NULL);
280 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button));
282 is_active = is_active != 0;
284 if (toggle_button->active != is_active)
285 gtk_button_clicked (GTK_BUTTON (toggle_button));
290 gtk_toggle_button_get_active (GtkToggleButton *toggle_button)
292 g_return_val_if_fail (toggle_button != NULL, FALSE);
293 g_return_val_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button), FALSE);
295 return (toggle_button->active) ? TRUE : FALSE;
300 gtk_toggle_button_toggled (GtkToggleButton *toggle_button)
302 g_return_if_fail (toggle_button != NULL);
303 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button));
305 gtk_signal_emit (GTK_OBJECT (toggle_button), toggle_button_signals[TOGGLED]);
309 * gtk_toggle_button_set_inconsistent:
310 * @toggle_button: a #GtkToggleButton
311 * @setting: %TRUE if state is inconsistent
313 * If the user has selected a range of elements (such as some text or
314 * spreadsheet cells) that are affected by a toggle button, and the
315 * current values in that range are inconsistent, you may want to
316 * display the toggle in an "in between" state. This function turns on
317 * "in between" display. Normally you would turn off the inconsistent
318 * state again if the user toggles the toggle button. This has to be
319 * done manually, gtk_toggle_button_set_inconsistent() only affects
320 * visual appearance, it doesn't affect the semantics of the button.
324 gtk_toggle_button_set_inconsistent (GtkToggleButton *toggle_button,
327 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button));
329 setting = setting != FALSE;
331 if (setting != toggle_button->inconsistent)
333 toggle_button->inconsistent = setting;
334 gtk_widget_queue_draw (GTK_WIDGET (toggle_button));
339 * gtk_toggle_button_get_inconsistent:
340 * @toggle_button: a #GtkToggleButton
342 * Gets the value set by gtk_toggle_button_set_inconsistent().
344 * Return value: %TRUE if the button is displayed as inconsistent, %FALSE otherwise
347 gtk_toggle_button_get_inconsistent (GtkToggleButton *toggle_button)
349 g_return_val_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button), FALSE);
351 return toggle_button->inconsistent;
355 gtk_toggle_button_paint (GtkWidget *widget,
359 GtkToggleButton *toggle_button;
360 GtkShadowType shadow_type;
361 GtkStateType state_type;
365 button = GTK_BUTTON (widget);
366 toggle_button = GTK_TOGGLE_BUTTON (widget);
368 if (GTK_WIDGET_DRAWABLE (widget))
372 width = widget->allocation.width - GTK_CONTAINER (widget)->border_width * 2;
373 height = widget->allocation.height - GTK_CONTAINER (widget)->border_width * 2;
375 gdk_window_set_back_pixmap (widget->window, NULL, TRUE);
376 gdk_window_clear_area (widget->window, area->x, area->y, area->width, area->height);
378 if (GTK_WIDGET_HAS_DEFAULT (widget) &&
379 GTK_BUTTON (widget)->relief == GTK_RELIEF_NORMAL)
381 gtk_paint_box (widget->style, widget->window,
382 GTK_STATE_NORMAL, GTK_SHADOW_IN,
383 area, widget, "togglebuttondefault",
384 x, y, width, height);
387 if (GTK_WIDGET_CAN_DEFAULT (widget))
389 x += widget->style->xthickness;
390 y += widget->style->ythickness;
391 width -= 2 * x + DEFAULT_SPACING;
392 height -= 2 * y + DEFAULT_SPACING;
393 x += DEFAULT_LEFT_POS;
394 y += DEFAULT_TOP_POS;
397 if (GTK_WIDGET_HAS_FOCUS (widget))
405 state_type = GTK_WIDGET_STATE (widget);
407 if (toggle_button->inconsistent)
409 if (state_type == GTK_STATE_ACTIVE)
410 state_type = GTK_STATE_NORMAL;
411 shadow_type = GTK_SHADOW_ETCHED_IN;
413 else if ((GTK_WIDGET_STATE (widget) == GTK_STATE_ACTIVE) ||
414 toggle_button->active)
415 shadow_type = GTK_SHADOW_IN;
417 shadow_type = GTK_SHADOW_OUT;
419 if (button->relief != GTK_RELIEF_NONE ||
420 (GTK_WIDGET_STATE(widget) != GTK_STATE_NORMAL &&
421 GTK_WIDGET_STATE(widget) != GTK_STATE_INSENSITIVE))
422 gtk_paint_box (widget->style, widget->window,
424 shadow_type, area, widget, "togglebutton",
425 x, y, width, height);
427 if (GTK_WIDGET_HAS_FOCUS (widget))
434 gtk_paint_focus (widget->style, widget->window,
435 area, widget, "togglebutton",
436 x, y, width - 1, height - 1);
442 gtk_toggle_button_size_allocate (GtkWidget *widget,
443 GtkAllocation *allocation)
445 if (!GTK_WIDGET_NO_WINDOW (widget) &&
446 GTK_WIDGET_CLASS (parent_class)->size_allocate)
447 GTK_WIDGET_CLASS (parent_class)->size_allocate (widget, allocation);
451 gtk_toggle_button_expose (GtkWidget *widget,
452 GdkEventExpose *event)
455 GdkEventExpose child_event;
457 if (GTK_WIDGET_DRAWABLE (widget))
459 bin = GTK_BIN (widget);
461 gtk_toggle_button_paint (widget, &event->area);
463 child_event = *event;
464 if (bin->child && GTK_WIDGET_NO_WINDOW (bin->child) &&
465 gtk_widget_intersect (bin->child, &event->area, &child_event.area))
466 gtk_widget_event (bin->child, (GdkEvent*) &child_event);
473 gtk_toggle_button_pressed (GtkButton *button)
475 GtkToggleButton *toggle_button;
476 GtkStateType new_state;
478 g_return_if_fail (button != NULL);
479 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (button));
481 toggle_button = GTK_TOGGLE_BUTTON (button);
483 button->button_down = TRUE;
485 if (toggle_button->active)
486 new_state = (button->in_button ? GTK_STATE_NORMAL : GTK_STATE_ACTIVE);
488 new_state = (button->in_button ? GTK_STATE_ACTIVE : GTK_STATE_NORMAL);
490 if (GTK_WIDGET_STATE (button) != new_state)
491 gtk_widget_set_state (GTK_WIDGET (button), new_state);
495 gtk_toggle_button_released (GtkButton *button)
497 GtkToggleButton *toggle_button;
498 GtkStateType new_state;
500 g_return_if_fail (button != NULL);
501 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (button));
503 if (button->button_down)
505 toggle_button = GTK_TOGGLE_BUTTON (button);
507 button->button_down = FALSE;
509 if (button->in_button)
511 gtk_button_clicked (button);
515 if (toggle_button->active)
516 new_state = (button->in_button ? GTK_STATE_PRELIGHT : GTK_STATE_ACTIVE);
518 new_state = (button->in_button ? GTK_STATE_PRELIGHT : GTK_STATE_NORMAL);
520 if (GTK_WIDGET_STATE (button) != new_state)
521 gtk_widget_set_state (GTK_WIDGET (button), new_state);
527 gtk_toggle_button_clicked (GtkButton *button)
529 GtkToggleButton *toggle_button;
530 GtkStateType new_state;
532 g_return_if_fail (button != NULL);
533 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (button));
535 toggle_button = GTK_TOGGLE_BUTTON (button);
536 toggle_button->active = !toggle_button->active;
538 gtk_toggle_button_toggled (toggle_button);
540 if (toggle_button->active)
541 new_state = (button->in_button ? GTK_STATE_PRELIGHT : GTK_STATE_ACTIVE);
543 new_state = (button->in_button ? GTK_STATE_PRELIGHT : GTK_STATE_NORMAL);
545 if (GTK_WIDGET_STATE (button) != new_state)
546 gtk_widget_set_state (GTK_WIDGET (button), new_state);
548 gtk_widget_queue_draw (GTK_WIDGET (button));
552 gtk_toggle_button_enter (GtkButton *button)
554 GtkToggleButton *toggle_button;
555 GtkStateType new_state;
557 g_return_if_fail (button != NULL);
558 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (button));
560 toggle_button = GTK_TOGGLE_BUTTON (button);
562 if (toggle_button->active)
563 new_state = (button->button_down ? GTK_STATE_NORMAL : GTK_STATE_PRELIGHT);
565 new_state = (button->button_down ? GTK_STATE_ACTIVE : GTK_STATE_PRELIGHT);
567 if (GTK_WIDGET_STATE (button) != new_state)
568 gtk_widget_set_state (GTK_WIDGET (button), new_state);
572 gtk_toggle_button_leave (GtkButton *button)
574 GtkToggleButton *toggle_button;
575 GtkStateType new_state;
577 g_return_if_fail (button != NULL);
578 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (button));
580 toggle_button = GTK_TOGGLE_BUTTON (button);
582 new_state = (toggle_button->active ? GTK_STATE_ACTIVE : GTK_STATE_NORMAL);
584 if (GTK_WIDGET_STATE (button) != new_state)
585 gtk_widget_set_state (GTK_WIDGET (button), new_state);
589 gtk_toggle_button_realize (GtkWidget *widget)
591 GtkToggleButton *toggle_button;
592 GdkWindowAttr attributes;
593 gint attributes_mask;
596 g_return_if_fail (widget != NULL);
597 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (widget));
599 toggle_button = GTK_TOGGLE_BUTTON (widget);
600 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
602 border_width = GTK_CONTAINER (widget)->border_width;
604 attributes.window_type = GDK_WINDOW_CHILD;
605 attributes.x = widget->allocation.x + border_width;
606 attributes.y = widget->allocation.y + border_width;
607 attributes.width = widget->allocation.width - border_width * 2;
608 attributes.height = widget->allocation.height - border_width * 2;
609 attributes.event_mask = gtk_widget_get_events (widget);
610 attributes.event_mask |= (GDK_EXPOSURE_MASK |
611 GDK_BUTTON_PRESS_MASK |
612 GDK_BUTTON_RELEASE_MASK |
613 GDK_ENTER_NOTIFY_MASK |
614 GDK_LEAVE_NOTIFY_MASK);
616 if (GTK_WIDGET_NO_WINDOW (widget))
618 attributes.wclass = GDK_INPUT_ONLY;
619 attributes_mask = GDK_WA_X | GDK_WA_Y;
621 widget->window = gtk_widget_get_parent_window (widget);
622 gdk_window_ref (widget->window);
624 toggle_button->event_window = gdk_window_new (gtk_widget_get_parent_window (widget),
625 &attributes, attributes_mask);
626 gdk_window_set_user_data (toggle_button->event_window, toggle_button);
630 attributes.wclass = GDK_INPUT_OUTPUT;
631 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
632 attributes.visual = gtk_widget_get_visual (widget);
633 attributes.colormap = gtk_widget_get_colormap (widget);
634 widget->window = gdk_window_new (gtk_widget_get_parent_window (widget),
635 &attributes, attributes_mask);
636 gdk_window_set_user_data (widget->window, toggle_button);
639 widget->style = gtk_style_attach (widget->style, widget->window);
641 if (!GTK_WIDGET_NO_WINDOW (widget))
642 gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
646 gtk_toggle_button_unrealize (GtkWidget *widget)
648 GtkToggleButton *toggle_button;
650 g_return_if_fail (widget != NULL);
651 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (widget));
653 toggle_button = GTK_TOGGLE_BUTTON (widget);
655 if (GTK_WIDGET_NO_WINDOW (widget))
657 gdk_window_set_user_data (toggle_button->event_window, NULL);
658 gdk_window_destroy (toggle_button->event_window);
659 toggle_button->event_window = NULL;
662 if (GTK_WIDGET_CLASS (parent_class)->unrealize)
663 (* GTK_WIDGET_CLASS (parent_class)->unrealize) (widget);
667 gtk_toggle_button_map (GtkWidget *widget)
669 g_return_if_fail (widget != NULL);
670 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (widget));
672 if (GTK_WIDGET_NO_WINDOW (widget))
673 gdk_window_show (GTK_TOGGLE_BUTTON (widget)->event_window);
675 GTK_WIDGET_CLASS (parent_class)->map (widget);
679 gtk_toggle_button_unmap (GtkWidget *widget)
681 g_return_if_fail (widget != NULL);
682 g_return_if_fail (GTK_IS_TOGGLE_BUTTON (widget));
684 if (GTK_WIDGET_NO_WINDOW (widget))
685 gdk_window_hide (GTK_TOGGLE_BUTTON (widget)->event_window);
687 GTK_WIDGET_CLASS (parent_class)->unmap (widget);