LibreOffice
LibreOffice 5.3 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Variables
com::sun::star::accessibility::AccessibleRelationType Constant Group Reference

Collection of relation types. More...

Variables

const short INVALID = 0
 Invalid relation type. More...
 
const short CONTENT_FLOWS_FROM = 1
 Content-flows-from relation. More...
 
const short CONTENT_FLOWS_TO = 2
 Content-flows-to relation. More...
 
const short CONTROLLED_BY = 3
 Controlled-by relation type. More...
 
const short CONTROLLER_FOR = 4
 Controller-for relation type. More...
 
const short LABEL_FOR = 5
 Label-for relation type. More...
 
const short LABELED_BY = 6
 Labeled-by relation type. More...
 
const short MEMBER_OF = 7
 Member-of relation type. More...
 
const short SUB_WINDOW_OF = 8
 Sub-Window-of relation type. More...
 
const short NODE_CHILD_OF = 9
 Node-Child-of relation type. More...
 
const short DESCRIBED_BY = 10
 Described-by relation type. More...
 

Detailed Description

Collection of relation types.

This list of constants defines the available types of relations that are usable by AccessibleRelation.

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

const short CONTENT_FLOWS_FROM = 1

Content-flows-from relation.

Indicates a content flow between the related objects.

const short CONTENT_FLOWS_TO = 2

Content-flows-to relation.

Indicates a content flow between the related objects.

const short CONTROLLED_BY = 3

Controlled-by relation type.

Indicates an object is controlled by one or more target objects.

const short CONTROLLER_FOR = 4

Controller-for relation type.

Indicates an object is a controller for one or more target objects.

const short DESCRIBED_BY = 10

Described-by relation type.

Indicates an object is described by the target object.

Since
OOo 3.5
const short INVALID = 0

Invalid relation type.

Indicates an invalid relation type. This is used to indicate that a retrieval method could not find a requested relation.

const short LABEL_FOR = 5

Label-for relation type.

Indicates an object is a label for one or more target objects.

const short LABELED_BY = 6

Labeled-by relation type.

Indicates an object is labeled by one or more target objects.

const short MEMBER_OF = 7

Member-of relation type.

Indicates an object is a member of a group of one or more target objects.

const short NODE_CHILD_OF = 9

Node-Child-of relation type.

Indicates an object is a cell in a tree or tree table which is displayed because a cell in the same column is expanded and identifies that cell.

Since
OOo 3.0
const short SUB_WINDOW_OF = 8

Sub-Window-of relation type.

With this relation you can realize an alternative parent-child relationship. The target of the relation contains the parent window. Note that there is no relation that points the other way, from the parent window to the child window.