LibreOffice LibreOffice 5.3 SDK API Reference

Variables
com::sun::star::accessibility::AccessibleStateType Constant Group Reference

Collection of state types. More...

## Variables
const short | INVALID = 0
| Indicates an invalid state. More...
const short | ACTIVE = 1
| Indicates a window is currently the active window. More...
const short | ARMED = 2
| Indicates that the object is armed. More...
const short | BUSY = 3
| Indicates the current object is busy. More...
const short | CHECKED = 4
| Indicates this object is currently checked. More...
const short | DEFUNC = 5
| User interface object corresponding to this object no longer exists. More...
const short | EDITABLE = 6
| Indicates the user can change the contents of this object. More...
const short | ENABLED = 7
| Indicates this object is enabled. More...
const short | EXPANDABLE = 8
| Indicates this object allows progressive disclosure of its children. More...
const short | EXPANDED = 9
| Indicates this object is expanded. More...
const short | FOCUSABLE = 10
| Object can accept the keyboard focus. More...
const short | FOCUSED = 11
| Indicates this object currently has the keyboard focus. More...
const short | HORIZONTAL = 12
| Indicates the orientation of this object is horizontal. More...
const short | ICONIFIED = 13
| Indicates this object is minimized and is represented only by an icon. More...
const short | INDETERMINATE = 14
| Sometimes UI elements can have a state indeterminate. More...
const short | MANAGES_DESCENDANTS = 15
| Indicates the most (all) children are transient and it is not necessary to add listener to the children. More...
const short | MODAL = 16
| Object is modal. More...
const short | MULTI_LINE = 17
| Indicates this (text) object can contain multiple lines of text. More...
const short | MULTI_SELECTABLE = 18
| More than one child may be selected at the same time. More...
const short | OPAQUE = 19
| Indicates this object paints every pixel within its rectangular region. More...
const short | PRESSED = 20
| Indicates this object is currently pressed. More...
const short | RESIZABLE = 21
| Indicates the size of this object is not fixed. More...
const short | SELECTABLE = 22
| Object is selectable. More...
const short | SELECTED = 23
| Object is selected. More...
const short | SENSITIVE = 24
| Indicates this object is sensitive. More...
const short | SHOWING = 25
| Object is displayed on the screen. More...
const short | SINGLE_LINE = 26
| Indicates this (text) object can contain only a single line of text. More...
const short | STALE = 27
| Object information is stale and might not be up to date. More...
const short | TRANSIENT = 28
| Indicates this object is transient. More...
const short | VERTICAL = 29
| Indicates the orientation of this object is vertical. More...
const short | VISIBLE = 30
| Object wants to be displayed on the screen. More...
const short | MOVEABLE = 31
| Indicates the position of the object is not fixed. More...
const short | DEFAULT = 32
| Indicates the object is the default button in a window. More...
const short | OFFSCREEN = 33
| Indicates the object is outside of the screen area. More...
const short | COLLAPSE = 34
| Indicates that the object is collapsed. More...

## Detailed Description

Collection of state types.

This list of constants defines the available set of states that an object that implements XAccessibleContext can be in.

The comments describing the states is taken verbatim from the Java Accessibility API 1.4 documentation.

We are using constants instead of a more typesafe enum. The reason for this is that IDL enums may not be extended. Therefore, in order to include future extensions to the set of roles we have to use constants here.

Since
  OOo 1.1.2

## Variable Documentation

## ◆ ACTIVE

const short ACTIVE = 1

Indicates a window is currently the active window.

## ◆ ARMED

const short ARMED = 2

Indicates that the object is armed.

## ◆ BUSY

const short BUSY = 3

Indicates the current object is busy.

## ◆ CHECKED

const short CHECKED = 4

Indicates this object is currently checked.

## ◆ COLLAPSE

const short COLLAPSE = 34

Indicates that the object is collapsed.

## ◆ DEFAULT

const short DEFAULT = 32

Indicates the object is the default button in a window.

## ◆ DEFUNC

const short DEFUNC = 5

User interface object corresponding to this object no longer exists.

Indicates the user interface object corresponding to this object no longer exists.

## ◆ EDITABLE

const short EDITABLE = 6

Indicates the user can change the contents of this object.

