atk-1.0/atk/atkplug.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_PLUG_H__
0021 #define __ATK_PLUG_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_PLUG (atk_plug_get_type ())
0032 #define ATK_PLUG(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_PLUG, AtkPlug))
0033 #define ATK_IS_PLUG(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_PLUG))
0034 #define ATK_PLUG_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_PLUG, AtkPlugClass))
0035 #define ATK_IS_PLUG_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_PLUG))
0036 #define ATK_PLUG_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_PLUG, AtkPlugClass))
0037
0038 typedef struct _AtkPlug AtkPlug;
0039 typedef struct _AtkPlugClass AtkPlugClass;
0040
0041 struct _AtkPlug
0042 {
0043   AtkObject parent;
0044 };
0045
0046 ATK_AVAILABLE_IN_ALL
0047 GType atk_plug_get_type (void);
0048
0049 struct _AtkPlugClass
0050 {
0051   AtkObjectClass parent_class;
0052
0053   /* to be subscribed to by atk-bridge */
0054
0055   /*< protected >*/
0056   gchar *(*get_object_id) (AtkPlug *obj);
0057 };
0058
0059 ATK_AVAILABLE_IN_ALL
0060 AtkObject *atk_plug_new (void);
0061 ATK_AVAILABLE_IN_2_36
0062 void atk_plug_set_child (AtkPlug *plug, AtkObject *child);
0063 ATK_AVAILABLE_IN_ALL
0064 gchar *atk_plug_get_id (AtkPlug *plug);
0065
0066 G_END_DECLS
0067
0068 #endif /* __ATK_PLUG_H__ */