Mercurial > projects > dwt-mac

comparison dwt/accessibility/AccessibleControlListener.d @ 123:63a09873578e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fixed compile errors
author Jacob Carlborg <doob@me.com>
date Thu, 15 Jan 2009 23:08:54 +0100
parents d8635bb48c7c
children
comparison
equal deleted inserted replaced
122:2e671fa40eec 123:63a09873578e
43 * @see AccessibleControlEvent 43 * @see AccessibleControlEvent
44 * 44 *
45 * @since 2.0 45 * @since 2.0
46 */ 46 */
47 public interface AccessibleControlListener : DWTEventListener { 47 public interface AccessibleControlListener : DWTEventListener {
48 48
49 /** 49 /**
50 * Sent when an accessibility client requests the identifier 50 * Sent when an accessibility client requests the identifier
51 * of the control child at the specified display coordinates. 51 * of the control child at the specified display coordinates.
52 * <p> 52 * <p>
53 * Return the identifier of the child at display point (x, y) 53 * Return the identifier of the child at display point (x, y)
62 * <li>childID [Typical OUT] - the ID of the child at point, or CHILDID_SELF, or CHILDID_NONE</li> 62 * <li>childID [Typical OUT] - the ID of the child at point, or CHILDID_SELF, or CHILDID_NONE</li>
63 * <li>accessible [Optional OUT] - the accessible object for the control or child may be returned instead of the childID</li> 63 * <li>accessible [Optional OUT] - the accessible object for the control or child may be returned instead of the childID</li>
64 * </ul> 64 * </ul>
65 */ 65 */
66 public void getChildAtPoint (AccessibleControlEvent e); 66 public void getChildAtPoint (AccessibleControlEvent e);
67 67
68 /** 68 /**
69 * Sent when an accessibility client requests the location 69 * Sent when an accessibility client requests the location
70 * of the control, or the location of a child of the control. 70 * of the control, or the location of a child of the control.
71 * <p> 71 * <p>
72 * Return a rectangle describing the location of the specified 72 * Return a rectangle describing the location of the specified
78 * <li>childID [IN] - an identifier specifying the control or one of its children</li> 78 * <li>childID [IN] - an identifier specifying the control or one of its children</li>
79 * <li>x, y, width, height [OUT] - the control or child location in display coordinates</li> 79 * <li>x, y, width, height [OUT] - the control or child location in display coordinates</li>
80 * </ul> 80 * </ul>
81 */ 81 */
82 public void getLocation (AccessibleControlEvent e); 82 public void getLocation (AccessibleControlEvent e);
83 83
84 /** 84 /**
85 * Sent when an accessibility client requests the accessible object 85 * Sent when an accessibility client requests the accessible object
86 * for a child of the control. 86 * for a child of the control.
87 * <p> 87 * <p>
88 * Return an <code>Accessible</code> for the specified control or 88 * Return an <code>Accessible</code> for the specified control or
95 * <li>childID [IN] - an identifier specifying a child of the control</li> 95 * <li>childID [IN] - an identifier specifying a child of the control</li>
96 * <li>accessible [OUT] - an Accessible for the specified childID, or null if one does not exist</li> 96 * <li>accessible [OUT] - an Accessible for the specified childID, or null if one does not exist</li>
97 * </ul> 97 * </ul>
98 */ 98 */
99 public void getChild (AccessibleControlEvent e); 99 public void getChild (AccessibleControlEvent e);
100 100
101 /** 101 /**
102 * Sent when an accessibility client requests the number of 102 * Sent when an accessibility client requests the number of
103 * children in the control. 103 * children in the control.
104 * <p> 104 * <p>
105 * Return the number of child items in the <code>detail</code> 105 * Return the number of child items in the <code>detail</code>
109 * @param e an event object containing the following fields:<ul> 109 * @param e an event object containing the following fields:<ul>
110 * <li>detail [OUT] - the number of child items in this control</li> 110 * <li>detail [OUT] - the number of child items in this control</li>
111 * </ul> 111 * </ul>
112 */ 112 */
113 public void getChildCount (AccessibleControlEvent e); 113 public void getChildCount (AccessibleControlEvent e);
114 114
115 /** 115 /**
116 * Sent when an accessibility client requests the default action 116 * Sent when an accessibility client requests the default action
117 * of the control, or the default action of a child of the control. 117 * of the control, or the default action of a child of the control.
118 * <p> 118 * <p>
119 * This String is typically a verb describing what the user does to it. 119 * This String is typically a verb describing what the user does to it.
129 * <li>childID [IN] - an identifier specifying the control or one of its children</li> 129 * <li>childID [IN] - an identifier specifying the control or one of its children</li>
130 * <li>result [OUT] - the requested default action String, or null</li> 130 * <li>result [OUT] - the requested default action String, or null</li>
131 * </ul> 131 * </ul>
132 */ 132 */
133 public void getDefaultAction (AccessibleControlEvent e); 133 public void getDefaultAction (AccessibleControlEvent e);
134 134
135 /** 135 /**
136 * Sent when an accessibility client requests the identity of 136 * Sent when an accessibility client requests the identity of
137 * the child or control that has keyboard focus. 137 * the child or control that has keyboard focus.
138 * <p> 138 * <p>
139 * Return the identifier of the child that has focus in the 139 * Return the identifier of the child that has focus in the
146 * <li>childID [Typical OUT] - the ID of the child with focus, or CHILDID_SELF, or CHILDID_NONE</li> 146 * <li>childID [Typical OUT] - the ID of the child with focus, or CHILDID_SELF, or CHILDID_NONE</li>
147 * <li>accessible [Optional OUT] - the accessible object for a child may be returned instead of its childID</li> 147 * <li>accessible [Optional OUT] - the accessible object for a child may be returned instead of its childID</li>
148 * </ul> 148 * </ul>
149 */ 149 */
150 public void getFocus (AccessibleControlEvent e); 150 public void getFocus (AccessibleControlEvent e);
151 151
152 /** 152 /**
153 * Sent when an accessibility client requests the role 153 * Sent when an accessibility client requests the role
154 * of the control, or the role of a child of the control. 154 * of the control, or the role of a child of the control.
155 * <p> 155 * <p>
156 * Return a role constant (constant defined in ACC beginning with ROLE_) 156 * Return a role constant (constant defined in ACC beginning with ROLE_)
162 * <li>childID [IN] - an identifier specifying the control or one of its children</li> 162 * <li>childID [IN] - an identifier specifying the control or one of its children</li>
163 * <li>detail [OUT] - a role constant describing the role of the control or child</li> 163 * <li>detail [OUT] - a role constant describing the role of the control or child</li>
164 * </ul> 164 * </ul>
165 */ 165 */
166 public void getRole (AccessibleControlEvent e); 166 public void getRole (AccessibleControlEvent e);
167 167
168 /** 168 /**
169 * Sent when an accessibility client requests the identity of 169 * Sent when an accessibility client requests the identity of
170 * the child or control that is currently selected. 170 * the child or control that is currently selected.
171 * <p> 171 * <p>
172 * Return the identifier of the selected child in the 172 * Return the identifier of the selected child in the
180 * <li>childID [Typical OUT] - the ID of the selected child, or CHILDID_SELF, or CHILDID_MULTIPLE, or CHILDID_NONE</li> 180 * <li>childID [Typical OUT] - the ID of the selected child, or CHILDID_SELF, or CHILDID_MULTIPLE, or CHILDID_NONE</li>
181 * <li>accessible [Optional OUT] - the accessible object for the control or child may be returned instead of the childID</li> 181 * <li>accessible [Optional OUT] - the accessible object for the control or child may be returned instead of the childID</li>
182 * </ul> 182 * </ul>
183 */ 183 */
184 public void getSelection (AccessibleControlEvent e); 184 public void getSelection (AccessibleControlEvent e);
185 185
186 /** 186 /**
187 * Sent when an accessibility client requests the state 187 * Sent when an accessibility client requests the state
188 * of the control, or the state of a child of the control. 188 * of the control, or the state of a child of the control.
189 * <p> 189 * <p>
190 * Return a state mask (mask bit constants defined in ACC beginning with STATE_) 190 * Return a state mask (mask bit constants defined in ACC beginning with STATE_)
196 * <li>childID [IN] - an identifier specifying the control or one of its children</li> 196 * <li>childID [IN] - an identifier specifying the control or one of its children</li>
197 * <li>detail [OUT] - a state mask describing the current state of the control or child</li> 197 * <li>detail [OUT] - a state mask describing the current state of the control or child</li>
198 * </ul> 198 * </ul>
199 */ 199 */
200 public void getState (AccessibleControlEvent e); 200 public void getState (AccessibleControlEvent e);
201 201
202 /** 202 /**
203 * Sent when an accessibility client requests the value 203 * Sent when an accessibility client requests the value
204 * of the control, or the value of a child of the control. 204 * of the control, or the value of a child of the control.
205 * <p> 205 * <p>
206 * Many controls do not return a value. Examples of controls 206 * Many controls do not return a value. Examples of controls
218 * <li>childID [IN] - an identifier specifying the control or one of its children</li> 218 * <li>childID [IN] - an identifier specifying the control or one of its children</li>
219 * <li>result [OUT] - the requested value String, or null</li> 219 * <li>result [OUT] - the requested value String, or null</li>
220 * </ul> 220 * </ul>
221 */ 221 */
222 public void getValue (AccessibleControlEvent e); 222 public void getValue (AccessibleControlEvent e);
223 223
224 /** 224 /**
225 * Sent when an accessibility client requests the children of the control. 225 * Sent when an accessibility client requests the children of the control.
226 * <p> 226 * <p>
227 * Return the children as an array of childIDs in the <code>children</code> 227 * Return the children as an array of childIDs in the <code>children</code>
228 * field of the event object. 228 * field of the event object.