Class: ATSPI::Accessible::Text

Inherits:

Object

• Object
• ATSPI::Accessible::Text

Extended by:

Forwardable

Includes:

Editable, Hypertext

Defined in:

lib/atspi/accessible/text.rb,
lib/atspi/accessible/text/caret.rb,
lib/atspi/accessible/text/range.rb,
lib/atspi/accessible/text/offset.rb,
lib/atspi/accessible/text/editable.rb,
lib/atspi/accessible/text/character.rb,
lib/atspi/accessible/text/hyperlink.rb,
lib/atspi/accessible/text/hypertext.rb,
lib/atspi/accessible/text/selection.rb

Overview

Wraps libatspi’s text interface, editable_text interface and hypertext interface.

Defined Under Namespace

Modules: Editable, Hypertext Classes: Caret, Character, Hyperlink, Offset, Range, Selection

Attributes & States

• #caret ⇒ Caret (also: #cursor)

  Its caret/cursor.

• #editable? ⇒ true, false included from Editable

  Checks if it is editable.

• #hyperlinks ⇒ Array<Hyperlink> (also: #links) included from Hypertext

  Its hyperlinks.

• #hypertext? ⇒ true, false included from Hypertext

  Checks if it is a hypertext.

• #length ⇒ Integer

  Its length.

• #selections ⇒ Array<Selection>

  Its selected text ranges.

Geometric Access

• #offset_at(x, y, relative_to:) ⇒ Offset

  The offset at the given point.

• #ranges_in(x, y, width, height, relative_to:, clip_x: :none, clip_y: :none) ⇒ Array<Range>

  The ranges inside the given rectangle.

Actions

• #copy(from: 0, to: length) ⇒ true, false included from Editable

  Copies its content in the given range into the clipboard.

• #cut(from: 0, to: length) ⇒ true, false included from Editable

  Cuts its content in the given range and puts it into the clipboard.

• #delete(from: 0, to: length) ⇒ true, false included from Editable

  Deletes its content in the given range.

• #deselect ⇒ true, false

  Deselects the entire text.

• #insert(text, at: caret) ⇒ true, false included from Editable

  Inserts a string at the given offset.

• #paste(at: caret) ⇒ true, false included from Editable

  Pastes the string in the clipboard at the given offset.

• #select(from: 0, to: length) ⇒ true, false

  Selects the text between the given offsets.

• #set_to(text) ⇒ true, false included from Editable

  Replaces its content with the given one.

Representations

• #inspect ⇒ String

  Itself as an inspectable string.

• #to_s(from: 0, to: length) ⇒ String

  Its string representation.

Instance Method Details

#caret ⇒ Caret Also known as: cursor

Returns its caret/cursor.

Returns:

• (Caret) —

  its caret/cursor

# File 'lib/atspi/accessible/text.rb', line 23

def caret
  Caret.new(@native)
end

#copy(from: 0, to: length) ⇒ true, false Originally defined in module Editable

Copies its content in the given range into the clipboard. Will succeed only if it’s editable.

Parameters:

