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 #ifndef __ATK_MISC_H__
  21 #define __ATK_MISC_H__
  22
  23 #include <glib-object.h>
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif /* __cplusplus */
  28
  29 #define ATK_TYPE_MISC                   (atk_misc_get_type ())
  30 #define ATK_IS_MISC(obj)                G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_MISC)
  31 #define ATK_MISC(obj)                   G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_MISC, AtkMisc)
  32 #define ATK_MISC_CLASS(klass)                   (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_MISC, AtkMiscClass))
  33 #define ATK_IS_MISC_CLASS(klass)                (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_MISC))
  34 #define ATK_MISC_GET_CLASS(obj)                 (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_MISC, AtkMiscClass))
  35
  36
  37 #ifndef _TYPEDEF_ATK_MISC_
  38 #define _TYPEDEF_ATK_MISC_
  39 typedef struct _AtkMisc      AtkMisc;
  40 typedef struct _AtkMiscClass AtkMiscClass;
  41 #endif
  42
  43 struct _AtkMisc
  44 {
  45   GObject parent;
  46 };
  47
  48 /*
  49  * Singleton instance - only the ATK implementation layer for
  50  * a given GUI toolkit/application instance should touch this
  51  * symbol directly.
  52  */
  53 extern AtkMisc *atk_misc_instance;
  54
  55 struct _AtkMiscClass
  56 {
  57    GObjectClass parent;
  58    void   (* threads_enter)                     (AtkMisc *misc);
  59    void   (* threads_leave)                     (AtkMisc *misc);
  60    gpointer vfuncs[32]; /* future bincompat */
  61 };
  62 GType atk_util_get_type (void);
  63
  64 /*
  65  * Wrapper for thread lock, i.e. take the thread mutex for the GUI toolkit,
  66  * if one exists.
  67  * (This method is implemented by the toolkit ATK implementation layer;
  68  *  for instance, for GTK+, GAIL implements this via GDK_THREADS_ENTER).
  69  */
  70 void     atk_misc_threads_enter  (AtkMisc *misc);
  71
  72 /*
  73  * Wrapper for thread lock, i.e. release the thread mutex for the GUI toolkit,
  74  * if one exists.
  75  * (This method is implemented by the toolkit ATK implementation layer;
  76  *  for instance, for GTK+, GAIL implements this via GDK_THREADS_LEAVE).
  77  */
  78 void     atk_misc_threads_leave  (AtkMisc *misc);
  79
  80 /*
  81  * Obtain (singleton) instance of AtkMisc.
  82  */
  83 const AtkMisc *atk_misc_get_instance (void);
  84
  85 #ifdef __cplusplus
  86 }
  87 #endif /* __cplusplus */
  88
  89
  90 #endif /* __ATK_MISC_H__ */