MSAA with IAccessible2 (Windows)

Classes
struct	acacia::GroupPosition
class	acacia::IA2
class	acacia::IAAction
class	acacia::IAComponent
class	acacia::IAHyperlink
class	acacia::IATable2
class	acacia::IAValue

Functions
bool	acacia::IA2::isNull ()
std::string	acacia::IA2::toString ()
std::string	acacia::IA2::getAttributes ()
GroupPosition	acacia::IA2::getGroupPosition ()
std::vector< std::string >	acacia::IA2::getRelations ()
std::string	acacia::IA2::role ()
long	acacia::IA2::getStates ()
std::vector< std::string >	acacia::IA2::getStateStrings ()
bool	acacia::IAAction::isNull ()
std::string	acacia::IAAction::toString ()
long	acacia::IAAction::nActions ()
std::string	acacia::IAAction::getDescription (int index)
std::string	acacia::IAAction::getName (int index)
bool	acacia::IAComponent::isNull ()
std::string	acacia::IAComponent::toString ()
std::string	acacia::IAComponent::getBackground ()
std::string	acacia::IAComponent::getForeground ()
std::pair< long, long >	acacia::IAComponent::getLocationInParent ()
bool	acacia::IAHyperlink::isNull ()
std::string	acacia::IAHyperlink::toString ()
long	acacia::IAHyperlink::getStartIndex ()
long	acacia::IAHyperlink::getEndIndex ()
std::string	acacia::IAHyperlink::getAnchorTarget (long index)
ACACIA_EXPORT IANode	acacia::findRootIANodeForName (const std::string &name, const int pid=0)
ACACIA_EXPORT IANode	acacia::findRootIANodeForPID (const int pid)
IA2	acacia::IANode::QueryIA2 ()
IAAction	acacia::IANode::QueryAction ()
IAComponent	acacia::IANode::QueryComponent ()
IAHyperlink	acacia::IANode::QueryHyperlink ()
IATableCell	acacia::IANode::QueryTableCell ()
IATable2	acacia::IANode::QueryTable2 ()
IAText	acacia::IANode::QueryText ()
IAValue	acacia::IANode::QueryValue ()
bool	acacia::IANode::isNull ()
std::string	acacia::IANode::getAccRole ()
std::string	acacia::IANode::getAccName ()
std::string	acacia::IANode::getAccDescription ()
long	acacia::IANode::getAccChildCount ()
IANode	acacia::IANode::AccessibleChildAt (int index)
long	acacia::IANode::getAccState ()
std::vector< std::string >	acacia::IANode::getStateStrings ()
bool	acacia::IATable2::isNull ()
std::string	acacia::IATable2::toString ()
long	acacia::IATable2::getNColumns ()
long	acacia::IATable2::getNRows ()
bool	acacia::IAValue::isNull ()
std::string	acacia::IAValue::toString ()
std::string	acacia::IAValue::getCurrentValue ()
std::string	acacia::IAValue::getMaximumValue ()
std::string	acacia::IAValue::getMinimumValue ()

Variables
class ACACIA_EXPORT	acacia::IANode

Detailed Description

IA2 Accessiblity API for Windows

Function Documentation

AccessibleChildAt()

IANode acacia::IANode::AccessibleChildAt

(

int

index

)

Helper function which uses AccessibleChildren to retrieve accessible children, and returns the child specified by the index. Some children returned by the AccessibleChildAt are not accessible objects with their own IAccessible interface, but partial children with no interfaces. For these partial children, only a role and a name are available.

Parameters

index

Returns

An IANode.

findRootIANodeForName()

ACACIA_EXPORT IANode acacia::findRootIANodeForName	(	const std::string &	name,
		const int	pid = 0
	)

Returns the root node of the accessible tree of a running application referenced by the application's accessible name.

Parameters

name	The accessible name (or substring thereof) to search for.
pid	Optional. The process id to search for.

Returns

An IANode representing the root accessibility object for the application with the given name, or a null IANode if no such application exists.

findRootIANodeForPID()

ACACIA_EXPORT IANode acacia::findRootIANodeForPID

(

const int

pid

)

Returns the root node of the accessiblity tree of a running application referenced by pid.

Parameters

pid	The process id of the running application.

Returns

An IANode representing the root accessibility object for the application with the given PID, or a null IANode if no such application exists.

getAccChildCount()

long acacia::IANode::getAccChildCount

(

)

Wraps get_accChildCount.

getAccDescription()

std::string acacia::IANode::getAccDescription

(

)

Wraps get_accDescription.

getAccName()

std::string acacia::IANode::getAccName

(

)

Wraps get_accName.

getAccRole()

std::string acacia::IANode::getAccRole

(

)

Wraps get_accRole.

getAccState()

long acacia::IANode::getAccState

(

)

Wraps get_accState.

getAnchorTarget()

std::string acacia::IAHyperlink::getAnchorTarget

(

long

index

)

Wraps anchorTarget.

Parameters

index

getAttributes()

std::string acacia::IA2::getAttributes

(

)

Wraps attributes.

getBackground()

std::string acacia::IAComponent::getBackground

(

)

Wraps getBackground.

getCurrentValue()

std::string acacia::IAValue::getCurrentValue

(

)

Wraps currentValue.

getDescription()

std::string acacia::IAAction::getDescription

(

int

index

)

Wraps getDescription.

Parameters

index

Index of the action.

getEndIndex()

long acacia::IAHyperlink::getEndIndex

(

)

