atk-1.0/atk/atkmisc.h

0001 /* ATK -  Accessibility Toolkit
0002  * Copyright 2007 Sun Microsystems 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_MISC_H__
0021 #define __ATK_MISC_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 #include <glib-object.h>
0029
0030 /* We prefix variable declarations so they can
0031  * properly get exported in Windows DLLs.
0032  */
0033 #ifndef ATK_VAR
0034 #ifdef G_PLATFORM_WIN32
0035 #ifdef ATK_STATIC_COMPILATION
0036 #define ATK_VAR extern
0037 #else /* !ATK_STATIC_COMPILATION */
0038 #ifdef ATK_COMPILATION
0039 #ifdef DLL_EXPORT
0040 #define ATK_VAR _ATK_EXTERN
0041 #else /* !DLL_EXPORT */
0042 #define ATK_VAR extern
0043 #endif /* !DLL_EXPORT */
0044 #else  /* !ATK_COMPILATION */
0045 #define ATK_VAR extern __declspec(dllimport)
0046 #endif /* !ATK_COMPILATION */
0047 #endif /* !ATK_STATIC_COMPILATION */
0048 #else  /* !G_PLATFORM_WIN32 */
0049 #define ATK_VAR _ATK_EXTERN
0050 #endif /* !G_PLATFORM_WIN32 */
0051 #endif /* ATK_VAR */
0052
0053 G_BEGIN_DECLS
0054
0055 #define ATK_TYPE_MISC (atk_misc_get_type ())
0056 #define ATK_IS_MISC(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_MISC)
0057 #define ATK_MISC(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_MISC, AtkMisc)
0058 #define ATK_MISC_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_MISC, AtkMiscClass))
0059 #define ATK_IS_MISC_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_MISC))
0060 #define ATK_MISC_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_MISC, AtkMiscClass))
0061
0062 #ifndef _TYPEDEF_ATK_MISC_
0063 #define _TYPEDEF_ATK_MISC_
0064 typedef struct _AtkMisc AtkMisc;
0065 typedef struct _AtkMiscClass AtkMiscClass;
0066 #endif
0067
0068 struct _AtkMisc
0069 {
0070   GObject parent;
0071 };
0072
0073 /*
0074  * Singleton instance - only the ATK implementation layer for
0075  * a given GUI toolkit/application instance should touch this
0076  * symbol directly.
0077  *
0078  * Deprecated: Since 2.12.
0079  */
0080 ATK_VAR AtkMisc *atk_misc_instance;
0081
0082 /**
0083  * AtkMiscClass:
0084  * @threads_enter: This virtual function is deprecated since 2.12 and
0085  *   it should not be overriden.
0086  * @threads_leave: This virtual function is deprecated sice 2.12 and
0087  *   it should not be overriden.
0088  *
0089  * Usage of AtkMisc is deprecated since 2.12 and heavily discouraged.
0090  */
0091 struct _AtkMiscClass
0092 {
0093   GObjectClass parent;
0094   void (*threads_enter) (AtkMisc *misc);
0095   void (*threads_leave) (AtkMisc *misc);
0096   gpointer vfuncs[32]; /* future bincompat */
0097 };
0098
0099 ATK_DEPRECATED_IN_2_12
0100 GType atk_misc_get_type (void);
0101
0102 ATK_DEPRECATED_IN_2_12
0103 void atk_misc_threads_enter (AtkMisc *misc);
0104 ATK_DEPRECATED_IN_2_12
0105 void atk_misc_threads_leave (AtkMisc *misc);
0106 ATK_DEPRECATED_IN_2_12
0107 const AtkMisc *atk_misc_get_instance (void);
0108
0109 G_END_DECLS
0110
0111 #endif /* __ATK_MISC_H__ */