Next: , Previous: AtkDocument, Up: Top

5 AtkEditableText

The ATK interface implemented by components containing user-editable text content.

5.1 Overview

<atk-editable-text> 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-editable-text> is a subclass of <atk-text>, and as such, an object which implements <atk-editable-text> is by definition an <atk-text> implementor as well.

5.2 Usage

— Class: <atk-editable-text>

Derives from <ginterface>.

This class defines no direct slots.

— Function: atk-editable-text-set-text-contents (self <atk-editable-text>) (string mchars)
— Method: set-text-contents

Set text contents of text.

text
an <atk-editable-text>
string
string to set for text contents of text
— Function: atk-editable-text-insert-text (self <atk-editable-text>) (string mchars) (length int) ⇒  (position int)
— Method: insert-text

Insert text at a given position.

text
an <atk-editable-text>
string
the text to insert
length
the length of text to insert, in bytes
position
The caller initializes this to the position at which to insert the text. After the call it points at the position after the newly inserted text.
— Function: atk-editable-text-copy-text (self <atk-editable-text>) (start_pos int) (end_pos int)
— Method: copy-text

Copy text from start-pos up to, but not including end-pos to the clipboard.

text
an <atk-editable-text>
start-pos
start position
end-pos
end position
— Function: atk-editable-text-cut-text (self <atk-editable-text>) (start_pos int) (end_pos int)
— Method: cut-text

Copy text from start-pos up to, but not including end-pos to the clipboard and then delete from the widget.

text
an <atk-editable-text>
start-pos
start position
end-pos
end position
— Function: atk-editable-text-delete-text (self <atk-editable-text>) (start_pos int) (end_pos int)
— Method: delete-text

Delete text start-pos up to, but not including end-pos.

text
an <atk-editable-text>
start-pos
start position
end-pos
end position
— Function: atk-editable-text-paste-text (self <atk-editable-text>) (position int)
— Method: paste-text

Paste text from clipboard to specified position.

text
an <atk-editable-text>
position
position to paste