michael@0: /* ATK -  Accessibility Toolkit
michael@0:  * Copyright 2001 Sun Microsystems Inc.
michael@0:  *
michael@0:  * This library is free software; you can redistribute it and/or
michael@0:  * modify it under the terms of the GNU Library General Public
michael@0:  * License as published by the Free Software Foundation; either
michael@0:  * version 2 of the License, or (at your option) any later version.
michael@0:  *
michael@0:  * This library is distributed in the hope that it will be useful,
michael@0:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
michael@0:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
michael@0:  * Library General Public License for more details.
michael@0:  *
michael@0:  * You should have received a copy of the GNU Library General Public
michael@0:  * License along with this library; if not, write to the
michael@0:  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
michael@0:  * Boston, MA 02111-1307, USA.
michael@0:  */
michael@0: 
michael@0: #ifndef __ATK_IMAGE_H__
michael@0: #define __ATK_IMAGE_H__
michael@0: 
michael@0: #include <atk/atkobject.h>
michael@0: #include <atk/atkutil.h>
michael@0: 
michael@0: #ifdef __cplusplus
michael@0: extern "C" {
michael@0: #endif /* __cplusplus */
michael@0: 
michael@0: /*
michael@0:  * The AtkImage interface should be supported by any object that has an 
michael@0:  * associated image. This interface provides the standard mechanism for 
michael@0:  * an assistive technology to get descriptive information about images.
michael@0:  */
michael@0: 
michael@0: #define ATK_TYPE_IMAGE                   (atk_image_get_type ())
michael@0: #define ATK_IS_IMAGE(obj)                G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_IMAGE)
michael@0: #define ATK_IMAGE(obj)                   G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_IMAGE, AtkImage)
michael@0: #define ATK_IMAGE_GET_IFACE(obj)         (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_IMAGE, AtkImageIface))
michael@0: 
michael@0: #ifndef _TYPEDEF_ATK_IMAGE_
michael@0: #define _TYPEDEF_ATK_IMAGE_
michael@0: typedef struct _AtkImage AtkImage;
michael@0: #endif
michael@0: typedef struct _AtkImageIface AtkImageIface;
michael@0: 
michael@0: struct _AtkImageIface
michael@0: {
michael@0:   GTypeInterface parent;
michael@0:   void          	( *get_image_position)    (AtkImage		 *image,
michael@0:                                                    gint                  *x,
michael@0: 				                   gint	                 *y,
michael@0:     			                           AtkCoordType	         coord_type);
michael@0:   G_CONST_RETURN gchar* ( *get_image_description) (AtkImage              *image);
michael@0:   void                  ( *get_image_size)        (AtkImage              *image,
michael@0:                                                    gint                  *width,
michael@0:                                                    gint                  *height);
michael@0:   gboolean              ( *set_image_description) (AtkImage              *image,
michael@0:                                                    const gchar           *description);
michael@0:   G_CONST_RETURN gchar* ( *get_image_locale)      (AtkImage              *image);
michael@0: 
michael@0:   AtkFunction           pad1;
michael@0: 	
michael@0: };
michael@0: 
michael@0: GType  atk_image_get_type             (void);
michael@0: 
michael@0: G_CONST_RETURN gchar* atk_image_get_image_description (AtkImage   *image);
michael@0: 
michael@0: void     atk_image_get_image_size        (AtkImage           *image,
michael@0:                                           gint               *width,
michael@0:                                           gint               *height);
michael@0: 
michael@0: gboolean atk_image_set_image_description (AtkImage           *image,
michael@0:                                           const gchar       *description);
michael@0: void     atk_image_get_image_position    (AtkImage	     *image,
michael@0:                                           gint               *x,
michael@0: 					  gint	             *y,
michael@0:     					  AtkCoordType	     coord_type);
michael@0: 
michael@0: G_CONST_RETURN gchar* atk_image_get_image_locale (AtkImage   *image);
michael@0: 
michael@0: #ifdef __cplusplus
michael@0: }
michael@0: #endif /* __cplusplus */
michael@0: #endif /* __ATK_IMAGE_H__ */