Interface IAtspiText
Definition
- Namespace:
- Tizen.NUI.Accessibility
- Assembly:
- Tizen.NUI.dll
Interface representing objects which can store immutable texts.
public interface IAtspiTextMethods
View SourceAccessibilityGetCharacterCount()
Gets number of all stored characters.
Declaration
int AccessibilityGetCharacterCount()Returns
| Type | Description |
|---|---|
| int | The number of characters |
AccessibilityGetCursorOffset()
Gets the cursor offset.
Declaration
int AccessibilityGetCursorOffset()Returns
| Type | Description |
|---|---|
| int | Value of cursor offset |
AccessibilityGetRangeExtents(int, int, AccessibilityCoordinateType)
Gets the bounding box for text within a range in text.
Declaration
Rectangle AccessibilityGetRangeExtents(int startOffset, int endOffset, AccessibilityCoordinateType coordType)Parameters
| Type | Name | Description |
|---|---|---|
| int | startOffset | The index of first character |
| int | endOffset | The index of first character after the last one expected |
| AccessibilityCoordinateType | coordType | The enumeration with type of coordinate system |
Returns
| Type | Description |
|---|---|
| Rectangle | Rectangle giving the position and size of the specified range of text |
AccessibilityGetSelection(int)
Gets selected text.
Declaration
AccessibilityRange AccessibilityGetSelection(int selectionNumber)Parameters
| Type | Name | Description |
|---|---|---|
| int | selectionNumber | The selection index |
Returns
| Type | Description |
|---|---|
| AccessibilityRange | Range structure containing acquired text and offsets in original string |
Remarks
Currently only one selection (i.e. with index = 0) is supported
AccessibilityGetText(int, int)
Gets stored text in given range.
Declaration
string AccessibilityGetText(int startOffset, int endOffset)Parameters
| Type | Name | Description |
|---|---|---|
| int | startOffset | The index of first character |
| int | endOffset | The index of first character after the last one expected |
Returns
| Type | Description |
|---|---|
| string | The substring of stored text |
AccessibilityGetTextAtOffset(int, AccessibilityTextBoundary)
Gets substring of stored text truncated in concrete gradation.
Declaration
AccessibilityRange AccessibilityGetTextAtOffset(int offset, AccessibilityTextBoundary boundary)Parameters
| Type | Name | Description |
|---|---|---|
| int | offset | The position in stored text |
| AccessibilityTextBoundary | boundary | The enumeration describing text gradation |
Returns
| Type | Description |
|---|---|
| AccessibilityRange | Range structure containing acquired text and offsets in original string |
AccessibilityRemoveSelection(int)
Removes the whole selection.
Declaration
bool AccessibilityRemoveSelection(int selectionNumber)Parameters
| Type | Name | Description |
|---|---|---|
| int | selectionNumber | The selection index |
Returns
| Type | Description |
|---|---|
| bool | True on success, false otherwise |
Remarks
Currently only one selection (i.e. with index = 0) is supported
AccessibilitySetCursorOffset(int)
Sets the cursor offset.
Declaration
bool AccessibilitySetCursorOffset(int offset)Parameters
| Type | Name | Description |
|---|---|---|
| int | offset | Cursor offset |
Returns
| Type | Description |
|---|---|
| bool | True if successful |
AccessibilitySetSelection(int, int, int)
Sets selected text.
Declaration
bool AccessibilitySetSelection(int selectionNumber, int startOffset, int endOffset)Parameters
| Type | Name | Description |
|---|---|---|
| int | selectionNumber | The selection index |
| int | startOffset | The index of first character |
| int | endOffset | The index of first character after the last one expected |
Returns
| Type | Description |
|---|---|
| bool | True on success, false otherwise |
Remarks
Currently only one selection (i.e. with index = 0) is supported