1 <?xml version="1.0" encoding="UTF-8"?>
2 <node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
8 <tp:enum name="TEXT_BOUNDARY_TYPE" type="u">
9 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
10 <p>Specifies the boundary conditions determining a run of text as returned from
11 getTextAtOffset, getTextAfterOffset, and getTextBeforeOffset.</p>
13 <tp:enumvalue suffix="TEXT_BOUNDARY_CHAR">
14 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
15 <p>< Text is bounded by this character only.
16 Start and end offsets differ by one, by definition, for this value. </p>
19 <tp:enumvalue suffix="TEXT_BOUNDARY_WORD_START" value="1">
20 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
21 <p>< Boundary condition is start of a word; i.e. range is from start of
22 one word to the start of another word. </p>
25 <tp:enumvalue suffix="TEXT_BOUNDARY_WORD_END" value="2">
26 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
27 <p>< Boundary condition is the end of a word; i.e. range is from
28 the end of one word to the end of another.
29 @note some locales may not distinguish between words and
30 characters or glyphs, in particular those locales which use
31 wholly or partially ideographic character sets. In these cases,
32 characters may be returned in lieu of multi-character substrings.</p>
35 <tp:enumvalue suffix="TEXT_BOUNDARY_SENTENCE_START" value="3">
36 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
37 <p>< Boundary condition is start of a sentence, as determined
39 @note Some locales or character sets may not include explicit sentence
40 delimiters, so this boundary type can not always be honored.
41 Some locales will return lines of text instead of grammatical sentences.</p>
44 <tp:enumvalue suffix="TEXT_BOUNDARY_SENTENCE_END" value="4">
45 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
46 <p>< Boundary condition is end of a sentence, as determined by the application,
47 including the sentence-delimiting character, for instance '.'
48 @note Some locales or character sets may not include explicit sentence
49 delimiters, so this boundary type can not always be honored.
50 Some locales will return lines of text instead of grammatical sentences.</p>
53 <tp:enumvalue suffix="TEXT_BOUNDARY_LINE_START" value="5">
54 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
55 <p>< Boundary condition is the start of a line; i.e. range is
56 from start of one line to the start of another. This generally
57 means that an end-of-line character will appear at the end of the range. </p>
60 <tp:enumvalue suffix="TEXT_BOUNDARY_LINE_END" value="6">
61 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
62 <p>< Boundary condition is the end of a line; i.e. range is
63 from start of one line to the start of another. This generally
64 means that an end-of-line character will be the first character of the range. </p>
68 <tp:enum name="TEXT_CLIP_TYPE" type="u">
69 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
71 CLIP_MIN means text clipped by min coordinate is omitted,
72 CLIP_MAX clips text interescted by the max coord, and CLIP_BOTH
73 will retain only text falling fully within the min/max bounds. </p>
75 <tp:enumvalue suffix="TEXT_CLIP_NONE"/>
76 <tp:enumvalue suffix="TEXT_CLIP_MIN" value="1">
78 < characters/glyphs clipped by the minimum coordinate are omitted
81 <tp:enumvalue suffix="TEXT_CLIP_MAX" value="2">
83 < characters/glyphs which intersect the maximum coordinate are omitted
86 <tp:enumvalue suffix="TEXT_CLIP_BOTH" value="3">
88 < only glyphs falling entirely within the region bounded by min and max are retained.
92 <interface name="org.freedesktop.atspi.Text">
93 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
94 <p>The text interface should be implemented by objects which place textual information onscreen as character
95 strings or glyphs. The text interface allows access to textual content, including display attributes and
96 semantic hints associated with runs of text, and access to bounding box information for glyphs and substrings.
97 It also allows portions of textual content to be selected, if the object's StateSet includes
98 STATE_SELECTABLE_TEXT. </p>
100 <p>In some cases a Text object may have, as its content, an empty string. In particular this can
101 occur in the case of Hypertext objects which do not display explicitly textual information onscreen,
102 as Hypertext is derived from the Text interface. @see Hypertext. </p>
104 <p>Typographic and semantic attributes of onscreen textual content, for instance typeface, weight,
105 language, and such qualities as 'emphasis' or 'blockquote', are represented as text attributes.
106 Contiguous sequences of characters over which these attributes are unchanged are referred to as
107 "attribute runs", and are available via Text::getAttributeRun. Where possible, implementing clients
108 will report textual attributes which are the same over the entire text object, for instance those
109 inherited from a default or document-scope style, via getDefaultAttributes instead of reporting them
110 explicitly for each character. Therefore, for any span of text, the attributes in effect are the union
111 of the set returned by Text::getDefaultAttributes, and the set returned at a particular character
112 offset via Text::getAttributeRun. </p>
114 <p>@note Events that may be emitted by instances of Text include:
115 \li \c "object:text-attributes-changed" The attributes of a range of text, or the range over
116 which attributes apply, has changed.
117 \li \c "object:text-changed" The text content of this object has changed.
118 \li \c "object:text-bounds-changed" The character bounds of a text object have changed,
119 for instance in response to a reformatting or reflow operation.
120 \li \c "object:text-caret-moved" The character offset of the text caret (visible or notional) within
121 this object has changed. Events of this type may also be generated when an onscreen
122 text caret appears or disappears.
123 \li \c "object:text-selection-changed" The range or number of text selections within this text object
126 <p>@note In some cases, objects which are not onscreen may implement Text, but if such objects
127 implement Component, their potential visibility should be examined (via comparison with STATE_VISIBLE
128 and STATE_SHOWING) before exposing them to the user. Objects which implement Text but not Component
129 may be encountered in special-purpose interfaces or as special ¨accessibility¨ extensions to visual
130 interfaces to allow non-graphical access to application features. These instances should be considered
131 the exception, rather than the rule.</p>
133 <tp:struct name="Range">
134 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
135 <p>A structure used to define a continguous range of text, including its
136 (unattributed) textual content. </p>
138 <tp:member type="i" tp:name="startOffset"/>
139 <tp:member type="i" tp:name="endOffset"/>
140 <tp:member type="s" tp:name="content"/>
141 <tp:member type="v" tp:name="data"/>
143 <tp:property name="characterCount" type="i" access="read">
144 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
145 <p>The total current number of characters in the Text object,
146 including whitespace and non-spacing characters. </p>
149 <tp:property name="caretOffset" type="i" access="read">
150 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
151 <p>The current offset of the text caret in the Text object.
152 This caret may be virtual, e.g. non-visual and notional-only, but if an
153 onscreen representation of the caret position is visible, it will correspond to this offset.
154 The caret offset is given as a character offset, as opposed to a byte offset into
155 a text buffer or a column offset. </p>
158 <method name="getText">
159 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
160 <p>Obtain all or part of the onscreen textual content of a Text object. If endOffset is specified as
161 "-1", then this method will return the entire onscreen textual contents of the Text object.
162 @note 'onscreen' in this context means "potentially onscreen", this method does not perform any sort
163 of coordinate visibility clipping or window-stack-ordering clipping. The text thus reported
164 corresponds to the text which would be presented onscreen if the object implementing the Text interface
165 were entirely unobscured. </p>
167 <arg direction="in" name="startOffset" type="i"/>
168 <arg direction="in" name="endOffset" type="i"/>
169 <arg direction="out" type="s">
171 the textual content of the current Text object beginning startOffset (inclusive) up to but not including the character at endOffset.
175 <method name="setCaretOffset">
176 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
177 <p>Programmatically move the text caret (visible or virtual, as above) to a given position.
178 @param offset a long int indicating the desired character offset. Not all implementations of
179 Text will honor setCaretOffset requests, so the return value below should be checked by the client.</p>
181 <arg direction="in" name="offset" type="i"/>
182 <arg direction="out" type="b" tp:type="boolean">
184 \c TRUE if the request was carried out, or \c FALSE if the caret could not be moved to the requested position.
188 <method name="getTextBeforeOffset">
189 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
190 <p>Obtain a subset of the text content of an object which entirely precedes \c offset,
191 delimited by character, word, line, or sentence boundaries as specified by \c type. The
192 starting and ending offsets of the resulting substring are returned in \c startOffset
193 and \c endOffset. By definition, if such a substring exists, \c endOffset is less than or
195 @param offset the offset from which the substring search begins.
196 @param type the text-boundary delimiter which determines whether the returned text constitures
197 a character, word, line, or sentence (and possibly attendant whitespace),
198 and whether the start or ending of such a substring forms the boundary condition.
199 @param startOffset back-filled with the starting offset of the resulting substring, if one exists.
200 @param endOffset back-filled with the offset of the character immediately following the resulting
201 substring, if one exists.
202 @see TEXT_BOUNDARY_TYPE</p>
204 <arg direction="in" name="offset" type="i"/>
205 <arg direction="in" name="type" type="u" tp:type="TEXT_BOUNDARY_TYPE"/>
206 <arg direction="out" name="startOffset" type="i"/>
207 <arg direction="out" name="endOffset" type="i"/>
208 <arg direction="out" type="s">
210 a string which is a substring of the text content of the object, delimited by thespecified boundary condition.
214 <method name="getTextAtOffset">
215 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
216 <p>Obtain a subset of the text content of an object which includes the specified \c offset,
217 delimited by character, word, line, or sentence boundaries as specified by \c type. The
218 starting and ending offsets of the resulting substring are returned in \c startOffset
220 @param offset the offset from which the substring search begins, and which must
221 lie within the returned substring.
222 @param type the text-boundary delimiter which determines whether the returned text constitures
223 a character, word, line, or sentence (and possibly attendant whitespace),
224 and whether the start or ending of such a substring forms the boundary condition.
225 @param startOffset back-filled with the starting offset of the resulting substring, if one exists.
226 @param endOffset back-filled with the offset of the character immediately following the resulting
227 substring, if one exists.
228 @see TEXT_BOUNDARY_TYPE</p>
230 <arg direction="in" name="offset" type="i"/>
231 <arg direction="in" name="type" type="u" tp:type="TEXT_BOUNDARY_TYPE"/>
232 <arg direction="out" name="startOffset" type="i"/>
233 <arg direction="out" name="endOffset" type="i"/>
234 <arg direction="out" type="s">
236 a string which is a substring of the text content of the object, delimited by thespecified boundary condition.
240 <method name="getTextAfterOffset">
241 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
242 <p>Obtain a subset of the text content of an object which entirely follows \c offset,
243 delimited by character, word, line, or sentence boundaries as specified by \c type. The
244 starting and ending offsets of the resulting substring are returned in \c startOffset
245 and \c endOffset. By definition, if such a substring exists, \c startOffset must be greater than
247 @param offset the offset from which the substring search begins, and which must
248 lie before the returned substring.
249 @param type the text-boundary delimiter which determines whether the returned text constitures
250 a character, word, line, or sentence (and possibly attendant whitespace),
251 and whether the start or ending of such a substring forms the boundary condition.
252 @param startOffset back-filled with the starting offset of the resulting substring, if one exists.
253 @param endOffset back-filled with the offset of the character immediately following the resulting
254 substring, if one exists.
255 @see TEXT_BOUNDARY_TYPE</p>
257 <arg direction="in" name="offset" type="i"/>
258 <arg direction="in" name="type" type="u" tp:type="TEXT_BOUNDARY_TYPE"/>
259 <arg direction="out" name="startOffset" type="i"/>
260 <arg direction="out" name="endOffset" type="i"/>
261 <arg direction="out" type="s">
263 a string which is a substring of the text content of the object, delimited by thespecified boundary condition.
267 <method name="getCharacterOffset">
268 <arg name="offset" type="i" direction="in"/>
269 <arg type="i" direction="out">
270 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
271 an unsigned long integer whose value corresponds to the UCS-4 representation of the
272 character at the specified text offset, or 0 if offset is out of range.
273 long instead of wchar, to allow unicode chars > 16 bits
277 <method name="getAttributeValue">
278 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
279 <p>Get the string value of a named attribute at a given offset, if defined.
280 @param offset the offset of the character for which the attribute run is to be obtained.
281 @param attributeName the name of the attribute for which the value is to be returned, if defined.
282 @param startOffset back-filled with the offset of the first character in the attribute run
283 containing the character at \c offset.
284 @param endOffset back-filled with the offset of the first character past the end of the
285 attribute run containing the character at \c offset.
286 @param defined back-filled with \c True if the attributeName has a defined value at \c offset,
287 \c False otherwise.</p>
289 <arg direction="in" name="offset" type="i"/>
290 <arg direction="in" name="attributeName" type="s"/>
291 <arg direction="out" name="startOffset" type="i"/>
292 <arg direction="out" name="endOffset" type="i"/>
293 <arg direction="out" name="defined" type="b" tp:type="boolean"/>
294 <arg direction="out" type="s">
296 the value of attribute (name-value pair) corresponding to "name", if defined.
300 <method name="getAttributes">
302 getAttributes is deprecated in favor of getAttributeRun.
304 <arg direction="in" name="offset" type="i"/>
305 <arg direction="out" name="startOffset" type="i"/>
306 <arg direction="out" name="endOffset" type="i"/>
307 <arg direction="out" type="s">
309 the attributes at offset, as a semicolon-delimited set of colon-delimited name-value pairs. @see getAttributeRun
313 <method name="getDefaultAttributes">
315 Deprecated in favor of getDefaultAttributeSet.
317 <arg direction="out" type="s">
319 the attributes which apply to the entire text content, but which were not explicitlyspecified by the content creator.@see getDefaultAttributeSet
323 <method name="getCharacterExtents">
324 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
325 <p>Obtain a the bounding box, as x, y, width, and height, of the character or glyph at a particular
326 character offset in this object's text content. The coordinate system in which the results are
327 reported is specified by coordType. If an onscreen glyph corresponds to multiple character offsets,
328 for instance if the glyph is a ligature, the bounding box reported will include the entire glyph and
329 therefore may apply to more than one character offset.
330 @param offset the character offset of the character or glyph being queried.
331 @param x the minimum horizontal coordinate of the bounding box of the glyph representing
332 the character at \c offset.
333 @param y the minimum vertical coordinate of the bounding box of the glyph representing
334 the character at \c offset.
335 @param width the horizontal extent of the bounding box of the glyph representing
336 the character at \c offset.
337 @param height the vertical extent of the bounding box of the glyph representing
338 the character at \c offset.
339 @param coordType If 0, the results will be reported in screen coordinates, i.e. in pixels
340 relative to the upper-left corner of the screen, with the x axis pointing right
341 and the y axis pointing down.
342 If 1, the results will be reported relative to the containing toplevel window,
343 with the x axis pointing right and the y axis pointing down.</p>
345 <arg direction="in" name="offset" type="i"/>
346 <arg direction="out" name="x" type="i"/>
347 <arg direction="out" name="y" type="i"/>
348 <arg direction="out" name="width" type="i"/>
349 <arg direction="out" name="height" type="i"/>
350 <arg direction="in" name="coordType" type="n" tp:type="short"/>
352 <method name="getOffsetAtPoint">
353 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
354 <p>Get the offset of the character at a given onscreen coordinate. The coordinate system used to interpret
355 x and y is determined by parameter coordType.
358 @param coordType if 0, the input coordinates are interpreted relative to the entire screen, if 1,
359 they are relative to the toplevel window containing this Text object.</p>
361 <arg direction="in" name="x" type="i"/>
362 <arg direction="in" name="y" type="i"/>
363 <arg direction="in" name="coordType" type="n" tp:type="short"/>
364 <arg direction="out" type="i">
366 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.
370 <method name="getNSelections">
371 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
372 <p>Obtain the number of separate, contiguous selections in the current Text object.
373 Text objects which do not implement selection of discontiguous text regions will always
374 return '0' or '1'. Note that "contiguous" is defined by continuity of the offsets, i.e.
375 a text 'selection' is defined by a start/end offset pair. In the case of bidirectional text,
376 this means that a continguous selection may appear visually discontiguous, and vice-versa. </p>
378 <arg direction="out" type="i">
380 the number of contiguous selections in the current Text object.
384 <method name="getSelection">
385 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
386 <p>The result of calling getSelection with an out-of-range selectionNum (i.e. for a selection
387 which does not exist) is not strictly defined, but should set endOffset equal to startOffset.</p>
389 <arg direction="in" name="selectionNum" type="i"/>
390 <arg direction="out" name="startOffset" type="i"/>
391 <arg direction="out" name="endOffset" type="i"/>
393 <method name="addSelection">
394 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
395 <p>The result of calling addSelection on objects which already have one selection present, and which
396 do not include STATE_MULTISELECTABLE, is undefined, other than the return value.</p>
398 <arg direction="in" name="startOffset" type="i"/>
399 <arg direction="in" name="endOffset" type="i"/>
400 <arg direction="out" type="b" tp:type="boolean">
402 \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).
406 <method name="removeSelection">
407 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
408 <p>Deselect the text contained in the specified selectionNum, if such a selection
409 exists, otherwise do nothing. Removal of a non-existant selectionNum has no effect.</p>
411 <arg direction="in" name="selectionNum" type="i"/>
412 <arg direction="out" type="b" tp:type="boolean">
414 \c True if the selection was successfully removed, \c False otherwise.
418 <method name="setSelection">
419 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
420 <p>Modify an existing selection's start or ending offset. </p>
422 <p>Calling setSelection for a selectionNum that is not already defined has no effect.
423 The result of calling setSelection with a selectionNum greater than 0 for objects that
424 do not include STATE_MULTISELECTABLE is undefined.
425 @param selectionNum indicates which of a set of non-contiguous selections to modify.
426 @param startOffset the new starting offset for the selection
427 @param endOffset the new ending offset for the selection</p>
429 <arg direction="in" name="selectionNum" type="i"/>
430 <arg direction="in" name="startOffset" type="i"/>
431 <arg direction="in" name="endOffset" type="i"/>
432 <arg direction="out" type="b" tp:type="boolean">
434 \c True if the selection corresponding to selectionNum is successfully modified, \c False otherwise.
438 <method name="getRangeExtents">
439 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
440 <p>Obtain the bounding box which entirely contains a given text range.
441 Negative values may be returned for the bounding box parameters in the event
442 that all or part of the text range is offscreen or not mapped to the screen.
443 @param startOffset the offset of the first character in the specified range.
444 @param endOffset the offset of the character immediately after the last
445 character in the specified range.
446 @param x an integer parameter which is back-filled with the minimum
447 horizontal coordinate of the resulting bounding box.
448 @param y an integer parameter which is back-filled with the minimum
449 vertical coordinate of the resulting bounding box.
450 @param width an integer parameter which is back-filled with the
451 horizontal extent of the bounding box.
452 @param height an integer parameter which is back-filled with the
453 vertical extent of the bounding box.
454 @param coordType If 0, the above coordinates are reported in pixels relative to
455 corner of the screen; if 1, the coordinates are reported relative to the
456 corner of the containing toplevel window.</p>
458 <arg direction="in" name="startOffset" type="i"/>
459 <arg direction="in" name="endOffset" type="i"/>
460 <arg direction="out" name="x" type="i"/>
461 <arg direction="out" name="y" type="i"/>
462 <arg direction="out" name="width" type="i"/>
463 <arg direction="out" name="height" type="i"/>
464 <arg direction="in" name="coordType" type="n" tp:type="short"/>
466 <method name="getBoundedRanges">
467 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
468 <p>Return the text content within a bounding box,
469 as a list of Range structures.
470 Depending on the TEXT_CLIP_TYPE parameters, glyphs which are clipped by the
471 bounding box (i.e. which lie partially inside and partially outside it)
472 may or may not be included in the ranges returned.
473 @note This method may be of particular interest to screen review algorithms.
475 @param x the minimum x ( i.e. leftmost) coordinate of the bounding box.
476 @param y the minimum y coordinate of the bounding box.
477 @param width the horizontal size of the bounding box. The rightmost bound of the bounding box
479 @param height the vertical size of the bounding box. The maximum y value of the bounding box
481 @param coordType If 0, the above coordinates are interpreted as pixels relative to
482 corner of the screen; if 1, the coordinates are interpreted as pixels relative to the
483 corner of the containing toplevel window.
484 @param xClipType determines whether text which intersects the bounding box in the x direction
486 @param yClipType determines whether text which intersects the bounding box in the y direction
489 <arg direction="in" name="x" type="i"/>
490 <arg direction="in" name="y" type="i"/>
491 <arg direction="in" name="width" type="i"/>
492 <arg direction="in" name="height" type="i"/>
493 <arg direction="in" name="coordType" type="n" tp:type="short"/>
494 <arg direction="in" name="xClipType" type="u" tp:type="TEXT_CLIP_TYPE"/>
495 <arg direction="in" name="yClipType" type="u" tp:type="TEXT_CLIP_TYPE"/>
496 <arg direction="out" type="a(iisv)" tp:type="RangeList"/>
498 <method name="getAttributeRun">
499 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
500 <p>Query a particular text object for the text attributes defined at a given offset,
501 obtaining the start and end of the "attribute run" over which these attributes are currently
502 invariant. Text attributes are those presentational, typographic, or semantic attributes or
503 qualitites which apply to a range of text specifyable by starting and ending offsets.
504 Attributes relevant to localization should be provided in
505 accordance with the w3c "Internationalization and Localization Markup Requirements",
506 http://www.w3.org/TR/2005/WD-itsreq-20051122/
507 Other text attributes should choose their names and value semantics in accordance with relevant
508 standards such as CSS level 2 (http://www.w3.org/TR/1998/REC-CSS2-19980512),
509 XHTML 1.0 (http://www.w3.org/TR/2002/REC-xhtml1-20020801), and
510 WICD (http://www.w3.org/TR/2005/WD-WICD-20051121/). Those attributes from the aforementioned
511 specifications and recommendations which do not concern typographic, presentational, or
512 semantic aspects of text should be exposed via the more general Accessible::getAttributes() API
515 <p>For example, CSS attributes which should be exposed on text (either as default attributes, or
516 as explicitly-set attributes when non-default values are specified in the content view) include
517 the Font attributes (i.e. "css2:font-weight", "css2:font-style"),
518 the "css2:color" and "css2:background-color" attributes, and "css2:text-decoration" attribute. </p>
520 <p>If includeDefaults is TRUE, then this AttributeSet should include the default
521 attributes as well as those which are explicitly assigned to the attribute run in question.
522 startOffset and endOffset will be back-filled to indicate the start and end of the attribute run
523 which contains 'offset' - an attribute run is a contiguous section of text whose attributes are
525 @param offset the offset of the character whose attributes will be reported.
526 @param startOffset backfilled with the starting offset of the character range over which all
527 text attributes match those of \c offset, i.e. the start of the homogeneous
528 attribute run including \c offset.
529 @param endOffset backfilled with the offset of the first character past the character range over which all
530 text attributes match those of \c offset, i.e. the character immediately after
531 the homogeneous attribute run including \c offset.
532 @param includeDefaults if False, the call should only return those attributes which are
533 explicitly set on the current attribute run, omitting any attributes which are inherited from
534 the default values. See also Text::getDefaultAttributes. </p>
536 <p>@note Clients seeking annotations or properties of a more general nature, which
537 are not specific to the onscreen textual content of objects and cannot logically be applied
538 to specific character offset ranges,
539 should use Accessible::getAttributes instead.
540 The attributes returned by Text::getAttributeRun (with or without 'default attributes'),
541 are distinct from the properties/attributes returned by Accessible::getAttributes. </p>
543 <p>@see Accessible::getAttributes </p>
545 <arg direction="in" name="offset" type="i"/>
546 <arg direction="out" name="startOffset" type="i"/>
547 <arg direction="out" name="endOffset" type="i"/>
548 <arg direction="in" name="includeDefaults" type="b" tp:type="boolean"/>
549 <arg direction="out" type="as" tp:type="AttributeSet">
551 the AttributeSet defined at offset, optionally including the 'default' attributes. @since AT-SPI 1.7.0
555 <method name="getDefaultAttributeSet">
556 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
557 <p>Return an ::AttributeSet containing the text attributes which apply to all text in the object
558 by virtue of the default settings of the document, view, or user agent; e.g. those
559 attributes which are implied rather than explicitly applied to the text object.
560 For instance, an object whose entire text content has been explicitly marked as 'bold' will
561 report the 'bold' attribute via getAttributeRun(), whereas an object whose text weight is
562 inspecified may report the default or implied text weight in the default AttributeSet. </p>
564 <p>@since AT-SPI 1.7.0</p>
566 <arg direction="out" type="as" tp:type="AttributeSet"/>
568 <method name="unImplemented">
569 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
573 <p>placeholders for future expansion.</p>
576 <method name="unImplemented2">