]> Pileus Git - ~andy/gtk/blobdiff - gtk/gtkaccessible.c
label: refactor code
[~andy/gtk] / gtk / gtkaccessible.c
index d5a96b2367a1fab0fb859f356b8d32911640f55f..27d88ca00ea35b178118fdd8dd0cf5eefba11e27 100644 (file)
  * 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.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include "config.h"
 #include <string.h>
-#include <gtk/gtkwidget.h>
-#include <gtk/gtksignal.h>
-#include <gtk/gtkaccessible.h>
 
-static void gtk_accessible_class_init (GtkAccessibleClass *klass);
+#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;
+};
+
+enum {
+  PROP_0,
+  PROP_WIDGET
+};
 
 static void gtk_accessible_real_connect_widget_destroyed (GtkAccessible *accessible);
 
-GtkType
-gtk_accessible_get_type (void)
+G_DEFINE_TYPE (GtkAccessible, gtk_accessible, ATK_TYPE_OBJECT)
+
+static void
+gtk_accessible_set_property (GObject      *object,
+                             guint         prop_id,
+                             const GValue *value,
+                             GParamSpec   *pspec)
 {
-  static GtkType accessible_type = 0;
+  GtkAccessible *accessible = GTK_ACCESSIBLE (object);
 
-  if (!accessible_type)
+  switch (prop_id)
     {
-      static const GTypeInfo accessible_info =
-      {
-       sizeof (GtkAccessibleClass),
-       NULL,           /* base_init */
-       NULL,           /* base_finalize */
-       (GClassInitFunc) gtk_accessible_class_init,
-       NULL,           /* class_finalize */
-       NULL,           /* class_data */
-       sizeof (GtkAccessible),
-       16,             /* n_preallocs */
-       (GInstanceInitFunc) NULL,
-      };
-
-      accessible_type = g_type_register_static (ATK_TYPE_OBJECT, "GtkAccessible", &accessible_info, 0);
+    case PROP_WIDGET:
+      gtk_accessible_set_widget (accessible, g_value_get_object (value));
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+      break;
     }
+}
+
+static void
+gtk_accessible_get_property (GObject    *object,
+                             guint       prop_id,
+                             GValue     *value,
+                             GParamSpec *pspec)
+{
+  GtkAccessible *accessible = GTK_ACCESSIBLE (object);
+  GtkAccessiblePrivate *priv = accessible->priv;
+
+  switch (prop_id)
+    {
+    case PROP_WIDGET:
+      g_value_set_object (value, priv->widget);
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+      break;
+    }
+}
+
+static void
+gtk_accessible_init (GtkAccessible *accessible)
+{
+  accessible->priv = G_TYPE_INSTANCE_GET_PRIVATE (accessible,
+                                                  GTK_TYPE_ACCESSIBLE,
+                                                  GtkAccessiblePrivate);
+}
+
+static AtkStateSet *
+gtk_accessible_ref_state_set (AtkObject *object)
+{
+  GtkAccessible *accessible = GTK_ACCESSIBLE (object);
+  AtkStateSet *state_set;
 
-  return accessible_type;
+  state_set = ATK_OBJECT_CLASS (gtk_accessible_parent_class)->ref_state_set (object);
+
+  if (accessible->priv->widget == NULL)
+    atk_state_set_add_state (state_set, ATK_STATE_DEFUNCT);
+
+  return state_set;
+}
+
+static void
+gtk_accessible_real_widget_set (GtkAccessible *accessible)
+{
+  atk_object_notify_state_change (ATK_OBJECT (accessible), ATK_STATE_DEFUNCT, FALSE);
+}
+
+static void
+gtk_accessible_real_widget_unset (GtkAccessible *accessible)
+{
+  atk_object_notify_state_change (ATK_OBJECT (accessible), ATK_STATE_DEFUNCT, TRUE);
+}
+
+static void
+gtk_accessible_dispose (GObject *object)
+{
+  GtkAccessible *accessible = GTK_ACCESSIBLE (object);
+  
+  gtk_accessible_set_widget (accessible, NULL);
+
+  G_OBJECT_CLASS (gtk_accessible_parent_class)->dispose (object);
 }
 
 static void
 gtk_accessible_class_init (GtkAccessibleClass *klass)
 {
+  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
+  AtkObjectClass *atkobject_class = ATK_OBJECT_CLASS (klass);
+
   klass->connect_widget_destroyed = gtk_accessible_real_connect_widget_destroyed;
+  klass->widget_set = gtk_accessible_real_widget_set;
+  klass->widget_unset = gtk_accessible_real_widget_unset;
+
+  atkobject_class->ref_state_set = gtk_accessible_ref_state_set;
+  gobject_class->get_property = gtk_accessible_get_property;
+  gobject_class->set_property = gtk_accessible_set_property;
+  gobject_class->dispose = gtk_accessible_dispose;
 
+  g_object_class_install_property (gobject_class,
+                                  PROP_WIDGET,
+                                  g_param_spec_object ("widget",
+                                                       P_("Widget"),
+                                                       P_("The widget referenced by this accessible."),
+                                                       GTK_TYPE_WIDGET,
+                                                       G_PARAM_READWRITE));
+
+  g_type_class_add_private (klass, sizeof (GtkAccessiblePrivate));
 }
 
 /**
- * gtk_accessible_connect_widget_destroyed
+ * gtk_accessible_set_widget:
  * @accessible: a #GtkAccessible
+ * @widget: (allow-none): a #GtkWidget or %NULL to unset
+ *
+ * Sets the #GtkWidget corresponding to the #GtkAccessible.
  *
- * This function specifies the callback function to be called when the widget
- * corresponding to a GtkAccessible is destroyed.
+ * <note><para>@accessible will not hold a reference to @widget.
+ * It is the caller's responsibility to ensure that when @widget
+ * is destroyed, the widget is unset by calling this function
+ * again with @widget set to %NULL.</para></note>
+ * Since: 2.22
+ */
+void
+gtk_accessible_set_widget (GtkAccessible *accessible,
+                           GtkWidget     *widget)
+{
+  GtkAccessiblePrivate *priv;
+  GtkAccessibleClass *klass;
+
+  g_return_if_fail (GTK_IS_ACCESSIBLE (accessible));
+
+  priv = accessible->priv;
+  klass = GTK_ACCESSIBLE_GET_CLASS (accessible);
+
+  if (priv->widget == widget)
+    return;
+
+  if (priv->widget)
+    klass->widget_unset (accessible);
+
+  priv->widget = widget;
+
+  if (widget)
+    klass->widget_set (accessible);
+
+  g_object_notify (G_OBJECT (accessible), "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.
+ *
+ * Deprecated: 3.4: Use gtk_accessible_set_widget() and its vfuncs.
  */
 void
 gtk_accessible_connect_widget_destroyed (GtkAccessible *accessible)
 {
   GtkAccessibleClass *class;
 
-  g_return_if_fail (accessible != NULL);
   g_return_if_fail (GTK_IS_ACCESSIBLE (accessible));
 
   class = GTK_ACCESSIBLE_GET_CLASS (accessible);
@@ -80,14 +245,19 @@ gtk_accessible_connect_widget_destroyed (GtkAccessible *accessible)
     class->connect_widget_destroyed (accessible);
 }
 
+static void
+gtk_accessible_widget_destroyed (GtkWidget     *widget,
+                                 GtkAccessible *accessible)
+{
+  gtk_accessible_set_widget (accessible, NULL);
+}
+
 static void
 gtk_accessible_real_connect_widget_destroyed (GtkAccessible *accessible)
 {
-  if (accessible->widget)
-  {
-    gtk_signal_connect (GTK_OBJECT (accessible->widget),
-                        "destroy",
-                        GTK_SIGNAL_FUNC (gtk_widget_destroyed),
-                        &accessible->widget);
-  }
+  GtkAccessiblePrivate *priv = accessible->priv;
+
+  if (priv->widget)
+    g_signal_connect (priv->widget, "destroy",
+                      G_CALLBACK (gtk_accessible_widget_destroyed), accessible);
 }