atk/atkimage.h

   1 /* ATK -  Accessibility Toolkit
   2  * Copyright 2001 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_IMAGE_H__
  21 #define __ATK_IMAGE_H__
  22
  23 #include <atk/atkobject.h>
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif /* __cplusplus */
  28
  29 /*
  30  * The AtkImage interface should be supported by any object that has an
  31  * associated image. This interface provides the standard mechanism for
  32  * an assistive technology to get descriptive information about images.
  33  */
  34
  35 #define ATK_TYPE_IMAGE                   (atk_image_get_type ())
  36 #define ATK_IS_IMAGE(obj)                G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_IMAGE)
  37 #define ATK_IMAGE(obj)                   G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_IMAGE, AtkImage)
  38 #define ATK_IMAGE_GET_IFACE(obj)         (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_IMAGE, AtkImageIface))
  39
  40 #ifndef _TYPEDEF_ATK_IMAGE_
  41 #define _TYPEDEF_ATK_IMAGE_
  42 typedef struct _AtkImage AtkImage;
  43 #endif
  44 typedef struct _AtkImageIface AtkImageIface;
  45
  46 /**
  47  *AtkImageType:
  48  *@ATK_IMAGE_EMPTY:
  49  *@ATK_IMAGE_PIXMAP:
  50  *@ATK_IMAGE_IMAGE:
  51  *@ATK_IMAGE_PIXBUF:
  52  *@ATK_IMAGE_STOCK:
  53  *@ATK_IMAGE_ICON_SET:
  54  *
  55  *The representation being used to store the image data
  56  **/
  57 typedef enum
  58 {
  59   ATK_IMAGE_EMPTY,
  60   ATK_IMAGE_PIXMAP,
  61   ATK_IMAGE_IMAGE,
  62   ATK_IMAGE_PIXBUF,
  63   ATK_IMAGE_STOCK,
  64   ATK_IMAGE_ICON_SET
  65 } AtkImageType;
  66
  67 struct _AtkImageIface
  68 {
  69   GTypeInterface parent;
  70
  71   AtkImageType     (*get_storage_type)              (AtkImage              *image);
  72   G_CONST_RETURN   gchar* ( *get_image_description) (AtkImage              *image);
  73   gint     ( *get_image_height)      (AtkImage              *image);
  74   gint     ( *get_image_width)       (AtkImage              *image);
  75   gboolean ( *set_image_description) (AtkImage              *image,
  76                                       const gchar           *description);
  77
  78 };
  79 GType  atk_image_get_type             (void);
  80
  81 AtkImageType          atk_image_get_storage_type      (AtkImage   *image);
  82 G_CONST_RETURN gchar* atk_image_get_image_description (AtkImage   *image);
  83
  84 gint     atk_image_get_image_height      (AtkImage           *image);
  85
  86 gint     atk_image_get_image_width       (AtkImage           *image);
  87
  88 gboolean atk_image_set_image_description (AtkImage           *image,
  89                                           const gchar       *description);
  90
  91
  92 #ifdef __cplusplus
  93 }
  94 #endif /* __cplusplus */
  95
  96
  97 #endif /* __ATK_IMAGE_H__ */