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
50 static void gtk_accessible_real_connect_widget_destroyed (GtkAccessible *accessible);
52 G_DEFINE_TYPE (GtkAccessible, gtk_accessible, ATK_TYPE_OBJECT)
55 gtk_accessible_init (GtkAccessible *accessible)
57 accessible->priv = G_TYPE_INSTANCE_GET_PRIVATE (accessible,
59 GtkAccessiblePrivate);
63 gtk_accessible_class_init (GtkAccessibleClass *klass)
65 klass->connect_widget_destroyed = gtk_accessible_real_connect_widget_destroyed;
67 g_type_class_add_private (klass, sizeof (GtkAccessiblePrivate));
71 * gtk_accessible_set_widget:
72 * @accessible: a #GtkAccessible
73 * @widget: a #GtkWidget
75 * Sets the #GtkWidget corresponding to the #GtkAccessible.
80 gtk_accessible_set_widget (GtkAccessible *accessible,
83 g_return_if_fail (GTK_IS_ACCESSIBLE (accessible));
85 accessible->priv->widget = widget;
89 * gtk_accessible_get_widget:
90 * @accessible: a #GtkAccessible
92 * Gets the #GtkWidget corresponding to the #GtkAccessible.
93 * The returned widget does not have a reference added, so
94 * you do not need to unref it.
96 * Returns: (transfer none): pointer to the #GtkWidget
97 * corresponding to the #GtkAccessible, or %NULL.
102 gtk_accessible_get_widget (GtkAccessible *accessible)
104 g_return_val_if_fail (GTK_IS_ACCESSIBLE (accessible), NULL);
106 return accessible->priv->widget;
110 * gtk_accessible_connect_widget_destroyed:
111 * @accessible: a #GtkAccessible
113 * This function specifies the callback function to be called
114 * when the widget corresponding to a GtkAccessible is destroyed.
117 gtk_accessible_connect_widget_destroyed (GtkAccessible *accessible)
119 GtkAccessibleClass *class;
121 g_return_if_fail (GTK_IS_ACCESSIBLE (accessible));
123 class = GTK_ACCESSIBLE_GET_CLASS (accessible);
125 if (class->connect_widget_destroyed)
126 class->connect_widget_destroyed (accessible);
130 gtk_accessible_real_connect_widget_destroyed (GtkAccessible *accessible)
132 GtkAccessiblePrivate *priv = accessible->priv;
135 g_signal_connect (priv->widget, "destroy",
136 G_CALLBACK (gtk_widget_destroyed), &priv->widget);