Updated FSF's address
[platform/upstream/atk.git] / atk / atksocket.h
1 /* ATK -  Accessibility Toolkit
2  * Copyright 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 Library 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  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public
15  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
16  */
17
18 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
19 #error "Only <atk/atk.h> can be included directly."
20 #endif
21
22 #ifndef __ATK_SOCKET_H__
23 #define __ATK_SOCKET_H__
24
25 G_BEGIN_DECLS
26
27 #define ATK_TYPE_SOCKET               (atk_socket_get_type ())
28 #define ATK_SOCKET(obj)               (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_SOCKET, AtkSocket))
29 #define ATK_IS_SOCKET(obj)            (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_SOCKET))
30 #define ATK_SOCKET_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_SOCKET, AtkSocketClass))
31 #define ATK_IS_SOCKET_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_SOCKET))
32 #define ATK_SOCKET_GET_CLASS(obj)     (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_SOCKET, AtkSocketClass))
33
34 typedef struct _AtkSocket         AtkSocket;
35 typedef struct _AtkSocketClass    AtkSocketClass;
36
37 struct _AtkSocket
38 {
39   AtkObject parent;
40
41   /*< private >*/
42   gchar* embedded_plug_id;
43 };
44
45 GType atk_socket_get_type (void);
46
47 struct _AtkSocketClass
48 {
49   AtkObjectClass parent_class;
50   
51   /* to be subscribed to by atk-bridge */
52
53   /*< protected >*/
54   void (* embed) (AtkSocket *obj, gchar* plug_id);
55 };
56
57 AtkObject*    atk_socket_new           (void);
58 void          atk_socket_embed         (AtkSocket* obj, gchar* plug_id);
59 gboolean      atk_socket_is_occupied   (AtkSocket* obj);
60
61 G_END_DECLS
62
63 #endif /* __ATK_SOCKET_H__ */