-<node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
-
-<tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
-<tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
-<tp:copyright>Copyright 2001 Sun Microsystems, Inc.</tp:copyright>
-<tp:license xmlns="http://www.w3.org/1999/xhtml">
- <p>This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Library General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.</p>
-
- <p>This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Library General Public License for more details.</p>
-
- <p>You should have received a copy of the GNU Library General Public
- License along with this library; if not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.</p>
-</tp:license>
+<?xml version="1.0" encoding="UTF-8"?>
+<node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
<tp:enum name="TEXT_BOUNDARY_TYPE" type="u">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Specifies the boundary conditions determining a run of text as returned from
</tp:docstring>
<tp:enumvalue suffix="TEXT_BOUNDARY_CHAR">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< Text is bounded by this character only.
+ <p>Text is bounded by this character only.
Start and end offsets differ by one, by definition, for this value. </p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="TEXT_BOUNDARY_WORD_START" value="1">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< Boundary condition is start of a word; i.e. range is from start of
+ <p>Boundary condition is start of a word; i.e. range is from start of
one word to the start of another word. </p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="TEXT_BOUNDARY_WORD_END" value="2">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< Boundary condition is the end of a word; i.e. range is from
- the end of one word to the end of another.
- @note some locales may not distinguish between words and
+ <p>Boundary condition is the end of a word; i.e. range is from
+ the end of one word to the end of another.</p>
+ <p>Some locales may not distinguish between words and
characters or glyphs, in particular those locales which use
wholly or partially ideographic character sets. In these cases,
characters may be returned in lieu of multi-character substrings.</p>
</tp:enumvalue>
<tp:enumvalue suffix="TEXT_BOUNDARY_SENTENCE_START" value="3">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< Boundary condition is start of a sentence, as determined
- by the application.
- @note Some locales or character sets may not include explicit sentence
+ <p>Boundary condition is start of a sentence, as determined
+ by the application.</p>
+ <p>Some locales or character sets may not include explicit sentence
delimiters, so this boundary type can not always be honored.
Some locales will return lines of text instead of grammatical sentences.</p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="TEXT_BOUNDARY_SENTENCE_END" value="4">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< Boundary condition is end of a sentence, as determined by the application,
- including the sentence-delimiting character, for instance '.'
- @note Some locales or character sets may not include explicit sentence
+ <p>Boundary condition is end of a sentence, as determined by the application,
+ including the sentence-delimiting character, for instance '.'</p>
+ <p>Some locales or character sets may not include explicit sentence
delimiters, so this boundary type can not always be honored.
Some locales will return lines of text instead of grammatical sentences.</p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="TEXT_BOUNDARY_LINE_START" value="5">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< Boundary condition is the start of a line; i.e. range is
+ <p> Boundary condition is the start of a line; i.e. range is
from start of one line to the start of another. This generally
means that an end-of-line character will appear at the end of the range. </p>
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="TEXT_BOUNDARY_LINE_END" value="6">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>< Boundary condition is the end of a line; i.e. range is
+ <p> Boundary condition is the end of a line; i.e. range is
from start of one line to the start of another. This generally
means that an end-of-line character will be the first character of the range. </p>
</tp:docstring>
<tp:enumvalue suffix="TEXT_CLIP_NONE"/>
<tp:enumvalue suffix="TEXT_CLIP_MIN" value="1">
<tp:docstring>
- < characters/glyphs clipped by the minimum coordinate are omitted
+ Characters/glyphs clipped by the minimum coordinate are omitted
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="TEXT_CLIP_MAX" value="2">
<tp:docstring>
- < characters/glyphs which intersect the maximum coordinate are omitted
+ Characters/glyphs which intersect the maximum coordinate are omitted
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix="TEXT_CLIP_BOTH" value="3">
<tp:docstring>
- < only glyphs falling entirely within the region bounded by min and max are retained.
+ Only glyphs falling entirely within the region bounded by min and max are retained.
</tp:docstring>
</tp:enumvalue>
</tp:enum>
<p>In some cases a Text object may have, as its content, an empty string. In particular this can
occur in the case of Hypertext objects which do not display explicitly textual information onscreen,
- as Hypertext is derived from the Text interface. @see Hypertext. </p>
+ as Hypertext is derived from the Text interface, see Hypertext. </p>
<p>Typographic and semantic attributes of onscreen textual content, for instance typeface, weight,
language, and such qualities as 'emphasis' or 'blockquote', are represented as text attributes.
Contiguous sequences of characters over which these attributes are unchanged are referred to as
- "attribute runs", and are available via Text::getAttributeRun. Where possible, implementing clients
+ 'attribute runs', and are available via Text.getAttributeRun. Where possible, implementing clients
will report textual attributes which are the same over the entire text object, for instance those
inherited from a default or document-scope style, via getDefaultAttributes instead of reporting them
explicitly for each character. Therefore, for any span of text, the attributes in effect are the union
- of the set returned by Text::getDefaultAttributes, and the set returned at a particular character
- offset via Text::getAttributeRun. </p>
+ of the set returned by Text.getDefaultAttributes, and the set returned at a particular character
+ offset via Text.getAttributeRun. </p>
- <p>@note Events that may be emitted by instances of Text include:
- \li \c "object:text-attributes-changed" The attributes of a range of text, or the range over
- which attributes apply, has changed.
- \li \c "object:text-changed" The text content of this object has changed.
- \li \c "object:text-bounds-changed" The character bounds of a text object have changed,
- for instance in response to a reformatting or reflow operation.
- \li \c "object:text-caret-moved" The character offset of the text caret (visible or notional) within
- this object has changed. Events of this type may also be generated when an onscreen
- text caret appears or disappears.
- \li \c "object:text-selection-changed" The range or number of text selections within this text object
- has changed. </p>
+ <p>Events that may be emitted by instances of Text include:
+ <ol>
+ <li>'object:text-attributes-changed' The attributes of a range of text, or the range
+ over which attributes apply, has changed.</li>
+ <li>'object:text-changed' The text content of this object has changed.</li>
+ <li>'object:text-bounds-changed' The character bounds of a text object have changed,
+ for instance in response to a reformatting or reflow operation.</li>
+ <li>'object:text-caret-moved' The character offset of the text caret
+ (visible or notional) within this object has changed. Events of this
+ type may also be generated when an onscreen text caret appears or disappears.</li>
+ <li>'object:text-selection-changed' The range or number of text selections within
+ this text object has changed.</li>
+ </ol>
+ </p>
- <p>@note In some cases, objects which are not onscreen may implement Text, but if such objects
+ <p>In some cases, objects which are not onscreen may implement Text, but if such objects
implement Component, their potential visibility should be examined (via comparison with STATE_VISIBLE
and STATE_SHOWING) before exposing them to the user. Objects which implement Text but not Component
- may be encountered in special-purpose interfaces or as special ¨accessibility¨ extensions to visual
+ may be encountered in special-purpose interfaces or as special 'accessibility' extensions to visual
interfaces to allow non-graphical access to application features. These instances should be considered
the exception, rather than the rule.</p>
</tp:docstring>
<method name="getText">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Obtain all or part of the onscreen textual content of a Text object. If endOffset is specified as
- "-1", then this method will return the entire onscreen textual contents of the Text object.
- @note 'onscreen' in this context means "potentially onscreen", this method does not perform any sort
+ "-1", then this method will return the entire onscreen textual contents of the Text object.
+ onscreen' in this context means "potentially onscreen", this method does not perform any sort
of coordinate visibility clipping or window-stack-ordering clipping. The text thus reported
corresponds to the text which would be presented onscreen if the object implementing the Text interface
were entirely unobscured. </p>
<arg direction="in" name="endOffset" type="i"/>
<arg direction="out" type="s">
<tp:docstring>
- the textual content of the current Text object beginning startOffset (inclusive) up to but not including the character at endOffset.
+ The textual content of the current Text object beginning startOffset (inclusive) up to but not including the character at endOffset.
</tp:docstring>
</arg>
</method>
<method name="setCaretOffset">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Programmatically move the text caret (visible or virtual, as above) to a given position.
- @param offset a long int indicating the desired character offset. Not all implementations of
- Text will honor setCaretOffset requests, so the return value below should be checked by the client.</p>
+ <p>Programmatically move the text caret (visible or virtual, as above) to a given position.</p>
</tp:docstring>
- <arg direction="in" name="offset" type="i"/>
+ <arg direction="in" name="offset" type="i">
+ <tp:docstring>
+ A long int indicating the desired character offset. Not all implementations of
+ Text will honor setCaretOffset requests, so the return value below should be checked by the client.
+ </tp:docstring>
+ </arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c TRUE if the request was carried out, or \c FALSE if the caret could not be moved to the requested position.
+ <code>True</code> if the request was carried out, or <code>False</code> if the caret could not be moved to the requested position.
</tp:docstring>
</arg>
</method>
<method name="getTextBeforeOffset">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Obtain a subset of the text content of an object which entirely precedes \c offset,
- delimited by character, word, line, or sentence boundaries as specified by \c type. The
- starting and ending offsets of the resulting substring are returned in \c startOffset
- and \c endOffset. By definition, if such a substring exists, \c endOffset is less than or
- equal to \c offset.
- @param offset the offset from which the substring search begins.
- @param type the text-boundary delimiter which determines whether the returned text constitures
+ <p>Obtain a subset of the text content of an object which entirely precedes <code>offset</code>,
+ delimited by character, word, line, or sentence boundaries as specified by <code>type</code>. The
+ starting and ending offsets of the resulting substring are returned in <code>startOffset</code>
+ and <code>startOffset</code>. By definition, if such a substring exists, <code>startOffset</code>
+ is less than or equal to <code>offset.</code></p>
+ </tp:docstring>
+ <arg direction="in" name="offset" type="i">
+ <tp:docstring>
+ The offset from which the substring search begins.
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="type" type="u" tp:type="TEXT_BOUNDARY_TYPE">
+ <tp:docstring>
+ The text-boundary delimiter which determines whether the returned text constitures
a character, word, line, or sentence (and possibly attendant whitespace),
and whether the start or ending of such a substring forms the boundary condition.
- @param startOffset back-filled with the starting offset of the resulting substring, if one exists.
- @param endOffset back-filled with the offset of the character immediately following the resulting
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="startOffset" type="i">
+ <tp:docstring>
+ Back-filled with the starting offset of the resulting substring, if one exists.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="endOffset" type="i">
+ <tp:docstring>
+ Back-filled with the offset of the character immediately following the resulting
substring, if one exists.
- @see TEXT_BOUNDARY_TYPE</p>
- </tp:docstring>
- <arg direction="in" name="offset" type="i"/>
- <arg direction="in" name="type" type="u" tp:type="TEXT_BOUNDARY_TYPE"/>
- <arg direction="out" name="startOffset" type="i"/>
- <arg direction="out" name="endOffset" type="i"/>
+ </tp:docstring>
+ </arg>
<arg direction="out" type="s">
<tp:docstring>
- a string which is a substring of the text content of the object, delimited by thespecified boundary condition.
+ A string which is a substring of the text content of the object, delimited by thespecified boundary condition.
</tp:docstring>
</arg>
</method>
<method name="getTextAtOffset">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Obtain a subset of the text content of an object which includes the specified \c offset,
- delimited by character, word, line, or sentence boundaries as specified by \c type. The
- starting and ending offsets of the resulting substring are returned in \c startOffset
- and \c endOffset.
- @param offset the offset from which the substring search begins, and which must
+ <p>Obtain a subset of the text content of an object which includes the specified <code>offset</code>,
+ delimited by character, word, line, or sentence boundaries as specified by <code>type</code>. The
+ starting and ending offsets of the resulting substring are returned in <code>startOffset</code>
+ and <code>endOffset</code>.</p>
+ </tp:docstring>
+ <arg direction="in" name="offset" type="i">
+ <tp:docstring>
+ The offset from which the substring search begins, and which must
lie within the returned substring.
- @param type the text-boundary delimiter which determines whether the returned text constitures
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="type" type="u" tp:type="TEXT_BOUNDARY_TYPE">
+ <tp:docstring>
+ The text-boundary delimiter which determines whether the returned text constitures
a character, word, line, or sentence (and possibly attendant whitespace),
and whether the start or ending of such a substring forms the boundary condition.
- @param startOffset back-filled with the starting offset of the resulting substring, if one exists.
- @param endOffset back-filled with the offset of the character immediately following the resulting
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="startOffset" type="i">
+ <tp:docstring>
+ Back-filled with the starting offset of the resulting substring, if one exists.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="endOffset" type="i">
+ <tp:docstring>
+ Back-filled with the offset of the character immediately following the resulting
substring, if one exists.
- @see TEXT_BOUNDARY_TYPE</p>
- </tp:docstring>
- <arg direction="in" name="offset" type="i"/>
- <arg direction="in" name="type" type="u" tp:type="TEXT_BOUNDARY_TYPE"/>
- <arg direction="out" name="startOffset" type="i"/>
- <arg direction="out" name="endOffset" type="i"/>
+ </tp:docstring>
+ </arg>
<arg direction="out" type="s">
<tp:docstring>
- a string which is a substring of the text content of the object, delimited by thespecified boundary condition.
+ A string which is a substring of the text content of the object, delimited by thespecified boundary condition.
</tp:docstring>
</arg>
</method>
<method name="getTextAfterOffset">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Obtain a subset of the text content of an object which entirely follows \c offset,
- delimited by character, word, line, or sentence boundaries as specified by \c type. The
- starting and ending offsets of the resulting substring are returned in \c startOffset
- and \c endOffset. By definition, if such a substring exists, \c startOffset must be greater than
- \c offset.
- @param offset the offset from which the substring search begins, and which must
+ <p>Obtain a subset of the text content of an object which entirely follows <code>offset</code>,
+ delimited by character, word, line, or sentence boundaries as specified by <code>type</code>. The
+ starting and ending offsets of the resulting substring are returned in <code>startOffset</code>
+ and <code>endOffset</code>. By definition, if such a substring exists, <code>startOffset</code>
+ must be greater than <code>offset</code>.</p>
+ </tp:docstring>
+ <arg direction="in" name="offset" type="i">
+ <tp:docstring>
+ The offset from which the substring search begins, and which must
lie before the returned substring.
- @param type the text-boundary delimiter which determines whether the returned text constitures
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="type" type="u" tp:type="TEXT_BOUNDARY_TYPE">
+ <tp:docstring>
+ The text-boundary delimiter which determines whether the returned text constitures
a character, word, line, or sentence (and possibly attendant whitespace),
and whether the start or ending of such a substring forms the boundary condition.
- @param startOffset back-filled with the starting offset of the resulting substring, if one exists.
- @param endOffset back-filled with the offset of the character immediately following the resulting
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="startOffset" type="i">
+ <tp:docstring>
+ Back-filled with the starting offset of the resulting substring, if one exists.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="endOffset" type="i">
+ <tp:docstring>
+ Back-filled with the offset of the character immediately following the resulting
substring, if one exists.
- @see TEXT_BOUNDARY_TYPE</p>
- </tp:docstring>
- <arg direction="in" name="offset" type="i"/>
- <arg direction="in" name="type" type="u" tp:type="TEXT_BOUNDARY_TYPE"/>
- <arg direction="out" name="startOffset" type="i"/>
- <arg direction="out" name="endOffset" type="i"/>
+ </tp:docstring>
+ </arg>
<arg direction="out" type="s">
<tp:docstring>
- a string which is a substring of the text content of the object, delimited by thespecified boundary condition.
+ A string which is a substring of the text content of the object, delimited by thespecified boundary condition.
</tp:docstring>
</arg>
</method>
<arg name="offset" type="i" direction="in"/>
<arg type="i" direction="out">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- an unsigned long integer whose value corresponds to the UCS-4 representation of the
+ An unsigned long integer whose value corresponds to the UCS-4 representation of the
character at the specified text offset, or 0 if offset is out of range.
- long instead of wchar, to allow unicode chars > 16 bits
+ long instead of wchar, to allow unicode chars 16 bits
</tp:docstring>
</arg>
</method>
<method name="getAttributeValue">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Get the string value of a named attribute at a given offset, if defined.
- @param offset the offset of the character for which the attribute run is to be obtained.
- @param attributeName the name of the attribute for which the value is to be returned, if defined.
- @param startOffset back-filled with the offset of the first character in the attribute run
- containing the character at \c offset.
- @param endOffset back-filled with the offset of the first character past the end of the
- attribute run containing the character at \c offset.
- @param defined back-filled with \c True if the attributeName has a defined value at \c offset,
- \c False otherwise.</p>
+ <p>Get the string value of a named attribute at a given offset, if defined.</p>
</tp:docstring>
- <arg direction="in" name="offset" type="i"/>
- <arg direction="in" name="attributeName" type="s"/>
- <arg direction="out" name="startOffset" type="i"/>
- <arg direction="out" name="endOffset" type="i"/>
- <arg direction="out" name="defined" type="b" tp:type="boolean"/>
+ <arg direction="in" name="offset" type="i">
+ <tp:docstring>
+ The offset of the character for which the attribute run is to be obtained.
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="attributeName" type="s">
+ <tp:docstring>
+ The name of the attribute for which the value is to be returned, if defined.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="startOffset" type="i">
+ <tp:docstring>
+ Back-filled with the offset of the first character in the attribute run
+ containing the character at <code>offset</code>.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="endOffset" type="i">
+ <tp:docstring>
+ Back-filled with the offset of the first character past the end of the
+ attribute run containing the character at <code>offset</code>.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="defined" type="b" tp:type="boolean">
+ <tp:docstring>
+ Back-filled with <code>True</code> if the attributeName has a defined value at <code>offset</code>,
+ <code>False</code> otherwise.
+ </tp:docstring>
+ </arg>
<arg direction="out" type="s">
<tp:docstring>
- the value of attribute (name-value pair) corresponding to "name", if defined.
+ The value of attribute (name-value pair) corresponding to "name", if defined.
</tp:docstring>
</arg>
</method>
<arg direction="out" name="endOffset" type="i"/>
<arg direction="out" type="s">
<tp:docstring>
- the attributes at offset, as a semicolon-delimited set of colon-delimited name-value pairs. @see getAttributeRun
+ The attributes at offset, as a semicolon-delimited set of colon-delimited name-value pairs. @see getAttributeRun
</tp:docstring>
</arg>
</method>
</tp:docstring>
<arg direction="out" type="s">
<tp:docstring>
- the attributes which apply to the entire text content, but which were not explicitlyspecified by the content creator.@see getDefaultAttributeSet
+ The attributes which apply to the entire text content, but which were not explicitlyspecified by the content creator.
</tp:docstring>
</arg>
</method>
character offset in this object's text content. The coordinate system in which the results are
reported is specified by coordType. If an onscreen glyph corresponds to multiple character offsets,
for instance if the glyph is a ligature, the bounding box reported will include the entire glyph and
- therefore may apply to more than one character offset.
- @param offset the character offset of the character or glyph being queried.
- @param x the minimum horizontal coordinate of the bounding box of the glyph representing
- the character at \c offset.
- @param y the minimum vertical coordinate of the bounding box of the glyph representing
- the character at \c offset.
- @param width the horizontal extent of the bounding box of the glyph representing
- the character at \c offset.
- @param height the vertical extent of the bounding box of the glyph representing
- the character at \c offset.
- @param coordType If 0, the results will be reported in screen coordinates, i.e. in pixels
+ therefore may apply to more than one character offset.</p>
+ </tp:docstring>
+ <arg direction="in" name="offset" type="i">
+ <tp:docstring>
+ The character offset of the character or glyph being queried.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="x" type="i">
+ <tp:docstring>
+ The minimum horizontal coordinate of the bounding box of the glyph representing
+ the character at <code>offset</code>.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="y" type="i">
+ <tp:docstring>
+ The minimum vertical coordinate of the bounding box of the glyph representing
+ the character at <code>offset</code>.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="width" type="i">
+ <tp:docstring>
+ The horizontal extent of the bounding box of the glyph representing
+ the character at <code>offset</code>.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="height" type="i">
+ <tp:docstring>
+ The vertical extent of the bounding box of the glyph representing
+ the character at <code>offset</code>.
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="coordType" type="n" tp:type="short">
+ <tp:docstring>
+ <p>If 0, the results will be reported in screen coordinates, i.e. in pixels
relative to the upper-left corner of the screen, with the x axis pointing right
and the y axis pointing down.
If 1, the results will be reported relative to the containing toplevel window,
with the x axis pointing right and the y axis pointing down.</p>
- </tp:docstring>
- <arg direction="in" name="offset" type="i"/>
- <arg direction="out" name="x" type="i"/>
- <arg direction="out" name="y" type="i"/>
- <arg direction="out" name="width" type="i"/>
- <arg direction="out" name="height" type="i"/>
- <arg direction="in" name="coordType" type="n" tp:type="short"/>
+ </tp:docstring>
+ </arg>
</method>
<method name="getOffsetAtPoint">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Get the offset of the character at a given onscreen coordinate. The coordinate system used to interpret
- x and y is determined by parameter coordType.
- @param x
- @param y
- @param coordType if 0, the input coordinates are interpreted relative to the entire screen, if 1,
- they are relative to the toplevel window containing this Text object.</p>
+ x and y is determined by parameter coordType.</p>
</tp:docstring>
<arg direction="in" name="x" type="i"/>
<arg direction="in" name="y" type="i"/>
- <arg direction="in" name="coordType" type="n" tp:type="short"/>
+ <arg direction="in" name="coordType" type="n" tp:type="short">
+ <tp:docstring>
+ If 0, the input coordinates are interpreted relative to the entire screen, if 1,
+ they are relative to the toplevel window containing this Text object.
+ </tp:docstring>
+ </arg>
<arg direction="out" type="i">
<tp:docstring>
- the text offset (as an offset into the character array) of the glyph whose onscreen bounds contain the point x,y, or -1 if the point is outside the bounds of any glyph.
+ The text offset (as an offset into the character array) of the glyph whose onscreen bounds contain the point x,y, or -1 if the point is outside the bounds of any glyph.
</tp:docstring>
</arg>
</method>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Obtain the number of separate, contiguous selections in the current Text object.
Text objects which do not implement selection of discontiguous text regions will always
- return '0' or '1'. Note that "contiguous" is defined by continuity of the offsets, i.e.
+ return '0' or '1'. Note that "contiguous" is defined by continuity of the offsets, i.e.
a text 'selection' is defined by a start/end offset pair. In the case of bidirectional text,
this means that a continguous selection may appear visually discontiguous, and vice-versa. </p>
</tp:docstring>
<arg direction="out" type="i">
<tp:docstring>
- the number of contiguous selections in the current Text object.
+ The number of contiguous selections in the current Text object.
</tp:docstring>
</arg>
</method>
<arg direction="in" name="endOffset" type="i"/>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True of the selection was successfully added, \c False otherwise. Selection mayfail if the object does not support selection of text (see STATE_SELECTABLE_TEXT), if theobject does not support multiple selections and a selection is already defined, or for other reasons(for instance if the user does not have permission to copy the text into the relevant selection buffer).
+ <code>True</code> of the selection was successfully added, <code>False</code> otherwise. Selection mayfail if the object does not support selection of text (see STATE_SELECTABLE_TEXT), if theobject does not support multiple selections and a selection is already defined, or for other reasons(for instance if the user does not have permission to copy the text into the relevant selection buffer).
</tp:docstring>
</arg>
</method>
<arg direction="in" name="selectionNum" type="i"/>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the selection was successfully removed, \c False otherwise.
+ <code>True</code> if the selection was successfully removed, <code>False</code> otherwise.
</tp:docstring>
</arg>
</method>
<p>Calling setSelection for a selectionNum that is not already defined has no effect.
The result of calling setSelection with a selectionNum greater than 0 for objects that
- do not include STATE_MULTISELECTABLE is undefined.
- @param selectionNum indicates which of a set of non-contiguous selections to modify.
- @param startOffset the new starting offset for the selection
- @param endOffset the new ending offset for the selection</p>
+ do not include STATE_MULTISELECTABLE is undefined.</p>
</tp:docstring>
- <arg direction="in" name="selectionNum" type="i"/>
- <arg direction="in" name="startOffset" type="i"/>
- <arg direction="in" name="endOffset" type="i"/>
+ <arg direction="in" name="selectionNum" type="i">
+ <tp:docstring>
+ Indicates which of a set of non-contiguous selections to modify.
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="startOffset" type="i">
+ <tp:docstring>
+ The new starting offset for the selection
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="endOffset" type="i">
+ <tp:docstring>
+ The new ending offset for the selection
+ </tp:docstring>
+ </arg>
<arg direction="out" type="b" tp:type="boolean">
<tp:docstring>
- \c True if the selection corresponding to selectionNum is successfully modified, \c False otherwise.
+ <code>True</code> if the selection corresponding to selectionNum is successfully
+ modified, <code>False</code> otherwise.
</tp:docstring>
</arg>
</method>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Obtain the bounding box which entirely contains a given text range.
Negative values may be returned for the bounding box parameters in the event
- that all or part of the text range is offscreen or not mapped to the screen.
+ that all or part of the text range is offscreen or not mapped to the screen.</p>
+ </tp:docstring>
+ <arg direction="in" name="startOffset" type="i">
+ <tp:docstring>
@param startOffset the offset of the first character in the specified range.
- @param endOffset the offset of the character immediately after the last
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="endOffset" type="i">
+ <tp:docstring>
+ The offset of the character immediately after the last
character in the specified range.
- @param x an integer parameter which is back-filled with the minimum
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="x" type="i">
+ <tp:docstring>
+ An integer parameter which is back-filled with the minimum
horizontal coordinate of the resulting bounding box.
- @param y an integer parameter which is back-filled with the minimum
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="y" type="i">
+ <tp:docstring>
+ An integer parameter which is back-filled with the minimum
vertical coordinate of the resulting bounding box.
- @param width an integer parameter which is back-filled with the
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="width" type="i">
+ <tp:docstring>
+ An integer parameter which is back-filled with the
horizontal extent of the bounding box.
- @param height an integer parameter which is back-filled with the
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="height" type="i">
+ <tp:docstring>
+ </tp:docstring>
+ An integer parameter which is back-filled with the
vertical extent of the bounding box.
- @param coordType If 0, the above coordinates are reported in pixels relative to
+ </arg>
+ <arg direction="in" name="coordType" type="n" tp:type="short">
+ <tp:docstring>
+ If 0, the above coordinates are reported in pixels relative to
corner of the screen; if 1, the coordinates are reported relative to the
- corner of the containing toplevel window.</p>
+ corner of the containing toplevel window.
</tp:docstring>
- <arg direction="in" name="startOffset" type="i"/>
- <arg direction="in" name="endOffset" type="i"/>
- <arg direction="out" name="x" type="i"/>
- <arg direction="out" name="y" type="i"/>
- <arg direction="out" name="width" type="i"/>
- <arg direction="out" name="height" type="i"/>
- <arg direction="in" name="coordType" type="n" tp:type="short"/>
+ </arg>
</method>
<method name="getBoundedRanges">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
Depending on the TEXT_CLIP_TYPE parameters, glyphs which are clipped by the
bounding box (i.e. which lie partially inside and partially outside it)
may or may not be included in the ranges returned.
- @note This method may be of particular interest to screen review algorithms.
- @see TEXT_CLIP_TYPE.
- @param x the minimum x ( i.e. leftmost) coordinate of the bounding box.
- @param y the minimum y coordinate of the bounding box.
- @param width the horizontal size of the bounding box. The rightmost bound of the bounding box
+ This method may be of particular interest to screen review algorithms.</p>
+ </tp:docstring>
+ <arg direction="in" name="x" type="i">
+ <tp:docstring>
+ The minimum x ( i.e. leftmost) coordinate of the bounding box.
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="y" type="i">
+ <tp:docstring>
+ The minimum y coordinate of the bounding box.
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="width" type="i">
+ <tp:docstring>
+ The horizontal size of the bounding box. The rightmost bound of the bounding box
is (x + width);
- @param height the vertical size of the bounding box. The maximum y value of the bounding box
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="height" type="i">
+ <tp:docstring>
+ The vertical size of the bounding box. The maximum y value of the bounding box
is (y + height);
- @param coordType If 0, the above coordinates are interpreted as pixels relative to
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="coordType" type="n" tp:type="short">
+ <tp:docstring>
+ If 0, the above coordinates are interpreted as pixels relative to
corner of the screen; if 1, the coordinates are interpreted as pixels relative to the
corner of the containing toplevel window.
- @param xClipType determines whether text which intersects the bounding box in the x direction
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="xClipType" type="u" tp:type="TEXT_CLIP_TYPE">
+ <tp:docstring>
+ Determines whether text which intersects the bounding box in the x direction
is included.
- @param yClipType determines whether text which intersects the bounding box in the y direction
- is included.</p>
- </tp:docstring>
- <arg direction="in" name="x" type="i"/>
- <arg direction="in" name="y" type="i"/>
- <arg direction="in" name="width" type="i"/>
- <arg direction="in" name="height" type="i"/>
- <arg direction="in" name="coordType" type="n" tp:type="short"/>
- <arg direction="in" name="xClipType" type="u" tp:type="TEXT_CLIP_TYPE"/>
- <arg direction="in" name="yClipType" type="u" tp:type="TEXT_CLIP_TYPE"/>
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="yClipType" type="u" tp:type="TEXT_CLIP_TYPE">
+ <tp:docstring>
+ Determines whether text which intersects the bounding box in the y direction
+ is included.
+ </tp:docstring>
+ </arg>
<arg direction="out" type="a(iisv)" tp:type="RangeList"/>
</method>
<method name="getAttributeRun">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Query a particular text object for the text attributes defined at a given offset,
- obtaining the start and end of the "attribute run" over which these attributes are currently
+ obtaining the start and end of the "attribute run" over which these attributes are currently
invariant. Text attributes are those presentational, typographic, or semantic attributes or
qualitites which apply to a range of text specifyable by starting and ending offsets.
Attributes relevant to localization should be provided in
- accordance with the w3c "Internationalization and Localization Markup Requirements",
+ accordance with the w3c "Internationalization and Localization Markup Requirements",
http://www.w3.org/TR/2005/WD-itsreq-20051122/
Other text attributes should choose their names and value semantics in accordance with relevant
standards such as CSS level 2 (http://www.w3.org/TR/1998/REC-CSS2-19980512),
WICD (http://www.w3.org/TR/2005/WD-WICD-20051121/). Those attributes from the aforementioned
specifications and recommendations which do not concern typographic, presentational, or
semantic aspects of text should be exposed via the more general Accessible::getAttributes() API
- (if at all). </p>
+ (if at all).</p>
<p>For example, CSS attributes which should be exposed on text (either as default attributes, or
as explicitly-set attributes when non-default values are specified in the content view) include
- the Font attributes (i.e. "css2:font-weight", "css2:font-style"),
- the "css2:color" and "css2:background-color" attributes, and "css2:text-decoration" attribute. </p>
+ the Font attributes (i.e. "css2:font-weight", "css2:font-style"),
+ the "css2:color" and "css2:background-color" attributes, and "css2:text-decoration" attribute. </p>
- <p>If includeDefaults is TRUE, then this AttributeSet should include the default
+ <p>If includeDefaults is <code>True</code>, then this AttributeSet should include the default
attributes as well as those which are explicitly assigned to the attribute run in question.
startOffset and endOffset will be back-filled to indicate the start and end of the attribute run
which contains 'offset' - an attribute run is a contiguous section of text whose attributes are
- homogeneous.
- @param offset the offset of the character whose attributes will be reported.
- @param startOffset backfilled with the starting offset of the character range over which all
- text attributes match those of \c offset, i.e. the start of the homogeneous
- attribute run including \c offset.
- @param endOffset backfilled with the offset of the first character past the character range over which all
- text attributes match those of \c offset, i.e. the character immediately after
- the homogeneous attribute run including \c offset.
- @param includeDefaults if False, the call should only return those attributes which are
- explicitly set on the current attribute run, omitting any attributes which are inherited from
- the default values. See also Text::getDefaultAttributes. </p>
+ homogeneous. </p>
- <p>@note Clients seeking annotations or properties of a more general nature, which
+ <p>Clients seeking annotations or properties of a more general nature, which
are not specific to the onscreen textual content of objects and cannot logically be applied
to specific character offset ranges,
- should use Accessible::getAttributes instead.
- The attributes returned by Text::getAttributeRun (with or without 'default attributes'),
- are distinct from the properties/attributes returned by Accessible::getAttributes. </p>
-
- <p>@see Accessible::getAttributes </p>
- </tp:docstring>
- <arg direction="in" name="offset" type="i"/>
- <arg direction="out" name="startOffset" type="i"/>
- <arg direction="out" name="endOffset" type="i"/>
- <arg direction="in" name="includeDefaults" type="b" tp:type="boolean"/>
+ should use Accessible.getAttributes instead.
+ The attributes returned by Text.getAttributeRun (with or without 'default attributes'),
+ are distinct from the properties/attributes returned by Accessible.getAttributes. </p>
+ </tp:docstring>
+ <arg direction="in" name="offset" type="i">
+ <tp:docstring>
+ The offset of the character whose attributes will be reported.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="startOffset" type="i">
+ <tp:docstring>
+ Backfilled with the starting offset of the character range over which all
+ text attributes match those of <code>offset</code>, i.e. the start of the homogeneous
+ attribute run including <code>offset</code>.
+ </tp:docstring>
+ </arg>
+ <arg direction="out" name="endOffset" type="i">
+ <tp:docstring>
+ Backfilled with the offset of the first character past the character range over which all
+ text attributes match those of <code>offset</code>, i.e. the character immediately after
+ the homogeneous attribute run including <code>offset</code>.
+ </tp:docstring>
+ </arg>
+ <arg direction="in" name="includeDefaults" type="b" tp:type="boolean">
+ <tp:docstring>
+ If False, the call should only return those attributes which are
+ explicitly set on the current attribute run, omitting any attributes which are inherited from
+ the default values. See also Text.getDefaultAttributes.
+ </tp:docstring>
+ </arg>
<arg direction="out" type="as" tp:type="AttributeSet">
<tp:docstring>
- the AttributeSet defined at offset, optionally including the 'default' attributes. @since AT-SPI 1.7.0
+ The AttributeSet defined at offset, optionally including the 'default' attributes.
</tp:docstring>
</arg>
</method>
<method name="getDefaultAttributeSet">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Return an ::AttributeSet containing the text attributes which apply to all text in the object
+ <p>Return an AttributeSet containing the text attributes which apply to all text in the object
by virtue of the default settings of the document, view, or user agent; e.g. those
attributes which are implied rather than explicitly applied to the text object.
For instance, an object whose entire text content has been explicitly marked as 'bold' will
report the 'bold' attribute via getAttributeRun(), whereas an object whose text weight is
inspecified may report the default or implied text weight in the default AttributeSet. </p>
-
- <p>@since AT-SPI 1.7.0</p>
</tp:docstring>
<arg direction="out" type="as" tp:type="AttributeSet"/>
</method>
- <method name="unImplemented">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>\cond
- unImplemented: </p>
-
- <p>placeholders for future expansion.</p>
- </tp:docstring>
- </method>
- <method name="unImplemented2">
- </method>
</interface>
</node>
projects / platform / core / uifw / at-spi2-atk.git / blobdiff