• from (responds to #to_i) (defaults to: 0) —

  the start offset of the range

• to (responds to #to_i) (defaults to: length) —

  the end offset of the range

Returns:

• (true, false) —

  indicating success

See Also:

• atspi_editable_text_copy_text

#cut(from: 0, to: length) ⇒ true, false Originally defined in module Editable

Cuts its content in the given range and puts it into the clipboard. Will succeed only if it’s editable.

Parameters:

• from (responds to #to_i) (defaults to: 0) —

  the start offset of the range

• to (responds to #to_i) (defaults to: length) —

  the end offset of the range

Returns:

• (true, false) —

  indicating success

See Also:

• atspi_editable_text_cut_text

#delete(from: 0, to: length) ⇒ true, false Originally defined in module Editable

Deletes its content in the given range. Will succeed only if it’s editable.

Parameters:

• from (responds to #to_i) (defaults to: 0) —

  the start offset of the range

• to (responds to #to_i) (defaults to: length) —

  the end offset of the range

Returns:

• (true, false) —

  indicating success

See Also:

• atspi_editable_text_delete_text

#deselect ⇒ true, false

Deselects the entire text.

To deselect a single selection do it via ATSPI::Accessible::Text::Selection#deselect.

Returns:

• (true, false) —

  indicating success

# File 'lib/atspi/accessible/text.rb', line 97

def deselect
  selections.reverse.map(&:deselect).all?
end

#editable? ⇒ true, false Originally defined in module Editable

Checks if it is editable.

Returns:

• (true, false)

See Also:

• atspi_accessible_get_editable_text_iface

#hyperlinks ⇒ Array<Hyperlink> Also known as: links Originally defined in module Hypertext

Returns its hyperlinks. Will be an empty array if it is not a hypertext.

Returns:

• (Array<Hyperlink>) —

  its hyperlinks. Will be an empty array if it is not a hypertext.

See Also:

• atspi_hypertext_get_n_links
• atspi_hypertext_get_link

#hypertext? ⇒ true, false Originally defined in module Hypertext

Checks if it is a hypertext.

Returns:

• (true, false)

See Also:

• atspi_accessible_get_hypertext_iface

#insert(text, at: caret) ⇒ true, false Originally defined in module Editable

Inserts a string at the given offset. Will succeed only if it’s editable.

Parameters:

• text (respond to #to_s) —

  the text to insert

• at (responds to #to_i) (defaults to: caret) —

  the offset to insert the string at

Returns:

• (true, false) —

  indicating success

See Also:

• atspi_editable_text_insert_text

#inspect ⇒ String

Returns itself as an inspectable string.

Returns:

• (String) —

  itself as an inspectable string

# File 'lib/atspi/accessible/text.rb', line 114

def inspect
  text_s = to_s(from: 0, to: 20) << (length > 20 ? '…' : '')
  "#<#{self.class.name}:0x#{'%x14' % __id__} @to_s=#{text_s.inspect} @length=#{length}>"
end

#length ⇒ Integer

Returns its length.

Returns:

• (Integer) —

  its length

See Also:

• atspi_text_get_character_count

# File 'lib/atspi/accessible/text.rb', line 18

def length
  @native.character_count
end

#offset_at(x, y, relative_to:) ⇒ Offset

Returns the offset at the given point.

Examples:

text.offset_at(1243, 323, relative_to: :screen) # => #<ATSPI::Accessible::Text::Offset:0x112779814 … >

Parameters:

• x (Integer)
• y (Integer)
• relative_to (Symbol) —

  coordinate system derived from libatspi’s AtspiCoordType enum by removing the prefix ATSPI_COORD_TYPE and making it lowercase

Returns:

• (Offset) —

  the offset at the given point

See Also:

• atspi_text_get_offset_at_point

# File 'lib/atspi/accessible/text.rb', line 50

def offset_at(x, y, relative_to:)
  Offset.new(@native, @native.offset_at_point(x, y, relative_to))
end

#paste(at: caret) ⇒ true, false Originally defined in module Editable

Pastes the string in the clipboard at the given offset. Will succeed only if it’s editable.

Parameters:

• at (responds to #to_i) (defaults to: caret) —

  the offset to insert the string at

Returns:

• (true, false) —

  indicating success

See Also:

• atspi_editable_text_paste_text

#ranges_in(x, y, width, height, relative_to:, clip_x: :none, clip_y: :none) ⇒ Array<Range>

Returns the ranges inside the given rectangle.

Examples:

ranges_in(200, 300, 543, 322, relative_to: :window, clip_x: :both, clip_y: :min) # => [#<ATSPI::Accessible::Text::Range:0xea30bc14 … >, …]

Parameters:

• x (Integer) —

  x position of the rectangle

• y (Integer) —

  y position of the rectangle

• width (Integer) —

  width of the rectangle

• height (Integer) —

  height of the rectangle

• relative_to (Symbol) —

  coordinate system derived from libatspi’s AtspiCoordType enum by removing the prefix ATSPI_COORD_TYPE and making it lowercase

• clip_x (Symbol) (defaults to: :none) —

  how to treat characters intersecting the rectangle in x direction. derived from libatspi’s AtspiTextClipType enum by removing the prefix ATSPI_TEXT_CLIP_ and making it lowercase

Returns:

• (Array<Range>) —

  the ranges inside the given rectangle

See Also:

• atspi_text_get_bounded_ranges

# File 'lib/atspi/accessible/text.rb', line 72

def ranges_in(x, y, width, height, relative_to:, clip_x: :none, clip_y: :none)
  @native.bounded_ranges(x, y, width, height, relative_to, clip_x, clip_y).map do |range|
    Range.new(@native, range)
  end
end

#select(from: 0, to: length) ⇒ true, false

Selects the text between the given offsets.

Parameters:

• from (responds to #to_i) (defaults to: 0) —

  start offset

• to (responds to #to_i) (defaults to: length) —

  end offset

Returns:

• (true, false) —

  indicating success

See Also:

• atspi_text_add_selection

# File 'lib/atspi/accessible/text.rb', line 88

def select(from: 0, to: length)
  @native.add_selection(from.to_i, to.to_i)
end

#selections ⇒ Array<Selection>

Returns its selected text ranges.

Returns:

• (Array<Selection>) —

  its selected text ranges

See Also:

• atspi_text_get_n_selections

# File 'lib/atspi/accessible/text.rb', line 30

def selections
  @native.n_selections.times.map do |idx|
    Selection.new(@native, idx)
  end
end

#set_to(text) ⇒ true, false Originally defined in module Editable

Replaces its content with the given one. Will succeed only if it’s editable.

Parameters:

• text (respond to #to_s) —

  the new text

Returns:

• (true, false) —

  indicating success

#to_s(from: 0, to: length) ⇒ String

Returns its string representation.

Parameters:

• from (responds to #to_i) (defaults to: 0) —

  start offset

• to (responds to #to_i) (defaults to: length) —

  end offset

Returns:

• (String) —

  its string representation

See Also:

• atspi_text_get_text

# File 'lib/atspi/accessible/text.rb', line 109

def to_s(from: 0, to: length)
  @native.text(from.to_i, to.to_i)
end