Wraps endIndex.

getForeground()

std::string acacia::IAComponent::getForeground

(

)

Wraps getForeground.

getGroupPosition()

GroupPosition acacia::IA2::getGroupPosition

(

)

Wraps groupPosition.

Returns

A GroupPosition object with level, setsize and position members.

getLocationInParent()

std::pair<long, long> acacia::IAComponent::getLocationInParent

(

)

Wraps getLocationInParent.

Returns

A tuple in the form (x,y).

getMaximumValue()

std::string acacia::IAValue::getMaximumValue

(

)

Wraps maximumValue.

getMinimumValue()

std::string acacia::IAValue::getMinimumValue

(

)

Wraps minimumValue.

getName()

std::string acacia::IAAction::getName

(

int

index

)

Wraps getName.

Parameters

index

Index of the action.

getNColumns()

long acacia::IATable2::getNColumns

(

)

Wraps nColumns.

getNRows()

long acacia::IATable2::getNRows

(

)

Wraps nRows.

getRelations()

std::vector<std::string> acacia::IA2::getRelations

(

)

A helper function which returns a list of relations.

Returns

A list of strings with all relations.

getStartIndex()

long acacia::IAHyperlink::getStartIndex

(

)

Wraps startIndex.

getStates()

long acacia::IA2::getStates

(

)

Wraps states.

getStateStrings() [1/2]

std::vector<std::string> acacia::IA2::getStateStrings

(

)

Helper function to convert the state bit vector to strings indicating the state bit constants.

getStateStrings() [2/2]

std::vector<std::string> acacia::IANode::getStateStrings

(

)

Helper function to convert the state bit vector to strings indicating the state constants.

isNull() [1/7]

bool acacia::IA2::isNull ( )

inline

Tests whether the underlying IAccessible2 pointer is the null pointer.

isNull() [2/7]

bool acacia::IAAction::isNull ( )

inline

Tests whether the underlying IAccessibleAction pointer is the null pointer.

isNull() [3/7]

bool acacia::IAComponent::isNull ( )

inline

Tests whether the underlying IAccessibleComponent pointer is the null pointer.

isNull() [4/7]

bool acacia::IAHyperlink::isNull ( )

inline

Tests whether the underlying IAccessibleHyperlink pointer is the null pointer.

isNull() [5/7]

bool acacia::IANode::isNull

(

)

Tests whether the underlying IAccessible pointer is the null pointer. An IANode with an null IAccessible pointer will be created if the wrapped API returned a nullptr with no error codes.

isNull() [6/7]

bool acacia::IATable2::isNull ( )

inline

Tests whether the underlying IAccessibleTable2 pointer is the null pointer.

isNull() [7/7]

bool acacia::IAValue::isNull ( )

inline

Tests whether the underlying IAccessibleValue pointer is the null pointer.

nActions()

long acacia::IAAction::nActions

(

)

Wraps nActions.

QueryAction()

IAAction acacia::IANode::QueryAction

(

)

Wraps QueryInterface and QueryService to retrieve the IAccessibleAction interface for this node.

Returns

An IAAction.

QueryComponent()

IAComponent acacia::IANode::QueryComponent

(

)

Wraps QueryInterface and QueryService to retrieve the IAccessibleComponent interface for this node.

Returns

An IAComponent.

QueryHyperlink()

IAHyperlink acacia::IANode::QueryHyperlink

(

)

Wraps QueryInterface and QueryService to retrieve the IAccessibleHyperlink interface for this node.

Returns

An IAHyperlink.

QueryIA2()

IA2 acacia::IANode::QueryIA2

(

)

Wraps QueryInterface and QueryService to retrieve the IAccessible2 interface for this node.

Returns

An IA2.

QueryTable2()

IATable2 acacia::IANode::QueryTable2

(

)

Wraps QueryInterface and QueryService to retrieve the IAccessibleTable2 interface for this node.

Returns

An IATable2.

QueryTableCell()

IATableCell acacia::IANode::QueryTableCell

(

)

Wraps QueryInterface and QueryService to retrieve the IAccessibleTableCell interface for this node.

Returns

An IATableCell.

QueryText()

IAText acacia::IANode::QueryText

(

)

Wraps QueryInterface and QueryService to retrieve the IAccessibleText interface for this node.

Returns

An IAText.

QueryValue()

IAValue acacia::IANode::QueryValue

(

)

Wraps QueryInterface and QueryService to retrieve the IAccessibleValue interface for this node.

Returns

An IAValue.

role()

std::string acacia::IA2::role

(

)

Wraps role.

toString() [1/6]

std::string acacia::IA2::toString

(

)

Helper function to print commonly needed values associated with this interface.

toString() [2/6]

std::string acacia::IAAction::toString

(

)

Helper function to print commonly needed values associated with this interface.

toString() [3/6]

std::string acacia::IAComponent::toString

(

)

Helper function to print commonly needed values associated with this interface.

toString() [4/6]

std::string acacia::IAHyperlink::toString

(

)

Helper function to print commonly needed values associated with this interface.

toString() [5/6]

std::string acacia::IATable2::toString

(

)

Helper function to print commonly needed values associated with this interface.

toString() [6/6]

std::string acacia::IAValue::toString

(

)

Helper function to print commonly needed values associated with this interface.

Variable Documentation

IANode

class ACACIA_EXPORT acacia::IANode

Represents a node in the MSAA with IAccessible2 accessibility tree. This object wraps an MSAA/IAccessible Interface pointer.