IAccessible2 API  Version 1.3
Classes | Typedefs | Enumerations
IA2CommonTypes.idl File Reference

Classes

struct  IA2TableModelChange
 

Typedefs

typedef struct IA2TableModelChange IA2TableModelChange
 

Enumerations

enum  IA2ScrollType {
  IA2_SCROLL_TYPE_TOP_LEFT,
  IA2_SCROLL_TYPE_BOTTOM_RIGHT,
  IA2_SCROLL_TYPE_TOP_EDGE,
  IA2_SCROLL_TYPE_BOTTOM_EDGE,
  IA2_SCROLL_TYPE_LEFT_EDGE,
  IA2_SCROLL_TYPE_RIGHT_EDGE,
  IA2_SCROLL_TYPE_ANYWHERE
}
 
enum  IA2CoordinateType {
  IA2_COORDTYPE_SCREEN_RELATIVE,
  IA2_COORDTYPE_PARENT_RELATIVE
}
 
enum  IA2TextSpecialOffsets {
  IA2_TEXT_OFFSET_LENGTH = -1,
  IA2_TEXT_OFFSET_CARET = -2
}
 
enum  IA2TableModelChangeType {
  IA2_TABLE_MODEL_CHANGE_INSERT,
  IA2_TABLE_MODEL_CHANGE_DELETE,
  IA2_TABLE_MODEL_CHANGE_UPDATE
}
 

Typedef Documentation

A structure defining the type of and extents of changes made to a table

IAccessibleTable::modelChange and IAccessibleTable2::modelChange return this struct. In the case of an insertion or change the row and column offsets define the boundaries of the inserted or changed subtable after the operation. In the case of a deletion the row and column offsets define the boundaries of the subtable being removed before the removal.

Enumeration Type Documentation

These constants define which coordinate system a point is located in.

This enum is used in IAccessible2::scrollToPoint, IAccessibleImage::imagePosition, IAccessibleText::characterExtents, and IAccessibleText::offsetAtPoint, and IAccessibleText::scrollSubstringToPoint.

Enumerator
IA2_COORDTYPE_SCREEN_RELATIVE 

The coordinates are relative to the screen.

IA2_COORDTYPE_PARENT_RELATIVE 

The coordinates are relative to the upper left corner of the bounding box of the immediate parent.

These constants control the scrolling of an object or substring into a window.

This enum is used in IAccessible2::scrollTo and IAccessibleText::scrollSubstringTo.

Enumerator
IA2_SCROLL_TYPE_TOP_LEFT 

Scroll the top left corner of the object or substring such that the top left corner (and as much as possible of the rest of the object or substring) is within the top level window. In cases where the entire object or substring fits within the top level window, the placement of the object or substring is dependent on the application. For example, the object or substring may be scrolled to the closest edge, the furthest edge, or midway between those two edges. In cases where there is a hierarchy of nested scrollable controls, more than one control may have to be scrolled.

IA2_SCROLL_TYPE_BOTTOM_RIGHT 

Scroll the bottom right corner of the object or substring such that the bottom right corner (and as much as possible of the rest of the object or substring) is within the top level window. In cases where the entire object or substring fits within the top level window, the placement of the object or substring is dependent on the application. For example, the object or substring may be scrolled to the closest edge, the furthest edge, or midway between those two edges. In cases where there is a hierarchy of nested scrollable controls, more than one control may have to be scrolled.

IA2_SCROLL_TYPE_TOP_EDGE 

Scroll the top edge of the object or substring such that the top edge (and as much as possible of the rest of the object or substring) is within the top level window. In cases where the entire object or substring fits within the top level window, the placement of the object or substring is dependent on the application. For example, the object or substring may be scrolled to the closest edge, the furthest edge, or midway between those two edges. In cases where there is a hierarchy of nested scrollable controls, more than one control may have to be scrolled.

IA2_SCROLL_TYPE_BOTTOM_EDGE 

Scroll the bottom edge of the object or substring such that the bottom edge (and as much as possible of the rest of the object or substring) is within the top level window. In cases where the entire object or substring fits within the top level window, the placement of the object or substring is dependent on the application. For example, the object or substring may be scrolled to the closest edge, the furthest edge, or midway between those two edges. In cases where there is a hierarchy of nested scrollable controls, more than one control may have to be scrolled.

IA2_SCROLL_TYPE_LEFT_EDGE 

Scroll the left edge of the object or substring such that the left edge (and as much as possible of the rest of the object or substring) is within the top level window. In cases where the entire object or substring fits within the top level window, the placement of the object or substring is dependent on the application. For example, the object or substring may be scrolled to the closest edge, the furthest edge, or midway between those two edges. In cases where there is a hierarchy of nested scrollable controls, more than one control may have to be scrolled.

IA2_SCROLL_TYPE_RIGHT_EDGE 

Scroll the right edge of the object or substring such that the right edge (and as much as possible of the rest of the object or substring) is within the top level window. In cases where the entire object or substring fits within the top level window, the placement of the object or substring is dependent on the application. For example, the object or substring may be scrolled to the closest edge, the furthest edge, or midway between those two edges. In cases where there is a hierarchy of nested scrollable controls, more than one control may have to be scrolled.

IA2_SCROLL_TYPE_ANYWHERE 

Scroll the object or substring such that as much as possible of the object or substring is within the top level window. The placement of the object is dependent on the application. For example, the object or substring may be scrolled to to closest edge, the furthest edge, or midway between those two edges.

These constants specify the kind of change made to a table.

This enum is used in the IA2TableModelChange struct which in turn is used by IAccessibleTable::modelChange and IAccessibleTable2::modelChange.

Enumerator
IA2_TABLE_MODEL_CHANGE_INSERT 
IA2_TABLE_MODEL_CHANGE_DELETE 
IA2_TABLE_MODEL_CHANGE_UPDATE 

Special offsets for use in IAccessibleText and IAccessibleEditableText methods

Refer to Special Offsets for use in the IAccessibleText and IAccessibleEditableText Methods for more information.

Enumerator
IA2_TEXT_OFFSET_LENGTH 

This offset is equivalent to the length of the string. It eliminates the need to call IAccessibleText::nCharacters.

IA2_TEXT_OFFSET_CARET 

This offset signifies that the text related to the physical location of the caret should be used.

Generated on Wed Jul 10 2013 09:47:24 for IAccessible2 API Version 1.3 by  doxygen 1.8.3.1