Thanks Jamie, I made the following changes: - changed the method's name - updated the paragraphs - added information about the parameter and return values at the end
HRESULT isNamePreferred([out, retval] boolean* isPreferred); Indicates that a content author has provided ancillary text in addition to the primary text of an object and that the server has chosen to use that ancillary text for this object's accessible name in preference to object's primary text. This method is only useful when the IAccessibleText interface is implemented and a true value indicates that the accessible name is different from, and more meaningful than, the text that is returned from IAccessibleText::text. Typically an object's accessible name is taken directly from the object's textual content and is equivalent to the text from IAccessibleText::text, but a true value is returned when the server has chosen to use ancillary text rather than the accessible's primary textual content when generating the accessible name. Some examples that could be seen in an IAccessible2 implementation of a web browser are: 1) <a href="http://www.adomain.com";>content</a> In this case the accessible name will be "content" and isPreferred will be false. 2) <a href="http://www.adomain.com"; title="a title">content</a> If the title text is used for the accessible name, isPreferred will be true. 3) <a href="http://www.adomain.com"; aria-label="a label">content</a> If the aria-label text is used for accessible name, isPreferred will be true. 4) <div id="label">a label</div><div role="radio" aria-labelledby="label">content</div> If the label text is used for the accessible name, isPreferred will be true. If this method returns true assistive technology may choose to present the user with the accessible name rather than the text from IAccessibleText::text. Parameters: isPreferred is true if the server prefers the use of the accessible name over the text from IAccessibleText::text. Return values: S_OK S_FALSE if IAccessibleText is not implemented On 7/26/2011 12:16 AM, James Teh wrote: > On 26/07/2011 11:47 AM, Pete Brunet wrote: >> HRESULT isNameFromAncillaryText([out, retval] boolean* isFromAncillaryText); > ... >> An object's accessible name is typically is taken directly from the > typo: "is typically is taken from" -> "is typically taken from" > >> object's textual content and is equivalent to what is provided by >> IAccessibleText::text. > I know you used the word "typically" above, but I'm wondering whether > it's clear that this extends to the part about IAccessibleText as well. > That is, it's still quite okay to have an accessible name even where > IAccessibleText::text is not exposed at all. Perhaps this sentence neds > to be amended slightly to make it clear that this is only relevant to > servers which choose to expose content via IAccessibleText. > > Jamie > -- *Pete Brunet* a11ysoft - Accessibility Architecture and Development (512) 467-4706 (work), (512) 689-4155 (cell) Skype: pete.brunet IM: ptbrunet (AOL, Google), [email protected] (MSN) http://www.a11ysoft.com/about/ Ionosphere: WS4G
_______________________________________________ Accessibility-ia2 mailing list [email protected] https://lists.linux-foundation.org/mailman/listinfo/accessibility-ia2