## ◆ ENABLED

const short ENABLED = 7

Indicates this object is enabled.

## ◆ EXPANDABLE

const short EXPANDABLE = 8

Indicates this object allows progressive disclosure of its children.

## ◆ EXPANDED

const short EXPANDED = 9

Indicates this object is expanded.

## ◆ FOCUSABLE

const short FOCUSABLE = 10

Object can accept the keyboard focus.

Indicates this object can accept keyboard focus, which means all events resulting from typing on the keyboard will normally be passed to it when it has focus.

## ◆ FOCUSED

const short FOCUSED = 11

Indicates this object currently has the keyboard focus.

## ◆ HORIZONTAL

const short HORIZONTAL = 12

Indicates the orientation of this object is horizontal.

## ◆ ICONIFIED

const short ICONIFIED = 13

Indicates this object is minimized and is represented only by an icon.

## ◆ INDETERMINATE

const short INDETERMINATE = 14

Sometimes UI elements can have a state indeterminate.

This can happen e.g. if a check box reflects the bold state of text in a text processor. When the current selection contains text which is bold and also text which is not bold, the state is indeterminate.

## ◆ INVALID

const short INVALID = 0

Indicates an invalid state.

## ◆ MANAGES_DESCENDANTS

const short MANAGES_DESCENDANTS = 15

Indicates the most (all) children are transient and it is not necessary to add listener to the children.

Only the active descendant (given by the event) should be not transient to make it possible to add listener to this object and recognize changes in this object.

The state is added to make a performance improvement. Now it is no longer necessary to iterate over all children to find out whether they are transient or not to decide whether to add listener or not. If there is a object with this state no one should iterate over the children to add listener. Only the active descendant should get listener if it is not transient.

## ◆ MODAL

const short MODAL = 16

Object is modal.

Indicates something must be done with this object before the user can interact with an object in a different window.

## ◆ MOVEABLE

const short MOVEABLE = 31

Indicates the position of the object is not fixed.

## ◆ MULTI_LINE

const short MULTI_LINE = 17

Indicates this (text) object can contain multiple lines of text.

## ◆ MULTI_SELECTABLE

const short MULTI_SELECTABLE = 18

More than one child may be selected at the same time.

Indicates this object allows more than one of its children to be selected at the same time.

## ◆ OFFSCREEN

const short OFFSCREEN = 33

Indicates the object is outside of the screen area.

## ◆ OPAQUE

const short OPAQUE = 19

Indicates this object paints every pixel within its rectangular region.

## ◆ PRESSED

const short PRESSED = 20

Indicates this object is currently pressed.

## ◆ RESIZABLE

const short RESIZABLE = 21

Indicates the size of this object is not fixed.

## ◆ SELECTABLE

const short SELECTABLE = 22

Object is selectable.

Indicates this object is the child of an object that allows its children to be selected, and that this child is one of those children that can be selected.

## ◆ SELECTED

const short SELECTED = 23

Object is selected.

Indicates this object is the child of an object that allows its children to be selected, and that this child is one of those children that has been selected.

## ◆ SENSITIVE

const short SENSITIVE = 24

Indicates this object is sensitive.

## ◆ SHOWING

const short SHOWING = 25

Object is displayed on the screen.

An object has set the SHOWING state if itself and all of its parents have set the VISIBLE state and it lies at least partly inside the visible area of its parent. It is, though, not necessarily visible on the screen because it may be occluded by other objects.

## ◆ SINGLE_LINE

const short SINGLE_LINE = 26

Indicates this (text) object can contain only a single line of text.

## ◆ STALE

const short STALE = 27

Object information is stale and might not be up to date.

Indicates that the information that is returned from this object might be out of sync with the application.

## ◆ TRANSIENT

const short TRANSIENT = 28

Indicates this object is transient.

## ◆ VERTICAL

const short VERTICAL = 29

Indicates the orientation of this object is vertical.

## ◆ VISIBLE

const short VISIBLE = 30

Object wants to be displayed on the screen.

A set VISIBLE state indicates that an object wants to be displayed on the screen. It is displayed, as indicated by a set SHOWING state, if all of its parents have also set the VISIBLE state and the object lies at least partly in the visible area of its parent.