atk-1.0/atk/atkimage.h

0001 /* ATK -  Accessibility Toolkit
0002  * Copyright 2001 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_IMAGE_H__
0021 #define __ATK_IMAGE_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/atkobject.h>
0028 #include <atk/atkutil.h>
0029
0030 G_BEGIN_DECLS
0031
0032 /*
0033  * The AtkImage interface should be supported by any object that has an
0034  * associated image. This interface provides the standard mechanism for
0035  * an assistive technology to get descriptive information about images.
0036  */
0037
0038 #define ATK_TYPE_IMAGE (atk_image_get_type ())
0039 #define ATK_IS_IMAGE(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_IMAGE)
0040 #define ATK_IMAGE(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_IMAGE, AtkImage)
0041 #define ATK_IMAGE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_IMAGE, AtkImageIface))
0042
0043 #ifndef _TYPEDEF_ATK_IMAGE_
0044 #define _TYPEDEF_ATK_IMAGE_
0045 typedef struct _AtkImage AtkImage;
0046 #endif
0047 typedef struct _AtkImageIface AtkImageIface;
0048
0049 struct _AtkImageIface
0050 {
0051   GTypeInterface parent;
0052   void (*get_image_position) (AtkImage *image,
0053                               gint *x,
0054                               gint *y,
0055                               AtkCoordType coord_type);
0056   const gchar *(*get_image_description) (AtkImage *image);
0057   void (*get_image_size) (AtkImage *image,
0058                           gint *width,
0059                           gint *height);
0060   gboolean (*set_image_description) (AtkImage *image,
0061                                      const gchar *description);
0062   const gchar *(*get_image_locale) (AtkImage *image);
0063 };
0064
0065 ATK_AVAILABLE_IN_ALL
0066 GType atk_image_get_type (void);
0067
0068 ATK_AVAILABLE_IN_ALL
0069 const gchar *atk_image_get_image_description (AtkImage *image);
0070
0071 ATK_AVAILABLE_IN_ALL
0072 void atk_image_get_image_size (AtkImage *image,
0073                                gint *width,
0074                                gint *height);
0075
0076 ATK_AVAILABLE_IN_ALL
0077 gboolean atk_image_set_image_description (AtkImage *image,
0078                                           const gchar *description);
0079 ATK_AVAILABLE_IN_ALL
0080 void atk_image_get_image_position (AtkImage *image,
0081                                    gint *x,
0082                                    gint *y,
0083                                    AtkCoordType coord_type);
0084
0085 ATK_AVAILABLE_IN_ALL
0086 const gchar *atk_image_get_image_locale (AtkImage *image);
0087
0088 G_END_DECLS
0089
0090 #endif /* __ATK_IMAGE_H__ */