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