Module: Atk::EditableText

Defined in:
(unknown)

Overview

Atk::EditableText should be implemented by UI components which contain text which the user can edit, via the Atk::Object corresponding to that component (see Atk::Object).

Atk::EditableText is a subclass of #AtkText, and as such, an object which implements Atk::EditableText is by definition an #AtkText implementor as well.

See also: Atk::Text

Instance Method Summary collapse

Instance Method Details

#copy_text(text, start_pos, end_pos) ⇒ nil

Parameters:

  • text (Atk::EditableText) —

    an Atk::EditableText

  • start_pos (Integer) —

    start position

  • end_pos (Integer) —

    end position

Returns:

  • (nil)

#cut_text(text, start_pos, end_pos) ⇒ nil

Parameters:

  • text (Atk::EditableText) —

    an Atk::EditableText

  • start_pos (Integer) —

    start position

  • end_pos (Integer) —

    end position

Returns:

  • (nil)

#delete_text(text, start_pos, end_pos) ⇒ nil

Parameters:

  • text (Atk::EditableText) —

    an Atk::EditableText

  • start_pos (Integer) —

    start position

  • end_pos (Integer) —

    end position

Returns:

  • (nil)

#insert_text(text, string, length, position) ⇒ nil

the position at which to insert the text. After the call it points at the position after the newly inserted text.

Parameters:

  • text (Atk::EditableText) —

    an Atk::EditableText

  • string (String) —

    the text to insert

  • length (Integer) —

    the length of text to insert, in bytes

  • position (Integer) —

    The caller initializes this to

Returns:

  • (nil)

#paste_text(text, position) ⇒ nil

Parameters:

  • text (Atk::EditableText) —

    an Atk::EditableText

  • position (Integer) —

    position to paste

Returns:

  • (nil)

#set_run_attributes(text, attrib_set, start_offset, end_offset) ⇒ TrueClass

range, otherwise false

Parameters:

  • text (Atk::EditableText) —

    an Atk::EditableText

  • attrib_set (Atk::AttributeSet) —

    an Atk::AttributeSet

  • start_offset (Integer) —

    start of range in which to set attributes

  • end_offset (Integer) —

    end of range in which to set attributes

Returns:

  • (TrueClass) —

    true if attributes successfully set for the specified

#set_text_contents(text, string) ⇒ nil

Parameters:

  • text (Atk::EditableText) —

    an Atk::EditableText

  • string (String) —

    string to set for text contents of text

Returns:

  • (nil)

#text_contents=(string) ⇒ nil

Set text contents of text.

Parameters:

  • string (String) —

    string to set for text contents of text

Returns:

  • (nil)