1 /* GTK - The GIMP Toolkit
2 * Copyright 2001 Sun Microsystems Inc.
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.
23 #include "gtkwidget.h"
25 #include "gtkaccessible.h"
28 * SECTION:gtkaccessible
29 * @Short_description: Accessibility support for widgets
30 * @Title: GtkAccessible
32 * The #GtkAccessible class is the base class for accessible
33 * implementations for #GtkWidget subclasses. It is a thin
34 * wrapper around #AtkObject, which adds facilities for associating
35 * a widget with its accessible object.
37 * An accessible implementation for a third-party widget should
38 * derive from #GtkAccessible and implement the suitable interfaces
39 * from ATK, such as #AtkText or #AtkSelection. To establish
40 * the connection between the widget class and its corresponding
41 * acccessible implementation, override the get_accessible vfunc
45 struct _GtkAccessiblePrivate
55 static void gtk_accessible_real_connect_widget_destroyed (GtkAccessible *accessible);
57 G_DEFINE_TYPE (GtkAccessible, gtk_accessible, ATK_TYPE_OBJECT)
60 gtk_accessible_set_property (GObject *object,
65 GtkAccessible *accessible = GTK_ACCESSIBLE (object);
70 gtk_accessible_set_widget (accessible, g_value_get_object (value));
73 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
79 gtk_accessible_get_property (GObject *object,
84 GtkAccessible *accessible = GTK_ACCESSIBLE (object);
85 GtkAccessiblePrivate *priv = accessible->priv;
90 g_value_set_object (value, priv->widget);
93 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
99 gtk_accessible_init (GtkAccessible *accessible)
101 accessible->priv = G_TYPE_INSTANCE_GET_PRIVATE (accessible,
103 GtkAccessiblePrivate);
107 gtk_accessible_ref_state_set (AtkObject *object)
109 GtkAccessible *accessible = GTK_ACCESSIBLE (object);
110 AtkStateSet *state_set;
112 state_set = ATK_OBJECT_CLASS (gtk_accessible_parent_class)->ref_state_set (object);
114 if (accessible->priv->widget == NULL)
115 atk_state_set_add_state (state_set, ATK_STATE_DEFUNCT);
121 gtk_accessible_real_widget_set (GtkAccessible *accessible)
123 atk_object_notify_state_change (ATK_OBJECT (accessible), ATK_STATE_DEFUNCT, FALSE);
127 gtk_accessible_real_widget_unset (GtkAccessible *accessible)
129 atk_object_notify_state_change (ATK_OBJECT (accessible), ATK_STATE_DEFUNCT, TRUE);
133 gtk_accessible_finalize (GObject *object)
135 GtkAccessible *accessible = GTK_ACCESSIBLE (object);
137 gtk_accessible_set_widget (accessible, NULL);
139 G_OBJECT_CLASS (gtk_accessible_parent_class)->finalize (object);
143 gtk_accessible_class_init (GtkAccessibleClass *klass)
145 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
146 AtkObjectClass *atkobject_class = ATK_OBJECT_CLASS (klass);
148 klass->connect_widget_destroyed = gtk_accessible_real_connect_widget_destroyed;
149 klass->widget_set = gtk_accessible_real_widget_set;
150 klass->widget_unset = gtk_accessible_real_widget_unset;
152 atkobject_class->ref_state_set = gtk_accessible_ref_state_set;
153 gobject_class->get_property = gtk_accessible_get_property;
154 gobject_class->set_property = gtk_accessible_set_property;
155 gobject_class->finalize = gtk_accessible_finalize;
157 g_object_class_install_property (gobject_class,
159 g_param_spec_object ("widget",
161 P_("The widget referenced by this accessible."),
165 g_type_class_add_private (klass, sizeof (GtkAccessiblePrivate));
169 * gtk_accessible_set_widget:
170 * @accessible: a #GtkAccessible
171 * @widget: (allow-none): a #GtkWidget or %NULL to unset
173 * Sets the #GtkWidget corresponding to the #GtkAccessible.
175 * <note><para>@accessible will not hold a reference to @widget.
176 * It is the caller's responsibility to ensure that when @widget
177 * is destroyed, the widget is unset by calling this function
178 * again with @widget set to %NULL.</para></note>
182 gtk_accessible_set_widget (GtkAccessible *accessible,
185 GtkAccessiblePrivate *priv;
186 GtkAccessibleClass *klass;
188 g_return_if_fail (GTK_IS_ACCESSIBLE (accessible));
190 priv = accessible->priv;
191 klass = GTK_ACCESSIBLE_GET_CLASS (accessible);
193 if (priv->widget == widget)
197 klass->widget_unset (accessible);
199 priv->widget = widget;
202 klass->widget_set (accessible);
204 g_object_notify (G_OBJECT (accessible), "widget");
208 * gtk_accessible_get_widget:
209 * @accessible: a #GtkAccessible
211 * Gets the #GtkWidget corresponding to the #GtkAccessible.
212 * The returned widget does not have a reference added, so
213 * you do not need to unref it.
215 * Returns: (transfer none): pointer to the #GtkWidget
216 * corresponding to the #GtkAccessible, or %NULL.
221 gtk_accessible_get_widget (GtkAccessible *accessible)
223 g_return_val_if_fail (GTK_IS_ACCESSIBLE (accessible), NULL);
225 return accessible->priv->widget;
229 * gtk_accessible_connect_widget_destroyed:
230 * @accessible: a #GtkAccessible
232 * This function specifies the callback function to be called
233 * when the widget corresponding to a GtkAccessible is destroyed.
235 * Deprecated: 3.4: Use gtk_accessible_set_widget() and its vfuncs.
238 gtk_accessible_connect_widget_destroyed (GtkAccessible *accessible)
240 GtkAccessibleClass *class;
242 g_return_if_fail (GTK_IS_ACCESSIBLE (accessible));
244 class = GTK_ACCESSIBLE_GET_CLASS (accessible);
246 if (class->connect_widget_destroyed)
247 class->connect_widget_destroyed (accessible);
251 gtk_accessible_widget_destroyed (GtkWidget *widget,
252 GtkAccessible *accessible)
254 gtk_accessible_set_widget (accessible, NULL);
258 gtk_accessible_real_connect_widget_destroyed (GtkAccessible *accessible)
260 GtkAccessiblePrivate *priv = accessible->priv;
263 g_signal_connect (priv->widget, "destroy",
264 G_CALLBACK (gtk_accessible_widget_destroyed), accessible);