atk/atksocket.c

   1 /* ATK -  Accessibility Toolkit
   2  * Copyright (C) 2009 Novell, Inc.
   3  *
   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.
   8  *
   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.
  13  *
  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.
  18  */
  19
  20 #include "atk.h"
  21 #include "atksocket.h"
  22
  23 /**
  24  * SECTION:atksocket
  25  * @Short_description: Container for AtkPlug objects from other processes
  26  * @Title: AtkSocket
  27  * @See_also: #AtkPlug
  28  *
  29  * Together with #AtkPlug, #AtkSocket provides the ability to embed
  30  * accessibles from one process into another in a fashion that is
  31  * transparent to assistive technologies. #AtkSocket works as the
  32  * container of #AtkPlug, embedding it using the method
  33  * atk_socket_embed(). Any accessible contained in the #AtkPlug will
  34  * appear to the assistive technologies as being inside the
  35  * application that created the #AtkSocket.
  36  *
  37  * The communication between a #AtkSocket and a #AtkPlug is done by
  38  * the IPC layer of the accessibility framework, normally implemented
  39  * by the D-Bus based implementation of AT-SPI (at-spi2). If that is
  40  * the case, at-spi-atk2 is the responsible to implement the abstract
  41  * methods atk_plug_get_id() and atk_socket_embed(), so an ATK
  42  * implementor shouldn't reimplement them. The process that contains
  43  * the #AtkPlug is responsible to send the ID returned by
  44  * atk_plug_id() to the process that contains the #AtkSocket, so it
  45  * could call the method atk_socket_embed() in order to embed it.
  46  *
  47  * For the same reasons, an implementor doesn't need to implement
  48  * atk_object_get_n_accessible_children() and
  49  * atk_object_ref_accessible_child(). All the logic related to those
  50  * functions will be implemented by the IPC layer.
  51  */
  52
  53 static void atk_socket_class_init (AtkSocketClass *klass);
  54 static void atk_socket_finalize   (GObject *obj);
  55
  56 static void atk_component_interface_init (AtkComponentIface *iface);
  57
  58 G_DEFINE_TYPE_WITH_CODE (AtkSocket, atk_socket, ATK_TYPE_OBJECT,
  59                          G_IMPLEMENT_INTERFACE (ATK_TYPE_COMPONENT, atk_component_interface_init))
  60
  61 static void
  62 atk_socket_init (AtkSocket* obj)
  63 {
  64   obj->embedded_plug_id = NULL;
  65 }
  66
  67 static void
  68 atk_socket_class_init (AtkSocketClass* klass)
  69 {
  70   GObjectClass *obj_class = G_OBJECT_CLASS (klass);
  71
  72   obj_class->finalize = atk_socket_finalize;
  73
  74   klass->embed = NULL;
  75 }
  76
  77 static void
  78 atk_socket_finalize (GObject *_obj)
  79 {
  80   AtkSocket *obj = ATK_SOCKET (_obj);
  81
  82   g_free (obj->embedded_plug_id);
  83   obj->embedded_plug_id = NULL;
  84
  85   G_OBJECT_CLASS (atk_socket_parent_class)->finalize (_obj);
  86 }
  87
  88 static void atk_component_interface_init (AtkComponentIface *iface)
  89 {
  90 }
  91
  92 AtkObject*
  93 atk_socket_new (void)
  94 {
  95   AtkObject* accessible;
  96
  97   accessible = g_object_new (ATK_TYPE_SOCKET, NULL);
  98   g_return_val_if_fail (accessible != NULL, NULL);
  99
 100   accessible->role = ATK_ROLE_FILLER;
 101   accessible->layer = ATK_LAYER_WIDGET;
 102
 103   return accessible;
 104 }
 105
 106 /**
 107  * atk_socket_embed:
 108  * @obj: an #AtkSocket
 109  * @plug_id: the ID of an #AtkPlug
 110  *
 111  * Embeds the children of an #AtkPlug as the children of the
 112  * #AtkSocket. The plug may be in the same process or in a different
 113  * process.
 114  *
 115  * The class item used by this function should be filled in by the IPC
 116  * layer (usually at-spi2-atk). The implementor of the AtkSocket
 117  * should call this function and pass the id for the plug as returned
 118  * by atk_plug_get_id().  It is the responsibility of the application
 119  * to pass the plug id on to the process implementing the #AtkSocket
 120  * as needed.
 121  *
 122  * Since: 1.30
 123  **/
 124 void
 125 atk_socket_embed (AtkSocket* obj, gchar* plug_id)
 126 {
 127   AtkSocketClass *klass;
 128
 129   g_return_if_fail (plug_id != NULL);
 130   g_return_if_fail (ATK_IS_SOCKET (obj));
 131
 132   klass = g_type_class_peek (ATK_TYPE_SOCKET);
 133   if (klass && klass->embed)
 134     {
 135       if (obj->embedded_plug_id)
 136         g_free (obj->embedded_plug_id);
 137       obj->embedded_plug_id = g_strdup (plug_id);
 138       (klass->embed) (obj, plug_id);
 139     }
 140 }
 141
 142 /**
 143  * atk_socket_is_occupied:
 144  * @obj: an #AtkSocket
 145  *
 146  * Determines whether or not the socket has an embedded plug.
 147  *
 148  * Returns: TRUE if a plug is embedded in the socket
 149  *
 150  * Since: 1.30
 151  **/
 152 gboolean
 153 atk_socket_is_occupied (AtkSocket* obj)
 154 {
 155   g_return_val_if_fail (ATK_IS_SOCKET (obj), FALSE);
 156
 157   return (obj->embedded_plug_id != NULL);
 158 }