atk/atkplug.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_PLUG_H__
  23 #define __ATK_PLUG_H__
  24
  25 G_BEGIN_DECLS
  26
  27 #define ATK_TYPE_PLUG               (atk_plug_get_type ())
  28 #define ATK_PLUG(obj)               (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_PLUG, AtkPlug))
  29 #define ATK_IS_PLUG(obj)            (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_PLUG))
  30 #define ATK_PLUG_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_PLUG, AtkPlugClass))
  31 #define ATK_IS_PLUG_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_PLUG))
  32 #define ATK_PLUG_GET_CLASS(obj)     (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_PLUG, AtkPlugClass))
  33
  34 typedef struct _AtkPlug         AtkPlug;
  35 typedef struct _AtkPlugClass    AtkPlugClass;
  36
  37 struct _AtkPlug
  38 {
  39   AtkObject parent;
  40 };
  41
  42 GType atk_plug_get_type (void);
  43
  44 struct _AtkPlugClass
  45 {
  46   AtkObjectClass parent_class;
  47
  48   /* to be subscribed to by atk-bridge */
  49
  50   /*< protected >*/
  51   gchar* (* get_object_id) (AtkPlug* obj);
  52 };
  53
  54 AtkObject*    atk_plug_new     (void);
  55 gchar*        atk_plug_get_id  (AtkPlug* plug);
  56
  57 G_END_DECLS
  58
  59 #endif /* __ATK_PLUG_H__ */