Struct xpcom::interfaces::nsIAccessibleText [−] [src]

#[repr(C)]

pub struct nsIAccessibleText { /* fields omitted */ }

interface nsIAccessibleText : nsISupports

Methods

impl nsIAccessibleText
[src]

[src]

Cast this nsIAccessibleText to one of its base interfaces.

impl nsIAccessibleText
[src]

TEXT_OFFSET_END_OF_TEXT: i64 = -1

TEXT_OFFSET_CARET: i64 = -2

BOUNDARY_CHAR: i64 = 0

BOUNDARY_WORD_START: i64 = 1

BOUNDARY_WORD_END: i64 = 2

BOUNDARY_SENTENCE_START: i64 = 3

BOUNDARY_SENTENCE_END: i64 = 4

BOUNDARY_LINE_START: i64 = 5

BOUNDARY_LINE_END: i64 = 6

[src]

/**
   * The current current caret offset.
   * If set < 0 then caret will be placed  at the end of the text
   */

attribute long caretOffset;

[src]

/**
   * The current current caret offset.
   * If set < 0 then caret will be placed  at the end of the text
   */

attribute long caretOffset;

[src]

readonly attribute long characterCount;

[src]

readonly attribute long selectionCount;

[src]

/**
      * String methods may need to return multibyte-encoded strings,
      * since some locales can't be encoded using 16-bit chars.
      * So the methods below might return UTF-16 strings, or they could
      * return "string" values which are UTF-8.
      */

AString getText (in long startOffset, in long endOffset);

[src]

AString getTextAfterOffset (in long offset, in AccessibleTextBoundary boundaryType, out long startOffset, out long endOffset);

[src]

AString getTextAtOffset (in long offset, in AccessibleTextBoundary boundaryType, out long startOffset, out long endOffset);

[src]

AString getTextBeforeOffset (in long offset, in AccessibleTextBoundary boundaryType, out long startOffset, out long endOffset);

[src]

/**
      * It would be better to return an unsigned long here,
      * to allow unicode chars > 16 bits
      */

wchar getCharacterAtOffset (in long offset);

[src]

/**
   * Get the accessible start/end offsets around the given offset,
   * return the text attributes for this range of text.
   *
   * @param  includeDefAttrs   [in] points whether text attributes applied to
   *                           the entire accessible should be included or not.
   * @param  offset            [in] text offset
   * @param  rangeStartOffset  [out] start offset of the range of text
   * @param  rangeEndOffset    [out] end offset of the range of text
   */

nsIPersistentProperties getTextAttributes (in boolean includeDefAttrs, in long offset, out long rangeStartOffset, out long rangeEndOffset);

[src]

/**
   * Return the text attributes that apply to the entire accessible.
   */

readonly attribute nsIPersistentProperties defaultTextAttributes;

[src]

/**
   * Returns the bounding box of the specified position.
   *
   * The virtual character after the last character of the represented text,
   * i.e. the one at position length is a special case. It represents the
   * current input position and will therefore typically be queried by AT more
   * often than other positions. Because it does not represent an existing
   * character its bounding box is defined in relation to preceding characters.
   * It should be roughly equivalent to the bounding box of some character when
   * inserted at the end of the text. Its height typically being the maximal
   * height of all the characters in the text or the height of the preceding
   * character, its width being at least one pixel so that the bounding box is
   * not degenerate.
   *
   * @param offset - Index of the character for which to return its bounding
   *                  box. The valid range is 0..length.
   * @param x - X coordinate of the bounding box of the referenced character.
   * @param y - Y coordinate of the bounding box of the referenced character.
   * @param width - Width of the bounding box of the referenced character.
   * @param height - Height of the bounding box of the referenced character.
   * @param coordType - Specifies if the coordinates are relative to the screen
   *                    or to the parent window (see constants declared in
   *                    nsIAccessibleCoordinateType).
  */

void getCharacterExtents (in long offset, out long x, out long y, out long width, out long height, in unsigned long coordType);

[src]

void getRangeExtents (in long startOffset, in long endOffset, out long x, out long y, out long width, out long height, in unsigned long coordType);

[src]

/**
   * Get the text offset at the given point, or return -1
   * if no character exists at that point
   *
   * @param x - The position's x value for which to look up the index of the
   *            character that is rendered on to the display at that point.
   * @param y - The position's y value for which to look up the index of the
   *            character that is rendered on to the display at that point.
   * @param coordType - Screen coordinates or window coordinates (see constants
   *                    declared in nsIAccessibleCoordinateType).
   * @return offset - Index of the character under the given point or -1 if
   *                  the point is invalid or there is no character under
   *                  the point.
   */

long getOffsetAtPoint (in long x, in long y, in unsigned long coordType);

[src]

void getSelectionBounds (in long selectionNum, out long startOffset, out long endOffset);

[src]

/**
   * Set the bounds for the given selection range
   */

void setSelectionBounds (in long selectionNum, in long startOffset, in long endOffset);

[src]

void addSelection (in long startOffset, in long endOffset);

[src]

void removeSelection (in long selectionNum);

[src]

/**
   * Makes a specific part of string visible on screen.
   *
   * @param startIndex  0-based character offset
   * @param endIndex    0-based character offset - the offset of the
   *                    character just past the last character of the
   *                    string
   * @param scrollType  defines how to scroll (see nsIAccessibleScrollType for
   *                    available constants)
   */

void scrollSubstringTo (in long startIndex, in long endIndex, in unsigned long scrollType);

[src]

/**
   * Moves the top left of a substring to a specified location.
   *
   * @param startIndex      0-based character offset
   * @param endIndex        0-based character offset - the offset of the
   *                        character just past the last character of
   *                        the string
   * @param coordinateType  specifies the coordinates origin (for available
   *                        constants refer to nsIAccessibleCoordinateType)
   * @param x               defines the x coordinate
   * @param y               defines the y coordinate
   */

void scrollSubstringToPoint (in long startIndex, in long endIndex, in unsigned long coordinateType, in long x, in long y);

[src]

/**
   * Return a range that encloses this text control or otherwise the document
   * this text accessible belongs to.
   */

readonly attribute nsIAccessibleTextRange enclosingRange;

[src]

/**
   * Return an array of disjoint ranges for selected text within the text control
   * or otherwise the document this accessible belongs to.
   */

readonly attribute nsIArray selectionRanges;

[src]

/**
   * Return an array of disjoint ranges of visible text within the text control
   * or otherwise the document this accessible belongs to.
   */

readonly attribute nsIArray visibleRanges;

[src]

/**
   * Return a range containing the given accessible.
   */

nsIAccessibleTextRange getRangeByChild (in nsIAccessible child);

[src]

/**
   * Return a range containing an accessible at the given point.
   */

nsIAccessibleTextRange getRangeAtPoint (in long x, in long y);

Methods from Deref<Target = nsISupports>

[src]

Cast this nsISupports to one of its base interfaces.

[src]

void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);

[src]

[noscript,notxpcom] nsrefcnt AddRef ();

[src]

[noscript,notxpcom] nsrefcnt Release ();

Trait Implementations

impl XpCom for nsIAccessibleText
[src]

IID: nsIID = nsID(2477599905, 61739, 19129, [167, 147, 149, 217, 250, 157, 23, 116])

[src]

Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise. Read more

impl RefCounted for nsIAccessibleText
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIAccessibleText
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.