gtk2/gtk/gtkaccessible.c
Matthias Clasen 3cc22eed44 Add some GtkAccessible documentation
Describe the current thinking about how to provide
3rd party accessible implementations.
2011-07-14 19:50:21 -04:00

138 lines
3.9 KiB
C

/* GTK - The GIMP Toolkit
* Copyright 2001 Sun Microsystems Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#include "config.h"
#include <string.h>
#include "gtkwidget.h"
#include "gtkintl.h"
#include "gtkaccessible.h"
/**
* SECTION:gtkaccessible
* @Short_description: Accessibility support for widgets
* @Title: GtkAccessible
*
* The #GtkAccessible class is the base class for accessible
* implementations for #GtkWidget subclasses. It is a thin
* wrapper around #AtkObject, which adds facilities for associating
* a widget with its accessible object.
*
* An accessible implementation for a third-party widget should
* derive from #GtkAccessible and implement the suitable interfaces
* from ATK, such as #AtkText or #AtkSelection. To establish
* the connection between the widget class and its corresponding
* acccessible implementation, override the get_accessible vfunc
* in #GtkWidgetClass.
*/
struct _GtkAccessiblePrivate
{
GtkWidget *widget;
};
static void gtk_accessible_real_connect_widget_destroyed (GtkAccessible *accessible);
G_DEFINE_TYPE (GtkAccessible, gtk_accessible, ATK_TYPE_OBJECT)
static void
gtk_accessible_init (GtkAccessible *accessible)
{
accessible->priv = G_TYPE_INSTANCE_GET_PRIVATE (accessible,
GTK_TYPE_ACCESSIBLE,
GtkAccessiblePrivate);
}
static void
gtk_accessible_class_init (GtkAccessibleClass *klass)
{
klass->connect_widget_destroyed = gtk_accessible_real_connect_widget_destroyed;
g_type_class_add_private (klass, sizeof (GtkAccessiblePrivate));
}
/**
* gtk_accessible_set_widget:
* @accessible: a #GtkAccessible
* @widget: a #GtkWidget
*
* Sets the #GtkWidget corresponding to the #GtkAccessible.
*
* Since: 2.22
*/
void
gtk_accessible_set_widget (GtkAccessible *accessible,
GtkWidget *widget)
{
g_return_if_fail (GTK_IS_ACCESSIBLE (accessible));
accessible->priv->widget = widget;
}
/**
* gtk_accessible_get_widget:
* @accessible: a #GtkAccessible
*
* Gets the #GtkWidget corresponding to the #GtkAccessible.
* The returned widget does not have a reference added, so
* you do not need to unref it.
*
* Returns: (transfer none): pointer to the #GtkWidget
* corresponding to the #GtkAccessible, or %NULL.
*
* Since: 2.22
*/
GtkWidget*
gtk_accessible_get_widget (GtkAccessible *accessible)
{
g_return_val_if_fail (GTK_IS_ACCESSIBLE (accessible), NULL);
return accessible->priv->widget;
}
/**
* gtk_accessible_connect_widget_destroyed:
* @accessible: a #GtkAccessible
*
* This function specifies the callback function to be called
* when the widget corresponding to a GtkAccessible is destroyed.
*/
void
gtk_accessible_connect_widget_destroyed (GtkAccessible *accessible)
{
GtkAccessibleClass *class;
g_return_if_fail (GTK_IS_ACCESSIBLE (accessible));
class = GTK_ACCESSIBLE_GET_CLASS (accessible);
if (class->connect_widget_destroyed)
class->connect_widget_destroyed (accessible);
}
static void
gtk_accessible_real_connect_widget_destroyed (GtkAccessible *accessible)
{
GtkAccessiblePrivate *priv = accessible->priv;
if (priv->widget)
g_signal_connect (priv->widget, "destroy",
G_CALLBACK (gtk_widget_destroyed), &priv->widget);
}