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#ifndef __ATK_PLUG_H__
21#define __ATK_PLUG_H__
22
23#if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
24#error "Only <atk/atk.h> can be included directly."
25#endif
26
27#include <atk/atkversion.h>
28
29G_BEGIN_DECLS
30
31#define ATK_TYPE_PLUG (atk_plug_get_type ())
32#define ATK_PLUG(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_PLUG, AtkPlug))
33#define ATK_IS_PLUG(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_PLUG))
34#define ATK_PLUG_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_PLUG, AtkPlugClass))
35#define ATK_IS_PLUG_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_PLUG))
36#define ATK_PLUG_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_PLUG, AtkPlugClass))
37
38typedef struct _AtkPlug AtkPlug;
39typedef struct _AtkPlugClass AtkPlugClass;
40
41struct _AtkPlug
42{
43 AtkObject parent;
44};
45
46ATK_AVAILABLE_IN_ALL
47GType atk_plug_get_type (void);
48
49struct _AtkPlugClass
50{
51 AtkObjectClass parent_class;
52
53 /* to be subscribed to by atk-bridge */
54
55 /*< protected >*/
56 gchar* (* get_object_id) (AtkPlug* obj);
57};
58
59ATK_AVAILABLE_IN_ALL
60AtkObject* atk_plug_new (void);
61ATK_AVAILABLE_IN_ALL
62gchar* atk_plug_get_id (AtkPlug* plug);
63
64G_END_DECLS
65
66#endif /* __ATK_PLUG_H__ */
67