docs/tmpl/atkcomponent.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkComponent
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 accessibility interface for objects that are rendered on the screen
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The AtkComponent interface should be supported by any object that is
  10 rendered on the screen. The interface provides the standard mechanism
  11 for an assistive technology to determine and set the graphical
  12 representation of an object.
  13 </para>
  14
  15 <!-- ##### SECTION See_Also ##### -->
  16 <para>
  17
  18 </para>
  19
  20 <!-- ##### STRUCT AtkComponent ##### -->
  21 <para>
  22
  23 </para>
  24
  25
  26 <!-- ##### STRUCT AtkComponentIface ##### -->
  27 <para>
  28
  29 </para>
  30
  31 @parent:
  32 @add_focus_handler:
  33 @contains:
  34 @get_accessible_at_point:
  35 @get_extents:
  36 @get_position:
  37 @get_position_on_screen:
  38 @get_size:
  39 @grab_focus:
  40 @remove_focus_handler:
  41 @set_extents:
  42 @set_position:
  43 @set_size:
  44
  45 <!-- ##### FUNCTION atk_component_add_focus_handler ##### -->
  46 <para>
  47
  48 </para>
  49
  50 @component:
  51 @handler:
  52 @Returns:
  53
  54
  55 <!-- ##### FUNCTION atk_component_contains ##### -->
  56 <para>
  57
  58 </para>
  59
  60 @component:
  61 @x:
  62 @y:
  63 @Returns:
  64 <!-- # Unused Parameters # -->
  65 @coord_type:
  66
  67
  68 <!-- ##### FUNCTION atk_component_get_extents ##### -->
  69 <para>
  70
  71 </para>
  72
  73 @component:
  74 @x:
  75 @y:
  76 @width:
  77 @height:
  78 <!-- # Unused Parameters # -->
  79 @coord_type:
  80
  81
  82 <!-- ##### FUNCTION atk_component_get_position ##### -->
  83 <para>
  84
  85 </para>
  86
  87 @component:
  88 @x:
  89 @y:
  90 <!-- # Unused Parameters # -->
  91 @coord_type:
  92
  93
  94 <!-- ##### FUNCTION atk_component_get_size ##### -->
  95 <para>
  96
  97 </para>
  98
  99 @component:
 100 @width:
 101 @height:
 102
 103
 104 <!-- ##### FUNCTION atk_component_grab_focus ##### -->
 105 <para>
 106
 107 </para>
 108
 109 @component:
 110 <!-- # Unused Parameters # -->
 111 @Returns:
 112
 113
 114 <!-- ##### FUNCTION atk_component_remove_focus_handler ##### -->
 115 <para>
 116
 117 </para>
 118
 119 @component:
 120 @handler_id:
 121
 122
 123 <!-- ##### FUNCTION atk_component_set_extents ##### -->
 124 <para>
 125
 126 </para>
 127
 128 @component:
 129 @x:
 130 @y:
 131 @width:
 132 @height:
 133 <!-- # Unused Parameters # -->
 134 @coord_type:
 135 @Returns:
 136
 137
 138 <!-- ##### FUNCTION atk_component_set_position ##### -->
 139 <para>
 140
 141 </para>
 142
 143 @component:
 144 @x:
 145 @y:
 146 <!-- # Unused Parameters # -->
 147 @coord_type:
 148 @Returns:
 149
 150
 151 <!-- ##### FUNCTION atk_component_set_size ##### -->
 152 <para>
 153
 154 </para>
 155
 156 @component:
 157 @width:
 158 @height:
 159 <!-- # Unused Parameters # -->
 160 @Returns:
 161
 162