atk/atkplug.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 "config.h"
  21
  22 #include "atk.h"
  23 #include "atkplug.h"
  24
  25 /**
  26  * SECTION:atkplug
  27  * @Short_description: Toplevel for embedding into other processes
  28  * @Title: AtkPlug
  29  * @See_also: #AtkPlug
  30  *
  31  * See #AtkSocket
  32  *
  33  */
  34
  35 static void atk_component_interface_init (AtkComponentIface *iface);
  36
  37 typedef struct {
  38   AtkObject *child;
  39 } AtkPlugPrivate;
  40
  41 static gint AtkPlug_private_offset;
  42
  43 G_DEFINE_TYPE_WITH_CODE (AtkPlug, atk_plug, ATK_TYPE_OBJECT,
  44                          G_IMPLEMENT_INTERFACE (ATK_TYPE_COMPONENT, atk_component_interface_init)
  45                          G_ADD_PRIVATE(AtkPlug))
  46
  47 static AtkObject*
  48 atk_plug_ref_child (AtkObject *obj, int i)
  49 {
  50   AtkPlugPrivate *private = atk_plug_get_instance_private (ATK_PLUG (obj));
  51   AtkObject *child;
  52
  53   if (i != 0)
  54     return NULL;
  55
  56   child = private->child;
  57
  58   if (child == NULL)
  59     return NULL;
  60
  61   return g_object_ref (child);
  62 }
  63
  64 static int
  65 atk_plug_get_n_children (AtkObject *obj)
  66 {
  67   AtkPlugPrivate *private = atk_plug_get_instance_private (ATK_PLUG (obj));
  68
  69   if (private->child == NULL)
  70     return 0;
  71
  72   return 1;
  73 }
  74
  75 static AtkStateSet*
  76 atk_plug_ref_state_set (AtkObject *obj)
  77 {
  78   AtkPlugPrivate *private = atk_plug_get_instance_private (ATK_PLUG (obj));
  79   AtkObject *child;
  80
  81   child = private->child;
  82
  83   if (child == NULL)
  84     return NULL;
  85
  86   return atk_object_ref_state_set (child);
  87 }
  88
  89 static void
  90 atk_plug_init (AtkPlug* obj)
  91 {
  92   AtkObject *accessible = ATK_OBJECT (obj);
  93
  94   accessible->role = ATK_ROLE_FILLER;
  95   accessible->layer = ATK_LAYER_WIDGET;
  96 }
  97
  98 static void
  99 atk_plug_class_init (AtkPlugClass* klass)
 100 {
 101   AtkObjectClass *class = ATK_OBJECT_CLASS (klass);
 102
 103   if (AtkPlug_private_offset != 0)
 104     g_type_class_adjust_private_offset (klass, &AtkPlug_private_offset);
 105
 106   klass->get_object_id = NULL;
 107
 108   class->get_n_children = atk_plug_get_n_children;
 109   class->ref_child      = atk_plug_ref_child;
 110   class->ref_state_set  = atk_plug_ref_state_set;
 111 }
 112
 113 static void
 114 atk_component_interface_init (AtkComponentIface *iface)
 115 {
 116 }
 117
 118 /**
 119  * atk_plug_new:
 120  *
 121  * Creates a new #AtkPlug instance.
 122  *
 123  * Returns: (transfer full): the newly created #AtkPlug
 124  *
 125  * Since: 1.30
 126  */
 127 AtkObject *
 128 atk_plug_new (void)
 129 {
 130   return g_object_new (ATK_TYPE_PLUG, NULL);
 131 }
 132
 133 /**
 134  * atk_plug_set_child:
 135  * @plug: an #AtkPlug to be set as accessible parent of @child.
 136  * @child: an #AtkObject to be set as accessible child of @plug.
 137  *
 138  * Sets @child as accessible child of @plug and @plug as accessible parent of
 139  * @child. @child can be NULL.
 140  *
 141  * In some cases, one can not use the AtkPlug type directly as accessible
 142  * object for the toplevel widget of the application. For instance in the gtk
 143  * case, GtkPlugAccessible can not inherit both from GtkWindowAccessible and
 144  * from AtkPlug. In such a case, one can create, in addition to the standard
 145  * accessible object for the toplevel widget, an AtkPlug object, and make the
 146  * former the child of the latter by calling atk_plug_set_child().
 147  *
 148  * Since: 2.35.0
 149  */
 150 void
 151 atk_plug_set_child (AtkPlug *plug, AtkObject *child)
 152 {
 153   AtkPlugPrivate *private = atk_plug_get_instance_private (plug);
 154
 155   if (private->child)
 156     atk_object_set_parent (private->child, NULL);
 157
 158   private->child = child;
 159
 160   if (child)
 161     atk_object_set_parent (child, ATK_OBJECT(plug));
 162 }
 163
 164 /**
 165  * atk_plug_get_id:
 166  * @plug: an #AtkPlug
 167  *
 168  * Gets the unique ID of an #AtkPlug object, which can be used to
 169  * embed inside of an #AtkSocket using atk_socket_embed().
 170  *
 171  * Internally, this calls a class function that should be registered
 172  * by the IPC layer (usually at-spi2-atk). The implementor of an
 173  * #AtkPlug object should call this function (after atk-bridge is
 174  * loaded) and pass the value to the process implementing the
 175  * #AtkSocket, so it could embed the plug.
 176  *
 177  * Returns: the unique ID for the plug
 178  *
 179  * Since: 1.30
 180  **/
 181 gchar*
 182 atk_plug_get_id (AtkPlug* plug)
 183 {
 184   AtkPlugClass *klass;
 185
 186   g_return_val_if_fail (ATK_IS_PLUG (plug), NULL);
 187
 188   klass = g_type_class_peek (ATK_TYPE_PLUG);
 189
 190   if (klass && klass->get_object_id)
 191     return (klass->get_object_id) (plug);
 192   else
 193     return NULL;
 194 }