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, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
  21 #error "Only <atk/atk.h> can be included directly."
  22 #endif
  23
  24 #ifndef __ATK_SOCKET_H__
  25 #define __ATK_SOCKET_H__
  26
  27 #include <atk/atkversion.h>
  28
  29 G_BEGIN_DECLS
  30
  31 #define ATK_TYPE_SOCKET               (atk_socket_get_type ())
  32 #define ATK_SOCKET(obj)               (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_SOCKET, AtkSocket))
  33 #define ATK_IS_SOCKET(obj)            (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_SOCKET))
  34 #define ATK_SOCKET_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_SOCKET, AtkSocketClass))
  35 #define ATK_IS_SOCKET_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_SOCKET))
  36 #define ATK_SOCKET_GET_CLASS(obj)     (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_SOCKET, AtkSocketClass))
  37
  38 typedef struct _AtkSocket         AtkSocket;
  39 typedef struct _AtkSocketClass    AtkSocketClass;
  40
  41 struct _AtkSocket
  42 {
  43   AtkObject parent;
  44
  45   /*< private >*/
  46   gchar* embedded_plug_id;
  47 };
  48
  49 ATK_AVAILABLE_IN_ALL
  50 GType atk_socket_get_type (void);
  51
  52 struct _AtkSocketClass
  53 {
  54   AtkObjectClass parent_class;
  55
  56   /* to be subscribed to by atk-bridge */
  57
  58   /*< protected >*/
  59   void (* embed) (AtkSocket *obj, gchar* plug_id);
  60 };
  61
  62 ATK_AVAILABLE_IN_ALL
  63 AtkObject*    atk_socket_new           (void);
  64 ATK_AVAILABLE_IN_ALL
  65 void          atk_socket_embed         (AtkSocket* obj, gchar* plug_id);
  66 ATK_AVAILABLE_IN_ALL
  67 gboolean      atk_socket_is_occupied   (AtkSocket* obj);
  68
  69 G_END_DECLS
  70
  71 #endif /* __ATK_SOCKET_H__ */