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.
24 #include "prop-editor.h"
27 get_param_specs (GType type,
31 GObjectClass *class = g_type_class_peek (type);
33 /* We count on the fact we have an instance, or else we'd have
34 * to use g_type_class_ref ();
37 /* Use private interface for now, fix later */
38 *specs = NULL; /* class->property_specs; */
39 *n_specs = 0; /* class->n_property_specs; */
45 GObject *alive_object;
50 disconnect_func (gpointer data)
52 DisconnectData *dd = data;
54 g_signal_handler_disconnect (dd->instance, dd->id);
58 signal_removed (gpointer data,
61 DisconnectData *dd = data;
63 g_object_steal_data (dd->alive_object, "alive-object-data");
68 g_object_connect_property (GObject *object,
69 const gchar *prop_name,
72 GObject *alive_object)
75 gchar *with_detail = g_strconcat ("notify::", prop_name, NULL);
78 dd = g_new (DisconnectData, 1);
80 closure = g_cclosure_new (func, data, NULL);
82 g_closure_add_invalidate_notifier (closure, dd, signal_removed);
84 dd->id = g_signal_connect_closure (object, with_detail,
87 dd->instance = object;
88 dd->alive_object = alive_object;
90 g_object_set_data_full (G_OBJECT (alive_object),
106 free_object_property (ObjectProperty *p)
113 connect_controller (GObject *controller,
116 const gchar *prop_name,
121 p = g_new (ObjectProperty, 1);
123 p->prop = g_strdup (prop_name);
125 p->modified_id = g_signal_connect_data (controller, signal, func, p,
126 (GClosureNotify)free_object_property,
128 g_object_set_data (controller, "object-property", p);
132 block_controller (GObject *controller)
134 ObjectProperty *p = g_object_get_data (controller, "object-property");
137 g_signal_handler_block (controller, p->modified_id);
141 unblock_controller (GObject *controller)
143 ObjectProperty *p = g_object_get_data (controller, "object-property");
146 g_signal_handler_unblock (controller, p->modified_id);
150 int_modified (GtkAdjustment *adj, gpointer data)
152 ObjectProperty *p = data;
154 g_object_set (p->obj, p->prop, (int) adj->value, NULL);
158 int_changed (GObject *object, GParamSpec *pspec, gpointer data)
160 GtkAdjustment *adj = GTK_ADJUSTMENT (data);
163 g_value_init (&val, G_TYPE_INT);
164 g_object_get_property (object, pspec->name, &val);
166 if (g_value_get_int (&val) != (int)adj->value)
168 block_controller (G_OBJECT (adj));
169 gtk_adjustment_set_value (adj, g_value_get_int (&val));
170 unblock_controller (G_OBJECT (adj));
173 g_value_unset (&val);
177 uint_modified (GtkAdjustment *adj, gpointer data)
179 ObjectProperty *p = data;
181 g_object_set (p->obj, p->prop, (guint) adj->value, NULL);
185 uint_changed (GObject *object, GParamSpec *pspec, gpointer data)
187 GtkAdjustment *adj = GTK_ADJUSTMENT (data);
190 g_value_init (&val, G_TYPE_UINT);
191 g_object_get_property (object, pspec->name, &val);
193 if (g_value_get_uint (&val) != (guint)adj->value)
195 block_controller (G_OBJECT (adj));
196 gtk_adjustment_set_value (adj, g_value_get_uint (&val));
197 unblock_controller (G_OBJECT (adj));
200 g_value_unset (&val);
204 float_modified (GtkAdjustment *adj, gpointer data)
206 ObjectProperty *p = data;
208 g_object_set (p->obj, p->prop, (float) adj->value, NULL);
212 float_changed (GObject *object, GParamSpec *pspec, gpointer data)
214 GtkAdjustment *adj = GTK_ADJUSTMENT (data);
217 g_value_init (&val, G_TYPE_FLOAT);
218 g_object_get_property (object, pspec->name, &val);
220 if (g_value_get_float (&val) != (float) adj->value)
222 block_controller (G_OBJECT (adj));
223 gtk_adjustment_set_value (adj, g_value_get_float (&val));
224 unblock_controller (G_OBJECT (adj));
227 g_value_unset (&val);
231 double_modified (GtkAdjustment *adj, gpointer data)
233 ObjectProperty *p = data;
235 g_object_set (p->obj, p->prop, (double) adj->value, NULL);
239 double_changed (GObject *object, GParamSpec *pspec, gpointer data)
241 GtkAdjustment *adj = GTK_ADJUSTMENT (data);
244 g_value_init (&val, G_TYPE_DOUBLE);
245 g_object_get_property (object, pspec->name, &val);
247 if (g_value_get_double (&val) != adj->value)
249 block_controller (G_OBJECT (adj));
250 gtk_adjustment_set_value (adj, g_value_get_double (&val));
251 unblock_controller (G_OBJECT (adj));
254 g_value_unset (&val);
258 string_modified (GtkEntry *entry, gpointer data)
260 ObjectProperty *p = data;
263 text = gtk_entry_get_text (entry);
265 g_object_set (p->obj, p->prop, text, NULL);
269 string_changed (GObject *object, GParamSpec *pspec, gpointer data)
271 GtkEntry *entry = GTK_ENTRY (data);
276 g_value_init (&val, G_TYPE_STRING);
277 g_object_get_property (object, pspec->name, &val);
279 str = g_value_get_string (&val);
282 text = gtk_entry_get_text (entry);
284 if (strcmp (str, text) != 0)
286 block_controller (G_OBJECT (entry));
287 gtk_entry_set_text (entry, str);
288 unblock_controller (G_OBJECT (entry));
291 g_value_unset (&val);
295 bool_modified (GtkToggleButton *tb, gpointer data)
297 ObjectProperty *p = data;
299 g_object_set (p->obj, p->prop, (int) tb->active, NULL);
303 bool_changed (GObject *object, GParamSpec *pspec, gpointer data)
305 GtkToggleButton *tb = GTK_TOGGLE_BUTTON (data);
308 g_value_init (&val, G_TYPE_BOOLEAN);
309 g_object_get_property (object, pspec->name, &val);
311 if (g_value_get_boolean (&val) != tb->active)
313 block_controller (G_OBJECT (tb));
314 gtk_toggle_button_set_active (tb, g_value_get_boolean (&val));
315 unblock_controller (G_OBJECT (tb));
318 gtk_label_set_text (GTK_LABEL (GTK_BIN (tb)->child), g_value_get_boolean (&val) ?
321 g_value_unset (&val);
326 enum_modified (GtkOptionMenu *om, gpointer data)
328 ObjectProperty *p = data;
333 spec = g_object_class_find_property (G_OBJECT_GET_CLASS (p->obj),
336 eclass = G_ENUM_CLASS (g_type_class_peek (spec->value_type));
338 i = gtk_option_menu_get_history (om);
340 g_object_set (p->obj, p->prop, eclass->values[i].value, NULL);
344 enum_changed (GObject *object, GParamSpec *pspec, gpointer data)
346 GtkOptionMenu *om = GTK_OPTION_MENU (data);
351 eclass = G_ENUM_CLASS (g_type_class_peek (pspec->value_type));
353 g_value_init (&val, pspec->value_type);
354 g_object_get_property (object, pspec->name, &val);
357 while (i < eclass->n_values)
359 if (eclass->values[i].value == g_value_get_enum (&val))
364 if (gtk_option_menu_get_history (om) != i)
366 block_controller (G_OBJECT (om));
367 gtk_option_menu_set_history (om, i);
368 unblock_controller (G_OBJECT (om));
371 g_value_unset (&val);
376 unichar_get_value (GtkEntry *entry)
378 const gchar *text = gtk_entry_get_text (entry);
381 return g_utf8_get_char (text);
387 unichar_modified (GtkEntry *entry, gpointer data)
389 ObjectProperty *p = data;
390 gunichar val = unichar_get_value (entry);
392 g_object_set (p->obj, p->prop, val, NULL);
396 unichar_changed (GObject *object, GParamSpec *pspec, gpointer data)
398 GtkEntry *entry = GTK_ENTRY (data);
400 gunichar old_val = unichar_get_value (entry);
404 g_object_get (object, pspec->name, &new_val, NULL);
406 if (new_val != old_val)
411 len = g_unichar_to_utf8 (new_val, buf);
415 block_controller (G_OBJECT (entry));
416 gtk_entry_set_text (entry, buf);
417 unblock_controller (G_OBJECT (entry));
422 pointer_changed (GObject *object, GParamSpec *pspec, gpointer data)
424 GtkLabel *label = GTK_LABEL (data);
428 g_object_get (object, pspec->name, &ptr, NULL);
430 str = g_strdup_printf ("Pointer: %p", ptr);
431 gtk_label_set_text (label, str);
436 object_changed (GObject *object, GParamSpec *pspec, gpointer data)
438 GtkLabel *label = GTK_LABEL (data);
443 g_object_get (object, pspec->name, &obj, NULL);
446 name = g_type_name (G_TYPE_FROM_INSTANCE (obj));
449 str = g_strdup_printf ("Objetct: %p (%s)", obj, name);
451 gtk_label_set_text (label, str);
456 model_destroy (gpointer data)
458 g_object_steal_data (data, "model-object");
459 gtk_widget_destroy (data);
463 window_destroy (gpointer data)
465 g_object_steal_data (data, "prop-editor-win");
469 property_widget (GObject *object, GParamSpec *spec, gboolean can_modify)
471 GtkWidget *prop_edit;
475 switch (G_PARAM_SPEC_TYPE (spec))
477 case G_TYPE_PARAM_INT:
478 adj = GTK_ADJUSTMENT (gtk_adjustment_new (G_PARAM_SPEC_INT (spec)->default_value,
479 G_PARAM_SPEC_INT (spec)->minimum,
480 G_PARAM_SPEC_INT (spec)->maximum,
482 MAX ((G_PARAM_SPEC_INT (spec)->maximum -
483 G_PARAM_SPEC_INT (spec)->minimum) / 10, 1),
486 prop_edit = gtk_spin_button_new (adj, 1.0, 0);
488 g_object_connect_property (object, spec->name,
489 GTK_SIGNAL_FUNC (int_changed),
490 adj, G_OBJECT (adj));
493 connect_controller (G_OBJECT (adj), "value_changed",
494 object, spec->name, (GtkSignalFunc) int_modified);
497 case G_TYPE_PARAM_UINT:
498 adj = GTK_ADJUSTMENT (
499 gtk_adjustment_new (G_PARAM_SPEC_UINT (spec)->default_value,
500 G_PARAM_SPEC_UINT (spec)->minimum,
501 G_PARAM_SPEC_UINT (spec)->maximum,
503 MAX ((G_PARAM_SPEC_UINT (spec)->maximum -
504 G_PARAM_SPEC_UINT (spec)->minimum) / 10, 1),
507 prop_edit = gtk_spin_button_new (adj, 1.0, 0);
509 g_object_connect_property (object, spec->name,
510 GTK_SIGNAL_FUNC (uint_changed),
511 adj, G_OBJECT (adj));
514 connect_controller (G_OBJECT (adj), "value_changed",
515 object, spec->name, (GtkSignalFunc) uint_modified);
518 case G_TYPE_PARAM_FLOAT:
519 adj = GTK_ADJUSTMENT (gtk_adjustment_new (G_PARAM_SPEC_FLOAT (spec)->default_value,
520 G_PARAM_SPEC_FLOAT (spec)->minimum,
521 G_PARAM_SPEC_FLOAT (spec)->maximum,
523 MAX ((G_PARAM_SPEC_FLOAT (spec)->maximum -
524 G_PARAM_SPEC_FLOAT (spec)->minimum) / 10, 0.1),
527 prop_edit = gtk_spin_button_new (adj, 0.1, 2);
529 g_object_connect_property (object, spec->name,
530 GTK_SIGNAL_FUNC (float_changed),
531 adj, G_OBJECT (adj));
534 connect_controller (G_OBJECT (adj), "value_changed",
535 object, spec->name, (GtkSignalFunc) float_modified);
538 case G_TYPE_PARAM_DOUBLE:
539 adj = GTK_ADJUSTMENT (gtk_adjustment_new (G_PARAM_SPEC_DOUBLE (spec)->default_value,
540 G_PARAM_SPEC_DOUBLE (spec)->minimum,
541 G_PARAM_SPEC_DOUBLE (spec)->maximum,
543 MAX ((G_PARAM_SPEC_DOUBLE (spec)->maximum -
544 G_PARAM_SPEC_DOUBLE (spec)->minimum) / 10, 0.1),
547 prop_edit = gtk_spin_button_new (adj, 0.1, 2);
549 g_object_connect_property (object, spec->name,
550 GTK_SIGNAL_FUNC (double_changed),
551 adj, G_OBJECT (adj));
554 connect_controller (G_OBJECT (adj), "value_changed",
555 object, spec->name, (GtkSignalFunc) double_modified);
558 case G_TYPE_PARAM_STRING:
559 prop_edit = gtk_entry_new ();
561 g_object_connect_property (object, spec->name,
562 GTK_SIGNAL_FUNC (string_changed),
563 prop_edit, G_OBJECT (prop_edit));
566 connect_controller (G_OBJECT (prop_edit), "changed",
567 object, spec->name, (GtkSignalFunc) string_modified);
570 case G_TYPE_PARAM_BOOLEAN:
571 prop_edit = gtk_toggle_button_new_with_label ("");
573 g_object_connect_property (object, spec->name,
574 GTK_SIGNAL_FUNC (bool_changed),
575 prop_edit, G_OBJECT (prop_edit));
578 connect_controller (G_OBJECT (prop_edit), "toggled",
579 object, spec->name, (GtkSignalFunc) bool_modified);
582 case G_TYPE_PARAM_ENUM:
588 prop_edit = gtk_option_menu_new ();
590 menu = gtk_menu_new ();
592 eclass = G_ENUM_CLASS (g_type_class_ref (spec->value_type));
595 while (j < eclass->n_values)
599 mi = gtk_menu_item_new_with_label (eclass->values[j].value_name);
601 gtk_widget_show (mi);
603 gtk_menu_shell_append (GTK_MENU_SHELL (menu), mi);
608 g_type_class_unref (eclass);
610 gtk_option_menu_set_menu (GTK_OPTION_MENU (prop_edit), menu);
612 g_object_connect_property (object, spec->name,
613 GTK_SIGNAL_FUNC (enum_changed),
614 prop_edit, G_OBJECT (prop_edit));
617 connect_controller (G_OBJECT (prop_edit), "changed",
618 object, spec->name, (GtkSignalFunc) enum_modified);
622 case G_TYPE_PARAM_UNICHAR:
623 prop_edit = gtk_entry_new ();
624 gtk_entry_set_max_length (GTK_ENTRY (prop_edit), 1);
626 g_object_connect_property (object, spec->name,
627 GTK_SIGNAL_FUNC (unichar_changed),
628 prop_edit, G_OBJECT (prop_edit));
631 connect_controller (G_OBJECT (prop_edit), "changed",
632 object, spec->name, (GtkSignalFunc) unichar_modified);
635 case G_TYPE_PARAM_POINTER:
636 prop_edit = gtk_label_new ("");
638 g_object_connect_property (object, spec->name,
639 GTK_SIGNAL_FUNC (pointer_changed),
640 prop_edit, G_OBJECT (prop_edit));
643 case G_TYPE_PARAM_OBJECT:
644 prop_edit = gtk_label_new ("");
646 g_object_connect_property (object, spec->name,
647 GTK_SIGNAL_FUNC (object_changed),
648 prop_edit, G_OBJECT (prop_edit));
653 msg = g_strdup_printf ("uneditable property type: %s",
654 g_type_name (G_PARAM_SPEC_TYPE (spec)));
655 prop_edit = gtk_label_new (msg);
657 gtk_misc_set_alignment (GTK_MISC (prop_edit), 0.0, 0.5);
664 properties_from_type (GObject *object,
668 GtkWidget *prop_edit;
675 GParamSpec **specs = NULL;
677 get_param_specs (type, &specs, &n_specs);
682 table = gtk_table_new (n_specs, 2, FALSE);
683 gtk_table_set_col_spacing (GTK_TABLE (table), 0, 10);
684 gtk_table_set_row_spacings (GTK_TABLE (table), 3);
689 GParamSpec *spec = specs[i];
694 can_modify = ((spec->flags & G_PARAM_WRITABLE) != 0 &&
695 (spec->flags & G_PARAM_CONSTRUCT_ONLY) == 0);
697 if ((spec->flags & G_PARAM_READABLE) == 0)
699 /* can't display unreadable properties */
704 label = gtk_label_new (spec->nick);
705 gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
706 gtk_table_attach_defaults (GTK_TABLE (table), label, 0, 1, i, i + 1);
708 prop_edit = property_widget (object, spec, can_modify);
709 gtk_table_attach_defaults (GTK_TABLE (table), prop_edit, 1, 2, i, i + 1);
714 gtk_widget_set_sensitive (prop_edit, FALSE);
717 gtk_tooltips_set_tip (tips, prop_edit, spec->blurb, NULL);
719 /* set initial value */
720 g_object_notify (object, spec->name);
727 vbox = gtk_vbox_new (FALSE, 0);
728 gtk_box_pack_start (GTK_BOX (vbox), table, FALSE, FALSE, 0);
730 sw = gtk_scrolled_window_new (NULL, NULL);
731 gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (sw),
732 GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC);
734 gtk_scrolled_window_add_with_viewport (GTK_SCROLLED_WINDOW (sw), vbox);
739 /* Pass zero for type if you want all properties */
741 create_prop_editor (GObject *object, GType type)
746 GtkWidget *properties;
750 if ((win = g_object_get_data (G_OBJECT (object), "prop-editor-win")))
752 gtk_window_present (GTK_WINDOW (win));
756 win = gtk_window_new (GTK_WINDOW_TOPLEVEL);
758 tips = gtk_tooltips_new ();
759 gtk_signal_connect_object (GTK_OBJECT (win), "destroy",
760 GTK_SIGNAL_FUNC (gtk_object_destroy), GTK_OBJECT (tips));
762 /* hold a weak ref to the object we're editing */
763 g_object_set_data_full (G_OBJECT (object), "prop-editor-win", win, model_destroy);
764 g_object_set_data_full (G_OBJECT (win), "model-object", object, window_destroy);
768 notebook = gtk_notebook_new ();
769 gtk_notebook_set_tab_pos (GTK_NOTEBOOK (notebook), GTK_POS_LEFT);
771 gtk_container_add (GTK_CONTAINER (win), notebook);
773 type = G_TYPE_FROM_INSTANCE (object);
775 title = g_strdup_printf ("Properties of %s widget", g_type_name (type));
776 gtk_window_set_title (GTK_WINDOW (win), title);
781 properties = properties_from_type (object, type, tips);
784 label = gtk_label_new (g_type_name (type));
785 gtk_notebook_append_page (GTK_NOTEBOOK (notebook),
789 type = g_type_parent (type);
794 properties = properties_from_type (object, type, tips);
795 gtk_container_add (GTK_CONTAINER (win), properties);
796 title = g_strdup_printf ("Properties of %s", g_type_name (type));
797 gtk_window_set_title (GTK_WINDOW (win), title);
800 gtk_window_set_default_size (GTK_WINDOW (win), -1, 400);
802 gtk_widget_show_all (win);