atk-1.0/atk/atksocket.h

0001 /* ATK -  Accessibility Toolkit
0002  * Copyright 2009 Novell, Inc.
0003  *
0004  * This library is free software; you can redistribute it and/or
0005  * modify it under the terms of the GNU Library General Public
0006  * License as published by the Free Software Foundation; either
0007  * version 2 of the License, or (at your option) any later version.
0008  *
0009  * This library is distributed in the hope that it will be useful,
0010  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0011  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0012  * Library General Public License for more details.
0013  *
0014  * You should have received a copy of the GNU Library General Public
0015  * License along with this library; if not, write to the
0016  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
0017  * Boston, MA 02111-1307, USA.
0018  */
0019
0020 #ifndef __ATK_SOCKET_H__
0021 #define __ATK_SOCKET_H__
0022
0023 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined(__ATK_H_INSIDE__) && !defined(ATK_COMPILATION)
0024 #error "Only <atk/atk.h> can be included directly."
0025 #endif
0026
0027 #include <atk/atkversion.h>
0028
0029 G_BEGIN_DECLS
0030
0031 #define ATK_TYPE_SOCKET (atk_socket_get_type ())
0032 #define ATK_SOCKET(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_SOCKET, AtkSocket))
0033 #define ATK_IS_SOCKET(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_SOCKET))
0034 #define ATK_SOCKET_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_SOCKET, AtkSocketClass))
0035 #define ATK_IS_SOCKET_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_SOCKET))
0036 #define ATK_SOCKET_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_SOCKET, AtkSocketClass))
0037
0038 typedef struct _AtkSocket AtkSocket;
0039 typedef struct _AtkSocketClass AtkSocketClass;
0040
0041 struct _AtkSocket
0042 {
0043   AtkObject parent;
0044
0045   /*< private >*/
0046   gchar *embedded_plug_id;
0047 };
0048
0049 ATK_AVAILABLE_IN_ALL
0050 GType atk_socket_get_type (void);
0051
0052 struct _AtkSocketClass
0053 {
0054   AtkObjectClass parent_class;
0055
0056   /* to be subscribed to by atk-bridge */
0057
0058   /*< protected >*/
0059   void (*embed) (AtkSocket *obj, const gchar *plug_id);
0060 };
0061
0062 ATK_AVAILABLE_IN_ALL
0063 AtkObject *atk_socket_new (void);
0064 ATK_AVAILABLE_IN_ALL
0065 void atk_socket_embed (AtkSocket *obj, const gchar *plug_id);
0066 ATK_AVAILABLE_IN_ALL
0067 gboolean atk_socket_is_occupied (AtkSocket *obj);
0068
0069 G_END_DECLS
0070
0071 #endif /* __ATK_SOCKET_H__ */