Accessibility::Terminal Interface Reference

An interface dedicated to the support of virtual terminals and terminal emulators, in which row/column text position, and line-by-line access, are the dominant user model. More...

import "Accessibility_Terminal.idl";

List of all members.

Public Member Functions
string	getLines (in long startLine, in long endLine)
unsigned long	getCaretLine (out long column)
	getCaretLine:
boolean	setCaret (inout long line, inout long column)
	Move the caret to a specific line/column position in the Terminal.
long	getOffsetAtLine (in long line)
long	getLineAtOffset (in long offset, out long column)
Public Attributes
readonly attribute long	nLines
	nLines: a long containing the number of lines in this terminal.
readonly attribute long	nColumns
	nColumns: a long containing the number of columns in this terminal.
readonly attribute boolean	isDoubleWidth
	for Asian language support
readonly attribute string	applicationName
	applicationName: a string containing the name of the application which currently 'owns' the terminal window's content.

---

Detailed Description

An interface dedicated to the support of virtual terminals and terminal emulators, in which row/column text position, and line-by-line access, are the dominant user model.

In this API, 'line' refers to the terminal row position as well as the relevant line of text. Terminals are represented as a 2D array of text; text which has scrolled out of view is not exposed via this API.

Note:

Implementors of Terminal should emit change notifications of type "terminal:line-changed", which are partly redundant with "object:text-changed". Clients of Terminal may therefore elect to listen to "terminal:line-changed" events in preference to "object:text-changed" events.

See also:

Accessibility::Registry::registerGlobalEventListener.

Note:

Implementors of Terminal are also expected to implement Text.

See also:

Accessibility::Text

Note:

events fired by Terminal instances include

• "terminal:line-changed" A line of text in the terminal has changed.
• "terminal:columncount-changed" The number of text columns displayed by this terminal has changed.
• "terminal:linecount-changed" The number of lines displayed (including blank or empty lines) has changed.
• "terminal:application-changed" The application which currently ¨owns¨ the output to this terminal has changed.
• "terminal:charwidth-changed" The terminal's default character width, on which column counts are based, has changed from doublewidth-to-singlewidth or vice-versa. Implementors of Terminal should also implement Text, therefore ¨text:text-changed¨ events will be fired by these objects as well. This information is partially redundant and clients should choose to react to one or another based on their own preferences and convenience. Changed in the position of the text caret within a terminal are notified via ¨text:caret-moved¨ events, via the Text interface.

Since:

AT-SPI 1.7.0

Definition at line 63 of file Accessibility_Terminal.idl.

---

Member Function Documentation

string Accessibility::Terminal::getLines (  in long  startLine, in long  endLine )

Returns: a UTF-8-compatible string whose content includes the lines from startLine to endLine, inclusive, including trailing newlines.

unsigned long Accessibility::Terminal::getCaretLine (  out long  column  )

getCaretLine: Get the current text caret position as 0-indexed line and column offsets. Parameters: column,:  on successful return, back-filled with the current text caret column position within the returned row. Returns: the (0-based) line index of the current caret position.

boolean Accessibility::Terminal::setCaret (  inout long  line, inout long  column )

Move the caret to a specific line/column position in the Terminal. Parameters: line  the line of text to which the caret should be moved. column  the column in line to which the caret should be moved. Returns: TRUE if the caret was successfully moved, FALSE otherwise. Note: not all implementations of Terminal support programmatic movement of the text caret - clients should always check the return value.

long Accessibility::Terminal::getOffsetAtLine (  in long  line  )

Parameters: line  Returns: the caret offset, as defined by Accessibility::Text, corresponding to the initial column of line line.

long Accessibility::Terminal::getLineAtOffset (  in long  offset, out long  column )

Parameters: offset  column  the column number within the line associated with offset. Returns: the line number corresponding to a particular character offset (as defined by Accessibility::Text).

---

Member Data Documentation

readonly attribute long Accessibility::Terminal::nLines

nLines: a long containing the number of lines in this terminal. Definition at line 69 of file Accessibility_Terminal.idl.

readonly attribute long Accessibility::Terminal::nColumns

nColumns: a long containing the number of columns in this terminal. Definition at line 75 of file Accessibility_Terminal.idl.

readonly attribute boolean Accessibility::Terminal::isDoubleWidth

for Asian language support Note: Apparently some Asian lang terminals have "fullwidth modes" in which all columns are 'full width' and each character (including 'halfwidth' chars) gets a whole column, whereas other UTF-8 terminals will place 'doublewidth' (aka fullwidth) Asian characters across two columns. This flag helps clients make sense of the column data being reported by these two different cases. When TRUE, it means that 'doublewidth' characters are considered 'fullwidth' and therefore the occupy one column, whereas other characters are 'halfwidth' and occupy only one half of one column. When FALSE, 'doublewidth' characters occupy two columns and 'halfwidth' forms occupy one column, as do most non-asian glyphs such as Latin characters. Definition at line 89 of file Accessibility_Terminal.idl.

readonly attribute string Accessibility::Terminal::applicationName

applicationName: a string containing the name of the application which currently 'owns' the terminal window's content. Definition at line 96 of file Accessibility_Terminal.idl.

---

The documentation for this interface was generated from the following file:

• Accessibility_Terminal.idl

---