docs/tmpl/atkimage.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkImage
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 The ATK Interface implemented by components which expose image or pixmap
   6 content on-screen.
   7
   8 <!-- ##### SECTION Long_Description ##### -->
   9 <para>
  10 #AtkImage should be implemented by #AtkObject subtypes on behalf of
  11 components which display image/pixmap information onscreen, and which
  12 provide information (other than just widget borders, etc.) via that
  13 image content.  For instance, icons, buttons with icons, toolbar
  14 elements, and image viewing panes typically should implement #AtkImage.
  15 </para>
  16 <para>
  17 #AtkImage primarily provides two types of information: coordinate
  18 information (useful for screen review mode of screenreaders, and for use
  19 by onscreen magnifiers), and descriptive information.  The descriptive
  20 information is provided for alternative, text-only presentation of the
  21 most significant information present in the image.
  22 </para>
  23
  24 <!-- ##### SECTION See_Also ##### -->
  25 <para>
  26
  27 </para>
  28
  29 <!-- ##### STRUCT AtkImage ##### -->
  30 <para>
  31 The AtkImage structure does not contain any fields.
  32
  33 </para>
  34
  35
  36 <!-- ##### FUNCTION atk_image_get_image_position ##### -->
  37 <para>
  38
  39 </para>
  40
  41 @image:
  42 @x:
  43 @y:
  44 @coord_type:
  45
  46
  47 <!-- ##### FUNCTION atk_image_get_image_description ##### -->
  48 <para>
  49
  50 </para>
  51
  52 @image:
  53 @Returns:
  54
  55
  56 <!-- ##### FUNCTION atk_image_set_image_description ##### -->
  57 <para>
  58
  59 </para>
  60
  61 @image:
  62 @description:
  63 @Returns:
  64
  65
  66 <!-- ##### FUNCTION atk_image_get_image_size ##### -->
  67 <para>
  68
  69 </para>
  70
  71 @image:
  72 @width:
  73 @height:
  74
  75