2 * Copyright (C) 2000 Red Hat, Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library 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 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library 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.
23 #undef GTK_DISABLE_DEPRECATED
26 #include "prop-editor.h"
32 GObject *alive_object;
37 disconnect_func (gpointer data)
39 DisconnectData *dd = data;
41 g_signal_handler_disconnect (dd->instance, dd->id);
45 signal_removed (gpointer data,
48 DisconnectData *dd = data;
50 g_object_steal_data (dd->alive_object, "alive-object-data");
55 g_object_connect_property (GObject *object,
56 const gchar *prop_name,
59 GObject *alive_object)
62 gchar *with_detail = g_strconcat ("notify::", prop_name, NULL);
65 dd = g_new (DisconnectData, 1);
67 closure = g_cclosure_new (func, data, NULL);
69 g_closure_add_invalidate_notifier (closure, dd, signal_removed);
71 dd->id = g_signal_connect_closure (object, with_detail,
74 dd->instance = object;
75 dd->alive_object = alive_object;
77 g_object_set_data_full (G_OBJECT (alive_object),
93 free_object_property (ObjectProperty *p)
100 connect_controller (GObject *controller,
103 const gchar *prop_name,
108 p = g_new (ObjectProperty, 1);
110 p->prop = g_strdup (prop_name);
112 p->modified_id = g_signal_connect_data (controller, signal, func, p,
113 (GClosureNotify)free_object_property,
115 g_object_set_data (controller, "object-property", p);
119 block_controller (GObject *controller)
121 ObjectProperty *p = g_object_get_data (controller, "object-property");
124 g_signal_handler_block (controller, p->modified_id);
128 unblock_controller (GObject *controller)
130 ObjectProperty *p = g_object_get_data (controller, "object-property");
133 g_signal_handler_unblock (controller, p->modified_id);
137 int_modified (GtkAdjustment *adj, gpointer data)
139 ObjectProperty *p = data;
141 g_object_set (p->obj, p->prop, (int) adj->value, NULL);
145 int_changed (GObject *object, GParamSpec *pspec, gpointer data)
147 GtkAdjustment *adj = GTK_ADJUSTMENT (data);
150 g_value_init (&val, G_TYPE_INT);
151 g_object_get_property (object, pspec->name, &val);
153 if (g_value_get_int (&val) != (int)adj->value)
155 block_controller (G_OBJECT (adj));
156 gtk_adjustment_set_value (adj, g_value_get_int (&val));
157 unblock_controller (G_OBJECT (adj));
160 g_value_unset (&val);
164 uint_modified (GtkAdjustment *adj, gpointer data)
166 ObjectProperty *p = data;
168 g_object_set (p->obj, p->prop, (guint) adj->value, NULL);
172 uint_changed (GObject *object, GParamSpec *pspec, gpointer data)
174 GtkAdjustment *adj = GTK_ADJUSTMENT (data);
177 g_value_init (&val, G_TYPE_UINT);
178 g_object_get_property (object, pspec->name, &val);
180 if (g_value_get_uint (&val) != (guint)adj->value)
182 block_controller (G_OBJECT (adj));
183 gtk_adjustment_set_value (adj, g_value_get_uint (&val));
184 unblock_controller (G_OBJECT (adj));
187 g_value_unset (&val);
191 float_modified (GtkAdjustment *adj, gpointer data)
193 ObjectProperty *p = data;
195 g_object_set (p->obj, p->prop, (float) adj->value, NULL);
199 float_changed (GObject *object, GParamSpec *pspec, gpointer data)
201 GtkAdjustment *adj = GTK_ADJUSTMENT (data);
204 g_value_init (&val, G_TYPE_FLOAT);
205 g_object_get_property (object, pspec->name, &val);
207 if (g_value_get_float (&val) != (float) adj->value)
209 block_controller (G_OBJECT (adj));
210 gtk_adjustment_set_value (adj, g_value_get_float (&val));
211 unblock_controller (G_OBJECT (adj));
214 g_value_unset (&val);
218 double_modified (GtkAdjustment *adj, gpointer data)
220 ObjectProperty *p = data;
222 g_object_set (p->obj, p->prop, (double) adj->value, NULL);
226 double_changed (GObject *object, GParamSpec *pspec, gpointer data)
228 GtkAdjustment *adj = GTK_ADJUSTMENT (data);
231 g_value_init (&val, G_TYPE_DOUBLE);
232 g_object_get_property (object, pspec->name, &val);
234 if (g_value_get_double (&val) != adj->value)
236 block_controller (G_OBJECT (adj));
237 gtk_adjustment_set_value (adj, g_value_get_double (&val));
238 unblock_controller (G_OBJECT (adj));
241 g_value_unset (&val);
245 string_modified (GtkEntry *entry, gpointer data)
247 ObjectProperty *p = data;
250 text = gtk_entry_get_text (entry);
252 g_object_set (p->obj, p->prop, text, NULL);
256 string_changed (GObject *object, GParamSpec *pspec, gpointer data)
258 GtkEntry *entry = GTK_ENTRY (data);
263 g_value_init (&val, G_TYPE_STRING);
264 g_object_get_property (object, pspec->name, &val);
266 str = g_value_get_string (&val);
269 text = gtk_entry_get_text (entry);
271 if (strcmp (str, text) != 0)
273 block_controller (G_OBJECT (entry));
274 gtk_entry_set_text (entry, str);
275 unblock_controller (G_OBJECT (entry));
278 g_value_unset (&val);
282 bool_modified (GtkToggleButton *tb, gpointer data)
284 ObjectProperty *p = data;
286 g_object_set (p->obj, p->prop, (int) tb->active, NULL);
290 bool_changed (GObject *object, GParamSpec *pspec, gpointer data)
292 GtkToggleButton *tb = GTK_TOGGLE_BUTTON (data);
295 g_value_init (&val, G_TYPE_BOOLEAN);
296 g_object_get_property (object, pspec->name, &val);
298 if (g_value_get_boolean (&val) != tb->active)
300 block_controller (G_OBJECT (tb));
301 gtk_toggle_button_set_active (tb, g_value_get_boolean (&val));
302 unblock_controller (G_OBJECT (tb));
305 gtk_label_set_text (GTK_LABEL (GTK_BIN (tb)->child), g_value_get_boolean (&val) ?
308 g_value_unset (&val);
313 enum_modified (GtkOptionMenu *om, gpointer data)
315 ObjectProperty *p = data;
320 spec = g_object_class_find_property (G_OBJECT_GET_CLASS (p->obj),
323 eclass = G_ENUM_CLASS (g_type_class_peek (spec->value_type));
325 i = gtk_option_menu_get_history (om);
327 g_object_set (p->obj, p->prop, eclass->values[i].value, NULL);
331 enum_changed (GObject *object, GParamSpec *pspec, gpointer data)
333 GtkOptionMenu *om = GTK_OPTION_MENU (data);
338 eclass = G_ENUM_CLASS (g_type_class_peek (pspec->value_type));
340 g_value_init (&val, pspec->value_type);
341 g_object_get_property (object, pspec->name, &val);
344 while (i < eclass->n_values)
346 if (eclass->values[i].value == g_value_get_enum (&val))
351 if (gtk_option_menu_get_history (om) != i)
353 block_controller (G_OBJECT (om));
354 gtk_option_menu_set_history (om, i);
355 unblock_controller (G_OBJECT (om));
358 g_value_unset (&val);
363 unichar_get_value (GtkEntry *entry)
365 const gchar *text = gtk_entry_get_text (entry);
368 return g_utf8_get_char (text);
374 unichar_modified (GtkEntry *entry, gpointer data)
376 ObjectProperty *p = data;
377 gunichar val = unichar_get_value (entry);
379 g_object_set (p->obj, p->prop, val, NULL);
383 unichar_changed (GObject *object, GParamSpec *pspec, gpointer data)
385 GtkEntry *entry = GTK_ENTRY (data);
387 gunichar old_val = unichar_get_value (entry);
391 g_object_get (object, pspec->name, &new_val, NULL);
393 if (new_val != old_val)
398 len = g_unichar_to_utf8 (new_val, buf);
402 block_controller (G_OBJECT (entry));
403 gtk_entry_set_text (entry, buf);
404 unblock_controller (G_OBJECT (entry));
409 pointer_changed (GObject *object, GParamSpec *pspec, gpointer data)
411 GtkLabel *label = GTK_LABEL (data);
415 g_object_get (object, pspec->name, &ptr, NULL);
417 str = g_strdup_printf ("Pointer: %p", ptr);
418 gtk_label_set_text (label, str);
423 object_changed (GObject *object, GParamSpec *pspec, gpointer data)
425 GtkWidget *label, *button;
430 GList *children = gtk_container_get_children (GTK_CONTAINER (data));
431 label = GTK_WIDGET (children->data);
432 button = GTK_WIDGET (children->next->data);
433 g_object_get (object, pspec->name, &obj, NULL);
434 g_list_free (children);
437 name = g_type_name (G_TYPE_FROM_INSTANCE (obj));
440 str = g_strdup_printf ("Object: %p (%s)", obj, name);
442 gtk_label_set_text (GTK_LABEL (label), str);
443 gtk_widget_set_sensitive (button, G_IS_OBJECT (obj));
449 model_destroy (gpointer data)
451 g_object_steal_data (data, "model-object");
452 gtk_widget_destroy (data);
456 window_destroy (gpointer data)
458 g_object_steal_data (data, "prop-editor-win");
462 object_properties (GtkWidget *button,
468 name = (gchar *) g_object_get_data (G_OBJECT (button), "property-name");
469 g_object_get (object, name, &obj, NULL);
470 if (G_IS_OBJECT (obj))
471 create_prop_editor (obj, 0);
475 property_widget (GObject *object, GParamSpec *spec, gboolean can_modify)
477 GtkWidget *prop_edit;
480 GType type = G_PARAM_SPEC_TYPE (spec);
482 if (type == G_TYPE_PARAM_INT)
484 adj = GTK_ADJUSTMENT (gtk_adjustment_new (G_PARAM_SPEC_INT (spec)->default_value,
485 G_PARAM_SPEC_INT (spec)->minimum,
486 G_PARAM_SPEC_INT (spec)->maximum,
488 MAX ((G_PARAM_SPEC_INT (spec)->maximum -
489 G_PARAM_SPEC_INT (spec)->minimum) / 10, 1),
492 prop_edit = gtk_spin_button_new (adj, 1.0, 0);
494 g_object_connect_property (object, spec->name,
495 G_CALLBACK (int_changed),
496 adj, G_OBJECT (adj));
499 connect_controller (G_OBJECT (adj), "value_changed",
500 object, spec->name, (GtkSignalFunc) int_modified);
502 else if (type == G_TYPE_PARAM_UINT)
504 adj = GTK_ADJUSTMENT (
505 gtk_adjustment_new (G_PARAM_SPEC_UINT (spec)->default_value,
506 G_PARAM_SPEC_UINT (spec)->minimum,
507 G_PARAM_SPEC_UINT (spec)->maximum,
509 MAX ((G_PARAM_SPEC_UINT (spec)->maximum -
510 G_PARAM_SPEC_UINT (spec)->minimum) / 10, 1),
513 prop_edit = gtk_spin_button_new (adj, 1.0, 0);
515 g_object_connect_property (object, spec->name,
516 G_CALLBACK (uint_changed),
517 adj, G_OBJECT (adj));
520 connect_controller (G_OBJECT (adj), "value_changed",
521 object, spec->name, (GtkSignalFunc) uint_modified);
523 else if (type == G_TYPE_PARAM_FLOAT)
526 adj = GTK_ADJUSTMENT (gtk_adjustment_new (G_PARAM_SPEC_FLOAT (spec)->default_value,
527 G_PARAM_SPEC_FLOAT (spec)->minimum,
528 G_PARAM_SPEC_FLOAT (spec)->maximum,
530 MAX ((G_PARAM_SPEC_FLOAT (spec)->maximum -
531 G_PARAM_SPEC_FLOAT (spec)->minimum) / 10, 0.1),
534 prop_edit = gtk_spin_button_new (adj, 0.1, 2);
536 g_object_connect_property (object, spec->name,
537 G_CALLBACK (float_changed),
538 adj, G_OBJECT (adj));
541 connect_controller (G_OBJECT (adj), "value_changed",
542 object, spec->name, (GtkSignalFunc) float_modified);
544 else if (type == G_TYPE_PARAM_DOUBLE)
546 adj = GTK_ADJUSTMENT (gtk_adjustment_new (G_PARAM_SPEC_DOUBLE (spec)->default_value,
547 G_PARAM_SPEC_DOUBLE (spec)->minimum,
548 G_PARAM_SPEC_DOUBLE (spec)->maximum,
550 MAX ((G_PARAM_SPEC_DOUBLE (spec)->maximum -
551 G_PARAM_SPEC_DOUBLE (spec)->minimum) / 10, 0.1),
554 prop_edit = gtk_spin_button_new (adj, 0.1, 2);
556 g_object_connect_property (object, spec->name,
557 G_CALLBACK (double_changed),
558 adj, G_OBJECT (adj));
561 connect_controller (G_OBJECT (adj), "value_changed",
562 object, spec->name, (GtkSignalFunc) double_modified);
564 else if (type == G_TYPE_PARAM_STRING)
566 prop_edit = gtk_entry_new ();
568 g_object_connect_property (object, spec->name,
569 G_CALLBACK (string_changed),
570 prop_edit, G_OBJECT (prop_edit));
573 connect_controller (G_OBJECT (prop_edit), "changed",
574 object, spec->name, (GtkSignalFunc) string_modified);
576 else if (type == G_TYPE_PARAM_BOOLEAN)
578 prop_edit = gtk_toggle_button_new_with_label ("");
580 g_object_connect_property (object, spec->name,
581 G_CALLBACK (bool_changed),
582 prop_edit, G_OBJECT (prop_edit));
585 connect_controller (G_OBJECT (prop_edit), "toggled",
586 object, spec->name, (GtkSignalFunc) bool_modified);
588 else if (type == G_TYPE_PARAM_ENUM)
595 prop_edit = gtk_option_menu_new ();
597 menu = gtk_menu_new ();
599 eclass = G_ENUM_CLASS (g_type_class_ref (spec->value_type));
602 while (j < eclass->n_values)
606 mi = gtk_menu_item_new_with_label (eclass->values[j].value_name);
608 gtk_widget_show (mi);
610 gtk_menu_shell_append (GTK_MENU_SHELL (menu), mi);
615 g_type_class_unref (eclass);
617 gtk_option_menu_set_menu (GTK_OPTION_MENU (prop_edit), menu);
619 g_object_connect_property (object, spec->name,
620 G_CALLBACK (enum_changed),
621 prop_edit, G_OBJECT (prop_edit));
624 connect_controller (G_OBJECT (prop_edit), "changed",
625 object, spec->name, (GtkSignalFunc) enum_modified);
628 else if (type == G_TYPE_PARAM_UNICHAR)
630 prop_edit = gtk_entry_new ();
631 gtk_entry_set_max_length (GTK_ENTRY (prop_edit), 1);
633 g_object_connect_property (object, spec->name,
634 G_CALLBACK (unichar_changed),
635 prop_edit, G_OBJECT (prop_edit));
638 connect_controller (G_OBJECT (prop_edit), "changed",
639 object, spec->name, (GtkSignalFunc) unichar_modified);
641 else if (type == G_TYPE_PARAM_POINTER)
643 prop_edit = gtk_label_new ("");
645 g_object_connect_property (object, spec->name,
646 G_CALLBACK (pointer_changed),
647 prop_edit, G_OBJECT (prop_edit));
649 else if (type == G_TYPE_PARAM_OBJECT)
651 GtkWidget *label, *button;
653 prop_edit = gtk_hbox_new (FALSE, 5);
655 label = gtk_label_new ("");
656 button = gtk_button_new_with_label ("Properties");
657 g_object_set_data (G_OBJECT (button), "property-name", spec->name);
658 g_signal_connect (button, "clicked",
659 G_CALLBACK (object_properties),
662 gtk_container_add (GTK_CONTAINER (prop_edit), label);
663 gtk_container_add (GTK_CONTAINER (prop_edit), button);
665 g_object_connect_property (object, spec->name,
666 G_CALLBACK (object_changed),
667 prop_edit, G_OBJECT (label));
671 msg = g_strdup_printf ("uneditable property type: %s",
672 g_type_name (G_PARAM_SPEC_TYPE (spec)));
673 prop_edit = gtk_label_new (msg);
675 gtk_misc_set_alignment (GTK_MISC (prop_edit), 0.0, 0.5);
682 properties_from_type (GObject *object,
686 GtkWidget *prop_edit;
695 if (G_TYPE_IS_INTERFACE (type))
697 gpointer vtable = g_type_default_interface_peek (type);
698 specs = g_object_interface_list_properties (vtable, &n_specs);
702 GObjectClass *class = G_OBJECT_CLASS (g_type_class_peek (type));
703 specs = g_object_class_list_properties (class, &n_specs);
709 table = gtk_table_new (n_specs, 2, FALSE);
710 gtk_table_set_col_spacing (GTK_TABLE (table), 0, 10);
711 gtk_table_set_row_spacings (GTK_TABLE (table), 3);
716 GParamSpec *spec = specs[i];
721 can_modify = ((spec->flags & G_PARAM_WRITABLE) != 0 &&
722 (spec->flags & G_PARAM_CONSTRUCT_ONLY) == 0);
724 if ((spec->flags & G_PARAM_READABLE) == 0)
726 /* can't display unreadable properties */
731 if (spec->owner_type != type)
733 /* we're only interested in params of type */
738 label = gtk_label_new (g_param_spec_get_nick (spec));
739 gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
740 gtk_table_attach_defaults (GTK_TABLE (table), label, 0, 1, i, i + 1);
742 prop_edit = property_widget (object, spec, can_modify);
743 gtk_table_attach_defaults (GTK_TABLE (table), prop_edit, 1, 2, i, i + 1);
748 gtk_widget_set_sensitive (prop_edit, FALSE);
750 if (g_param_spec_get_blurb (spec))
751 gtk_tooltips_set_tip (tips, prop_edit, g_param_spec_get_blurb (spec), NULL);
753 /* set initial value */
754 g_object_notify (object, spec->name);
761 vbox = gtk_vbox_new (FALSE, 0);
762 gtk_box_pack_start (GTK_BOX (vbox), table, FALSE, FALSE, 0);
764 sw = gtk_scrolled_window_new (NULL, NULL);
765 gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (sw),
766 GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC);
768 gtk_scrolled_window_add_with_viewport (GTK_SCROLLED_WINDOW (sw), vbox);
776 /* Pass zero for type if you want all properties */
778 create_prop_editor (GObject *object,
784 GtkWidget *properties;
790 if ((win = g_object_get_data (G_OBJECT (object), "prop-editor-win")))
792 gtk_window_present (GTK_WINDOW (win));
796 win = gtk_window_new (GTK_WINDOW_TOPLEVEL);
797 if (GTK_IS_WIDGET (object))
798 gtk_window_set_screen (GTK_WINDOW (win),
799 gtk_widget_get_screen (GTK_WIDGET (object)));
801 tips = gtk_tooltips_new ();
802 g_signal_connect_swapped (win, "destroy",
803 G_CALLBACK (gtk_object_destroy), tips);
805 /* hold a weak ref to the object we're editing */
806 g_object_set_data_full (G_OBJECT (object), "prop-editor-win", win, model_destroy);
807 g_object_set_data_full (G_OBJECT (win), "model-object", object, window_destroy);
811 notebook = gtk_notebook_new ();
812 gtk_notebook_set_tab_pos (GTK_NOTEBOOK (notebook), GTK_POS_LEFT);
814 gtk_container_add (GTK_CONTAINER (win), notebook);
816 type = G_TYPE_FROM_INSTANCE (object);
818 title = g_strdup_printf ("Properties of %s widget", g_type_name (type));
819 gtk_window_set_title (GTK_WINDOW (win), title);
824 properties = properties_from_type (object, type, tips);
827 label = gtk_label_new (g_type_name (type));
828 gtk_notebook_append_page (GTK_NOTEBOOK (notebook),
832 type = g_type_parent (type);
835 ifaces = g_type_interfaces (G_TYPE_FROM_INSTANCE (object), &n_ifaces);
838 properties = properties_from_type (object, ifaces[n_ifaces], tips);
841 label = gtk_label_new (g_type_name (ifaces[n_ifaces]));
842 gtk_notebook_append_page (GTK_NOTEBOOK (notebook),
851 properties = properties_from_type (object, type, tips);
852 gtk_container_add (GTK_CONTAINER (win), properties);
853 title = g_strdup_printf ("Properties of %s", g_type_name (type));
854 gtk_window_set_title (GTK_WINDOW (win), title);
858 gtk_window_set_default_size (GTK_WINDOW (win), -1, 400);
860 gtk_widget_show_all (win);