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.
22 #undef GTK_DISABLE_DEPRECATED
25 #include "prop-editor.h"
31 GObject *alive_object;
36 disconnect_func (gpointer data)
38 DisconnectData *dd = data;
40 g_signal_handler_disconnect (dd->instance, dd->id);
44 signal_removed (gpointer data,
47 DisconnectData *dd = data;
49 g_object_steal_data (dd->alive_object, "alive-object-data");
54 g_object_connect_property (GObject *object,
55 const gchar *prop_name,
58 GObject *alive_object)
61 gchar *with_detail = g_strconcat ("notify::", prop_name, NULL);
64 dd = g_new (DisconnectData, 1);
66 closure = g_cclosure_new (func, data, NULL);
68 g_closure_add_invalidate_notifier (closure, dd, signal_removed);
70 dd->id = g_signal_connect_closure (object, with_detail,
73 dd->instance = object;
74 dd->alive_object = alive_object;
76 g_object_set_data_full (G_OBJECT (alive_object),
92 free_object_property (ObjectProperty *p)
99 connect_controller (GObject *controller,
102 const gchar *prop_name,
107 p = g_new (ObjectProperty, 1);
109 p->prop = g_strdup (prop_name);
111 p->modified_id = g_signal_connect_data (controller, signal, func, p,
112 (GClosureNotify)free_object_property,
114 g_object_set_data (controller, "object-property", p);
118 block_controller (GObject *controller)
120 ObjectProperty *p = g_object_get_data (controller, "object-property");
123 g_signal_handler_block (controller, p->modified_id);
127 unblock_controller (GObject *controller)
129 ObjectProperty *p = g_object_get_data (controller, "object-property");
132 g_signal_handler_unblock (controller, p->modified_id);
136 int_modified (GtkAdjustment *adj, gpointer data)
138 ObjectProperty *p = data;
140 g_object_set (p->obj, p->prop, (int) adj->value, NULL);
144 int_changed (GObject *object, GParamSpec *pspec, gpointer data)
146 GtkAdjustment *adj = GTK_ADJUSTMENT (data);
149 g_value_init (&val, G_TYPE_INT);
150 g_object_get_property (object, pspec->name, &val);
152 if (g_value_get_int (&val) != (int)adj->value)
154 block_controller (G_OBJECT (adj));
155 gtk_adjustment_set_value (adj, g_value_get_int (&val));
156 unblock_controller (G_OBJECT (adj));
159 g_value_unset (&val);
163 uint_modified (GtkAdjustment *adj, gpointer data)
165 ObjectProperty *p = data;
167 g_object_set (p->obj, p->prop, (guint) adj->value, NULL);
171 uint_changed (GObject *object, GParamSpec *pspec, gpointer data)
173 GtkAdjustment *adj = GTK_ADJUSTMENT (data);
176 g_value_init (&val, G_TYPE_UINT);
177 g_object_get_property (object, pspec->name, &val);
179 if (g_value_get_uint (&val) != (guint)adj->value)
181 block_controller (G_OBJECT (adj));
182 gtk_adjustment_set_value (adj, g_value_get_uint (&val));
183 unblock_controller (G_OBJECT (adj));
186 g_value_unset (&val);
190 float_modified (GtkAdjustment *adj, gpointer data)
192 ObjectProperty *p = data;
194 g_object_set (p->obj, p->prop, (float) adj->value, NULL);
198 float_changed (GObject *object, GParamSpec *pspec, gpointer data)
200 GtkAdjustment *adj = GTK_ADJUSTMENT (data);
203 g_value_init (&val, G_TYPE_FLOAT);
204 g_object_get_property (object, pspec->name, &val);
206 if (g_value_get_float (&val) != (float) adj->value)
208 block_controller (G_OBJECT (adj));
209 gtk_adjustment_set_value (adj, g_value_get_float (&val));
210 unblock_controller (G_OBJECT (adj));
213 g_value_unset (&val);
217 double_modified (GtkAdjustment *adj, gpointer data)
219 ObjectProperty *p = data;
221 g_object_set (p->obj, p->prop, (double) adj->value, NULL);
225 double_changed (GObject *object, GParamSpec *pspec, gpointer data)
227 GtkAdjustment *adj = GTK_ADJUSTMENT (data);
230 g_value_init (&val, G_TYPE_DOUBLE);
231 g_object_get_property (object, pspec->name, &val);
233 if (g_value_get_double (&val) != adj->value)
235 block_controller (G_OBJECT (adj));
236 gtk_adjustment_set_value (adj, g_value_get_double (&val));
237 unblock_controller (G_OBJECT (adj));
240 g_value_unset (&val);
244 string_modified (GtkEntry *entry, gpointer data)
246 ObjectProperty *p = data;
249 text = gtk_entry_get_text (entry);
251 g_object_set (p->obj, p->prop, text, NULL);
255 string_changed (GObject *object, GParamSpec *pspec, gpointer data)
257 GtkEntry *entry = GTK_ENTRY (data);
262 g_value_init (&val, G_TYPE_STRING);
263 g_object_get_property (object, pspec->name, &val);
265 str = g_value_get_string (&val);
268 text = gtk_entry_get_text (entry);
270 if (strcmp (str, text) != 0)
272 block_controller (G_OBJECT (entry));
273 gtk_entry_set_text (entry, str);
274 unblock_controller (G_OBJECT (entry));
277 g_value_unset (&val);
281 bool_modified (GtkToggleButton *tb, gpointer data)
283 ObjectProperty *p = data;
285 g_object_set (p->obj, p->prop, (int) tb->active, NULL);
289 bool_changed (GObject *object, GParamSpec *pspec, gpointer data)
291 GtkToggleButton *tb = GTK_TOGGLE_BUTTON (data);
294 g_value_init (&val, G_TYPE_BOOLEAN);
295 g_object_get_property (object, pspec->name, &val);
297 if (g_value_get_boolean (&val) != tb->active)
299 block_controller (G_OBJECT (tb));
300 gtk_toggle_button_set_active (tb, g_value_get_boolean (&val));
301 unblock_controller (G_OBJECT (tb));
304 gtk_label_set_text (GTK_LABEL (GTK_BIN (tb)->child), g_value_get_boolean (&val) ?
307 g_value_unset (&val);
312 enum_modified (GtkOptionMenu *om, gpointer data)
314 ObjectProperty *p = data;
319 spec = g_object_class_find_property (G_OBJECT_GET_CLASS (p->obj),
322 eclass = G_ENUM_CLASS (g_type_class_peek (spec->value_type));
324 i = gtk_option_menu_get_history (om);
326 g_object_set (p->obj, p->prop, eclass->values[i].value, NULL);
330 enum_changed (GObject *object, GParamSpec *pspec, gpointer data)
332 GtkOptionMenu *om = GTK_OPTION_MENU (data);
337 eclass = G_ENUM_CLASS (g_type_class_peek (pspec->value_type));
339 g_value_init (&val, pspec->value_type);
340 g_object_get_property (object, pspec->name, &val);
343 while (i < eclass->n_values)
345 if (eclass->values[i].value == g_value_get_enum (&val))
350 if (gtk_option_menu_get_history (om) != i)
352 block_controller (G_OBJECT (om));
353 gtk_option_menu_set_history (om, i);
354 unblock_controller (G_OBJECT (om));
357 g_value_unset (&val);
362 unichar_get_value (GtkEntry *entry)
364 const gchar *text = gtk_entry_get_text (entry);
367 return g_utf8_get_char (text);
373 unichar_modified (GtkEntry *entry, gpointer data)
375 ObjectProperty *p = data;
376 gunichar val = unichar_get_value (entry);
378 g_object_set (p->obj, p->prop, val, NULL);
382 unichar_changed (GObject *object, GParamSpec *pspec, gpointer data)
384 GtkEntry *entry = GTK_ENTRY (data);
386 gunichar old_val = unichar_get_value (entry);
390 g_object_get (object, pspec->name, &new_val, NULL);
392 if (new_val != old_val)
397 len = g_unichar_to_utf8 (new_val, buf);
401 block_controller (G_OBJECT (entry));
402 gtk_entry_set_text (entry, buf);
403 unblock_controller (G_OBJECT (entry));
408 pointer_changed (GObject *object, GParamSpec *pspec, gpointer data)
410 GtkLabel *label = GTK_LABEL (data);
414 g_object_get (object, pspec->name, &ptr, NULL);
416 str = g_strdup_printf ("Pointer: %p", ptr);
417 gtk_label_set_text (label, str);
422 object_changed (GObject *object, GParamSpec *pspec, gpointer data)
424 GtkWidget *label, *button;
429 GList *children = gtk_container_get_children (GTK_CONTAINER (data));
430 label = GTK_WIDGET (children->data);
431 button = GTK_WIDGET (children->next->data);
432 g_object_get (object, pspec->name, &obj, NULL);
435 name = g_type_name (G_TYPE_FROM_INSTANCE (obj));
438 str = g_strdup_printf ("Object: %p (%s)", obj, name);
440 gtk_label_set_text (GTK_LABEL (label), str);
441 gtk_widget_set_sensitive (button, G_IS_OBJECT (obj));
447 model_destroy (gpointer data)
449 g_object_steal_data (data, "model-object");
450 gtk_widget_destroy (data);
454 window_destroy (gpointer data)
456 g_object_steal_data (data, "prop-editor-win");
460 object_properties (GtkWidget *button,
466 name = (gchar *) g_object_get_data (G_OBJECT (button), "property-name");
467 g_object_get (object, name, &obj, NULL);
468 if (G_IS_OBJECT (obj))
469 create_prop_editor (obj, 0);
473 property_widget (GObject *object, GParamSpec *spec, gboolean can_modify)
475 GtkWidget *prop_edit;
478 GType type = G_PARAM_SPEC_TYPE (spec);
480 if (type == G_TYPE_PARAM_INT)
482 adj = GTK_ADJUSTMENT (gtk_adjustment_new (G_PARAM_SPEC_INT (spec)->default_value,
483 G_PARAM_SPEC_INT (spec)->minimum,
484 G_PARAM_SPEC_INT (spec)->maximum,
486 MAX ((G_PARAM_SPEC_INT (spec)->maximum -
487 G_PARAM_SPEC_INT (spec)->minimum) / 10, 1),
490 prop_edit = gtk_spin_button_new (adj, 1.0, 0);
492 g_object_connect_property (object, spec->name,
493 G_CALLBACK (int_changed),
494 adj, G_OBJECT (adj));
497 connect_controller (G_OBJECT (adj), "value_changed",
498 object, spec->name, (GtkSignalFunc) int_modified);
500 else if (type == G_TYPE_PARAM_UINT)
502 adj = GTK_ADJUSTMENT (
503 gtk_adjustment_new (G_PARAM_SPEC_UINT (spec)->default_value,
504 G_PARAM_SPEC_UINT (spec)->minimum,
505 G_PARAM_SPEC_UINT (spec)->maximum,
507 MAX ((G_PARAM_SPEC_UINT (spec)->maximum -
508 G_PARAM_SPEC_UINT (spec)->minimum) / 10, 1),
511 prop_edit = gtk_spin_button_new (adj, 1.0, 0);
513 g_object_connect_property (object, spec->name,
514 G_CALLBACK (uint_changed),
515 adj, G_OBJECT (adj));
518 connect_controller (G_OBJECT (adj), "value_changed",
519 object, spec->name, (GtkSignalFunc) uint_modified);
521 else if (type == G_TYPE_PARAM_FLOAT)
524 adj = GTK_ADJUSTMENT (gtk_adjustment_new (G_PARAM_SPEC_FLOAT (spec)->default_value,
525 G_PARAM_SPEC_FLOAT (spec)->minimum,
526 G_PARAM_SPEC_FLOAT (spec)->maximum,
528 MAX ((G_PARAM_SPEC_FLOAT (spec)->maximum -
529 G_PARAM_SPEC_FLOAT (spec)->minimum) / 10, 0.1),
532 prop_edit = gtk_spin_button_new (adj, 0.1, 2);
534 g_object_connect_property (object, spec->name,
535 G_CALLBACK (float_changed),
536 adj, G_OBJECT (adj));
539 connect_controller (G_OBJECT (adj), "value_changed",
540 object, spec->name, (GtkSignalFunc) float_modified);
542 else if (type == G_TYPE_PARAM_DOUBLE)
544 adj = GTK_ADJUSTMENT (gtk_adjustment_new (G_PARAM_SPEC_DOUBLE (spec)->default_value,
545 G_PARAM_SPEC_DOUBLE (spec)->minimum,
546 G_PARAM_SPEC_DOUBLE (spec)->maximum,
548 MAX ((G_PARAM_SPEC_DOUBLE (spec)->maximum -
549 G_PARAM_SPEC_DOUBLE (spec)->minimum) / 10, 0.1),
552 prop_edit = gtk_spin_button_new (adj, 0.1, 2);
554 g_object_connect_property (object, spec->name,
555 G_CALLBACK (double_changed),
556 adj, G_OBJECT (adj));
559 connect_controller (G_OBJECT (adj), "value_changed",
560 object, spec->name, (GtkSignalFunc) double_modified);
562 else if (type == G_TYPE_PARAM_STRING)
564 prop_edit = gtk_entry_new ();
566 g_object_connect_property (object, spec->name,
567 G_CALLBACK (string_changed),
568 prop_edit, G_OBJECT (prop_edit));
571 connect_controller (G_OBJECT (prop_edit), "changed",
572 object, spec->name, (GtkSignalFunc) string_modified);
574 else if (type == G_TYPE_PARAM_BOOLEAN)
576 prop_edit = gtk_toggle_button_new_with_label ("");
578 g_object_connect_property (object, spec->name,
579 G_CALLBACK (bool_changed),
580 prop_edit, G_OBJECT (prop_edit));
583 connect_controller (G_OBJECT (prop_edit), "toggled",
584 object, spec->name, (GtkSignalFunc) bool_modified);
586 else if (type == G_TYPE_PARAM_ENUM)
593 prop_edit = gtk_option_menu_new ();
595 menu = gtk_menu_new ();
597 eclass = G_ENUM_CLASS (g_type_class_ref (spec->value_type));
600 while (j < eclass->n_values)
604 mi = gtk_menu_item_new_with_label (eclass->values[j].value_name);
606 gtk_widget_show (mi);
608 gtk_menu_shell_append (GTK_MENU_SHELL (menu), mi);
613 g_type_class_unref (eclass);
615 gtk_option_menu_set_menu (GTK_OPTION_MENU (prop_edit), menu);
617 g_object_connect_property (object, spec->name,
618 G_CALLBACK (enum_changed),
619 prop_edit, G_OBJECT (prop_edit));
622 connect_controller (G_OBJECT (prop_edit), "changed",
623 object, spec->name, (GtkSignalFunc) enum_modified);
626 else if (type == G_TYPE_PARAM_UNICHAR)
628 prop_edit = gtk_entry_new ();
629 gtk_entry_set_max_length (GTK_ENTRY (prop_edit), 1);
631 g_object_connect_property (object, spec->name,
632 G_CALLBACK (unichar_changed),
633 prop_edit, G_OBJECT (prop_edit));
636 connect_controller (G_OBJECT (prop_edit), "changed",
637 object, spec->name, (GtkSignalFunc) unichar_modified);
639 else if (type == G_TYPE_PARAM_POINTER)
641 prop_edit = gtk_label_new ("");
643 g_object_connect_property (object, spec->name,
644 G_CALLBACK (pointer_changed),
645 prop_edit, G_OBJECT (prop_edit));
647 else if (type == G_TYPE_PARAM_OBJECT)
649 GtkWidget *label, *button;
651 prop_edit = gtk_hbox_new (FALSE, 5);
653 label = gtk_label_new ("");
654 button = gtk_button_new_with_label ("Properties");
655 g_object_set_data (G_OBJECT (button), "property-name", spec->name);
656 g_signal_connect (button, "clicked",
657 G_CALLBACK (object_properties),
660 gtk_container_add (GTK_CONTAINER (prop_edit), label);
661 gtk_container_add (GTK_CONTAINER (prop_edit), button);
663 g_object_connect_property (object, spec->name,
664 G_CALLBACK (object_changed),
665 prop_edit, G_OBJECT (label));
669 msg = g_strdup_printf ("uneditable property type: %s",
670 g_type_name (G_PARAM_SPEC_TYPE (spec)));
671 prop_edit = gtk_label_new (msg);
673 gtk_misc_set_alignment (GTK_MISC (prop_edit), 0.0, 0.5);
680 properties_from_type (GObject *object,
684 GtkWidget *prop_edit;
693 if (G_TYPE_IS_INTERFACE (type))
695 gpointer vtable = g_type_default_interface_peek (type);
696 specs = g_object_interface_list_properties (vtable, &n_specs);
700 GObjectClass *class = G_OBJECT_CLASS (g_type_class_peek (type));
701 specs = g_object_class_list_properties (class, &n_specs);
707 table = gtk_table_new (n_specs, 2, FALSE);
708 gtk_table_set_col_spacing (GTK_TABLE (table), 0, 10);
709 gtk_table_set_row_spacings (GTK_TABLE (table), 3);
714 GParamSpec *spec = specs[i];
719 can_modify = ((spec->flags & G_PARAM_WRITABLE) != 0 &&
720 (spec->flags & G_PARAM_CONSTRUCT_ONLY) == 0);
722 if ((spec->flags & G_PARAM_READABLE) == 0)
724 /* can't display unreadable properties */
729 if (spec->owner_type != type)
731 /* we're only interested in params of type */
736 label = gtk_label_new (g_param_spec_get_nick (spec));
737 gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
738 gtk_table_attach_defaults (GTK_TABLE (table), label, 0, 1, i, i + 1);
740 prop_edit = property_widget (object, spec, can_modify);
741 gtk_table_attach_defaults (GTK_TABLE (table), prop_edit, 1, 2, i, i + 1);
746 gtk_widget_set_sensitive (prop_edit, FALSE);
748 if (g_param_spec_get_blurb (spec))
749 gtk_tooltips_set_tip (tips, prop_edit, g_param_spec_get_blurb (spec), NULL);
751 /* set initial value */
752 g_object_notify (object, spec->name);
759 vbox = gtk_vbox_new (FALSE, 0);
760 gtk_box_pack_start (GTK_BOX (vbox), table, FALSE, FALSE, 0);
762 sw = gtk_scrolled_window_new (NULL, NULL);
763 gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (sw),
764 GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC);
766 gtk_scrolled_window_add_with_viewport (GTK_SCROLLED_WINDOW (sw), vbox);
774 /* Pass zero for type if you want all properties */
776 create_prop_editor (GObject *object,
782 GtkWidget *properties;
788 if ((win = g_object_get_data (G_OBJECT (object), "prop-editor-win")))
790 gtk_window_present (GTK_WINDOW (win));
794 win = gtk_window_new (GTK_WINDOW_TOPLEVEL);
795 if (GTK_IS_WIDGET (object))
796 gtk_window_set_screen (GTK_WINDOW (win),
797 gtk_widget_get_screen (GTK_WIDGET (object)));
799 tips = gtk_tooltips_new ();
800 g_signal_connect_swapped (win, "destroy",
801 G_CALLBACK (gtk_object_destroy), tips);
803 /* hold a weak ref to the object we're editing */
804 g_object_set_data_full (G_OBJECT (object), "prop-editor-win", win, model_destroy);
805 g_object_set_data_full (G_OBJECT (win), "model-object", object, window_destroy);
809 notebook = gtk_notebook_new ();
810 gtk_notebook_set_tab_pos (GTK_NOTEBOOK (notebook), GTK_POS_LEFT);
812 gtk_container_add (GTK_CONTAINER (win), notebook);
814 type = G_TYPE_FROM_INSTANCE (object);
816 title = g_strdup_printf ("Properties of %s widget", g_type_name (type));
817 gtk_window_set_title (GTK_WINDOW (win), title);
822 properties = properties_from_type (object, type, tips);
825 label = gtk_label_new (g_type_name (type));
826 gtk_notebook_append_page (GTK_NOTEBOOK (notebook),
830 type = g_type_parent (type);
833 ifaces = g_type_interfaces (G_TYPE_FROM_INSTANCE (object), &n_ifaces);
836 properties = properties_from_type (object, ifaces[n_ifaces], tips);
839 label = gtk_label_new (g_type_name (ifaces[n_ifaces]));
840 gtk_notebook_append_page (GTK_NOTEBOOK (notebook),
849 properties = properties_from_type (object, type, tips);
850 gtk_container_add (GTK_CONTAINER (win), properties);
851 title = g_strdup_printf ("Properties of %s", g_type_name (type));
852 gtk_window_set_title (GTK_WINDOW (win), title);
855 gtk_window_set_default_size (GTK_WINDOW (win), -1, 400);
857 gtk_widget_show_all (win);