Implement AtkComponent for AtkPlug and AtkSocket.
[platform/upstream/atk.git] / 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 static void atk_socket_class_init (AtkSocketClass *klass);
24
25 static void atk_component_interface_init (AtkComponentIface *iface);
26
27 G_DEFINE_TYPE_WITH_CODE (AtkSocket, atk_socket, ATK_TYPE_OBJECT,
28                          G_IMPLEMENT_INTERFACE (ATK_TYPE_COMPONENT, atk_component_interface_init))
29
30 static void
31 atk_socket_init (AtkSocket* obj)
32 {
33   obj->embedded_plug_id = NULL;
34 }
35
36 static void
37 atk_socket_class_init (AtkSocketClass* klass)
38 {
39   klass->embed = NULL;
40 }
41
42 static void atk_component_interface_init (AtkComponentIface *iface)
43 {
44 }
45
46 AtkObject*
47 atk_socket_new (void)
48 {
49   AtkObject* accessible;
50   
51   accessible = g_object_new (ATK_TYPE_SOCKET, NULL);
52   g_return_val_if_fail (accessible != NULL, NULL);
53
54   accessible->role = ATK_ROLE_FILLER;
55   accessible->layer = ATK_LAYER_WIDGET;
56   
57   return accessible;
58 }
59
60 /**
61  * atk_socket_embed:
62  * @obj: an #AtkSocket
63  * @plug_id: the ID of an #AtkPlug
64  *
65  * Embeds the children of an #AtkPlug as the children of the #AtkSocket.  The
66  * plug may be in the same process or in a different process.
67  **/
68 void
69 atk_socket_embed (AtkSocket* obj, gchar* plug_id)
70 {
71   AtkSocketClass *klass;
72
73   g_return_if_fail (plug_id != NULL);
74   g_return_if_fail (ATK_IS_SOCKET (obj));
75
76   klass = g_type_class_peek (ATK_TYPE_SOCKET);
77   if (klass && klass->embed)
78     {
79       if (obj->embedded_plug_id)
80         g_free (obj->embedded_plug_id);
81       obj->embedded_plug_id = g_strdup (plug_id);
82       (klass->embed) (obj, plug_id);
83     }
84 }
85
86 /**
87  * atk_socket_is_occupied:
88  * @obj: an #AtkSocket
89  *
90  * Determines whether or not the socket has an embedded plug.
91  *
92  * Returns: TRUE if a plug is embedded in the socket
93  **/
94 gboolean
95 atk_socket_is_occupied (AtkSocket* obj)
96 {
97   g_return_val_if_fail (ATK_IS_SOCKET (obj), FALSE);
98
99   return (obj->embedded_plug_id != NULL);
100 }