atk/atkmisc.h

   1 /* ATK -  Accessibility Toolkit
   2  * Copyright 2007 Sun Microsystems 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_MISC_H__
  25 #define __ATK_MISC_H__
  26
  27 #include <glib-object.h>
  28 #include <atk/atkversion.h>
  29
  30 /* We prefix variable declarations so they can
  31  * properly get exported in Windows DLLs.
  32  */
  33 #ifndef ATK_VAR
  34 #  ifdef G_PLATFORM_WIN32
  35 #    ifdef ATK_STATIC_COMPILATION
  36 #      define ATK_VAR extern
  37 #    else /* !ATK_STATIC_COMPILATION */
  38 #      ifdef ATK_COMPILATION
  39 #        ifdef DLL_EXPORT
  40 #          define ATK_VAR _ATK_EXTERN
  41 #        else /* !DLL_EXPORT */
  42 #          define ATK_VAR extern
  43 #        endif /* !DLL_EXPORT */
  44 #      else /* !ATK_COMPILATION */
  45 #        define ATK_VAR extern __declspec(dllimport)
  46 #      endif /* !ATK_COMPILATION */
  47 #    endif /* !ATK_STATIC_COMPILATION */
  48 #  else /* !G_PLATFORM_WIN32 */
  49 #    define ATK_VAR _ATK_EXTERN
  50 #  endif /* !G_PLATFORM_WIN32 */
  51 #endif /* ATK_VAR */
  52
  53 G_BEGIN_DECLS
  54
  55 #define ATK_TYPE_MISC                   (atk_misc_get_type ())
  56 #define ATK_IS_MISC(obj)                G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_MISC)
  57 #define ATK_MISC(obj)                   G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_MISC, AtkMisc)
  58 #define ATK_MISC_CLASS(klass)                   (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_MISC, AtkMiscClass))
  59 #define ATK_IS_MISC_CLASS(klass)                (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_MISC))
  60 #define ATK_MISC_GET_CLASS(obj)                 (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_MISC, AtkMiscClass))
  61
  62
  63 #ifndef _TYPEDEF_ATK_MISC_
  64 #define _TYPEDEF_ATK_MISC_
  65 typedef struct _AtkMisc      AtkMisc;
  66 typedef struct _AtkMiscClass AtkMiscClass;
  67 #endif
  68
  69 struct _AtkMisc
  70 {
  71   GObject parent;
  72 };
  73
  74 /*
  75  * Singleton instance - only the ATK implementation layer for
  76  * a given GUI toolkit/application instance should touch this
  77  * symbol directly.
  78  *
  79  * Deprecated: Since 2.12.
  80  */
  81 ATK_VAR AtkMisc *atk_misc_instance;
  82
  83 /**
  84  * AtkMiscClass:
  85  * @threads_enter: This virtual function is deprecated since 2.12 and
  86  *   it should not be overriden.
  87  * @threads_leave: This virtual function is deprecated sice 2.12 and
  88  *   it should not be overriden.
  89  *
  90  * Usage of AtkMisc is deprecated since 2.12 and heavily discouraged.
  91  */
  92 struct _AtkMiscClass
  93 {
  94    GObjectClass parent;
  95    void   (* threads_enter)                     (AtkMisc *misc);
  96    void   (* threads_leave)                     (AtkMisc *misc);
  97    gpointer vfuncs[32]; /* future bincompat */
  98 };
  99
 100 ATK_DEPRECATED_IN_2_12
 101 GType atk_misc_get_type (void);
 102
 103 ATK_DEPRECATED_IN_2_12
 104 void     atk_misc_threads_enter  (AtkMisc *misc);
 105 ATK_DEPRECATED_IN_2_12
 106 void     atk_misc_threads_leave  (AtkMisc *misc);
 107 ATK_DEPRECATED_IN_2_12
 108 const AtkMisc *atk_misc_get_instance (void);
 109
 110 G_END_DECLS
 111
 112 #endif /* __ATK_MISC_H__ */