Classes
class	acacia::AtspiActionInterface

class	acacia::AtspiComponentInterface

class	acacia::AtspiDocumentInterface

class	acacia::AtspiHyperlinkInterface

class	acacia::AtspiNode

class	acacia::AtspiTableCellInterface

class	acacia::AtspiTableInterface

class	acacia::AtspiTextInterface

class	acacia::AtspiValueInterface

Functions
std::string	acacia::AtspiActionInterface::toString () const override

int	acacia::AtspiActionInterface::getNActions () const

std::string	acacia::AtspiActionInterface::getName (int index) const

std::string	acacia::AtspiActionInterface::getDescription (int index) const

std::string	acacia::AtspiComponentInterface::toString () const override

std::pair< int, int >	acacia::AtspiComponentInterface::getPosition () const

std::pair< int, int >	acacia::AtspiComponentInterface::getSize () const

std::string	acacia::AtspiDocumentInterface::toString () const override

std::string	acacia::AtspiDocumentInterface::getLocale () const

std::vector< std::string >	acacia::AtspiDocumentInterface::getDocumentAttributes () const

std::string	acacia::AtspiHyperlinkInterface::toString () const override

int	acacia::AtspiHyperlinkInterface::getStartIndex () const

int	acacia::AtspiHyperlinkInterface::getEndIndex () const

std::string	acacia::AtspiHyperlinkInterface::getURI (int index=0) const

bool	acacia::AtspiNode::isNull () const

std::string	acacia::AtspiNode::getRoleName () const

std::string	acacia::AtspiNode::getName () const

std::string	acacia::AtspiNode::getDescription () const

std::vector< std::string >	acacia::AtspiNode::getAttributes () const

std::vector< std::string >	acacia::AtspiNode::getInterfaces () const

std::vector< std::string >	acacia::AtspiNode::getRelations () const

AtspiNode	acacia::AtspiNode::getTargetForRelationAtIndex (int relation_index, int target_index=0) const

std::vector< std::string >	acacia::AtspiNode::getStates () const

int	acacia::AtspiNode::getChildCount () const

AtspiNode	acacia::AtspiNode::getChildAtIndex (int index) const

std::vector< AtspiNode >	acacia::AtspiNode::getChildren () const

AtspiActionInterface	acacia::AtspiNode::queryAction () const

AtspiComponentInterface	acacia::AtspiNode::queryComponent () const

AtspiDocumentInterface	acacia::AtspiNode::queryDocument () const

AtspiHyperlinkInterface	acacia::AtspiNode::queryHyperlink () const

AtspiTableInterface	acacia::AtspiNode::queryTable () const

AtspiTableCellInterface	acacia::AtspiNode::queryTableCell () const

AtspiTextInterface	acacia::AtspiNode::queryText () const

AtspiValueInterface	acacia::AtspiNode::queryValue () const

std::string	acacia::AtspiTableCellInterface::toString () const override

std::pair< int, int >	acacia::AtspiTableCellInterface::getPosition () const

int	acacia::AtspiTableCellInterface::getColumnIndex () const

int	acacia::AtspiTableCellInterface::getColumnSpan () const

int	acacia::AtspiTableCellInterface::getRowIndex () const

int	acacia::AtspiTableCellInterface::getRowSpan () const

std::string	acacia::AtspiTableInterface::toString () const override

int	acacia::AtspiTableInterface::getNColumns () const

int	acacia::AtspiTableInterface::getNRows () const

std::string	acacia::AtspiTextInterface::toString () const override

int	acacia::AtspiTextInterface::getCaretOffset () const

int	acacia::AtspiTextInterface::getCharacterCount () const

std::string	acacia::AtspiTextInterface::getText (int start_offset, int end_offset) const

std::string	acacia::AtspiValueInterface::toString () const override

double	acacia::AtspiValueInterface::getCurrentValue () const

double	acacia::AtspiValueInterface::getMaximumValue () const

double	acacia::AtspiValueInterface::getMinimumValue () const

AtspiNode	acacia::findRootAtspiNodeForPID (const int pid)

AtspiNode	acacia::findRootAtspiNodeForName (const std::string &name, const int pid=0)

Detailed Description

AT-SPI based API for Linux

Function Documentation

◆ findRootAtspiNodeForName()

AtspiNode acacia::findRootAtspiNodeForName	(	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 AtspiNode representing the root accessibility object for the application with the given name, or a null AtspiNode if no such application exists.

◆ findRootAtspiNodeForPID()

AtspiNode acacia::findRootAtspiNodeForPID ( const int pid )

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

Parameters

pid	The process id of the running application.

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

◆ getAttributes()

std::vector<std::string> acacia::AtspiNode::getAttributes ( ) const

Wraps atspi_accessible_get_attributes.

Returns: A vector of strings representing a GHashTable*. Each string in the vector is a key value pair separated by a ":" character, for example, "xml-roles:main".

◆ getCaretOffset()

int acacia::AtspiTextInterface::getCaretOffset ( ) const

Wraps atspi_text_get_caret_offset.

◆ getCharacterCount()

int acacia::AtspiTextInterface::getCharacterCount ( ) const

Wraps atspi_text_get_character_count.

◆ getChildAtIndex()

AtspiNode acacia::AtspiNode::getChildAtIndex ( int index ) const

Wraps atspi_accessible_get_child_at_index.

Parameters

index Index of the child to retrieve.

Returns: An AtspiNode.

◆ getChildCount()

int acacia::AtspiNode::getChildCount ( ) const

Wraps atspi_accessible_get_child_count.

◆ getChildren()

std::vector<AtspiNode> acacia::AtspiNode::getChildren ( ) const

Helper function to return a vector of all children.

Returns: An vector of AtspiNode.

◆ getColumnIndex()

int acacia::AtspiTableCellInterface::getColumnIndex ( ) const

Wraps atspi_table_cell_get_column_index.

◆ getColumnSpan()

int acacia::AtspiTableCellInterface::getColumnSpan ( ) const

Wraps atspi_table_cell_get_column_span.

◆ getCurrentValue()

double acacia::AtspiValueInterface::getCurrentValue ( ) const

Wraps atspi_value_get_current_value.

◆ getDescription() [1/2]

std::string acacia::AtspiNode::getDescription ( ) const

Wraps atspi_accessible_get_description.

◆ getDescription() [2/2]

std::string acacia::AtspiActionInterface::getDescription ( int index ) const

Wraps atspi_action_get_description.

Parameters

index Index of the action.

◆ getDocumentAttributes()

std::vector<std::string> acacia::AtspiDocumentInterface::getDocumentAttributes ( ) const

Wraps atspi_document_get_document_attributes.

Returns: A vector of strings representing a GHashTable*. Each string in the vector is a key value pair separated by a ":" character, for example, "MimeType:text/html".

◆ getEndIndex()

int acacia::AtspiHyperlinkInterface::getEndIndex ( ) const

Wraps atspi_hyperlink_get_end_index.

◆ getInterfaces()

std::vector<std::string> acacia::AtspiNode::getInterfaces ( ) const

Wraps atspi_accessible_get_interfaces.

Returns: A vector of strings.

◆ getLocale()

std::string acacia::AtspiDocumentInterface::getLocale ( ) const

Wraps atspi_document_get_locale.

◆ getMaximumValue()

double acacia::AtspiValueInterface::getMaximumValue ( ) const

Wraps atspi_value_get_maximum_value.

◆ getMinimumValue()

double acacia::AtspiValueInterface::getMinimumValue ( ) const

Wraps atspi_value_get_minimum_value.

◆ getNActions()

int acacia::AtspiActionInterface::getNActions ( ) const

Wraps atspi_action_get_n_actions.

◆ getName() [1/2]

std::string acacia::AtspiNode::getName ( ) const

Wraps atspi_accessible_get_name.

◆ getName() [2/2]

std::string acacia::AtspiActionInterface::getName ( int index ) const

Wraps atspi_action_get_name.

Parameters

index Index of the action.

◆ getNColumns()

int acacia::AtspiTableInterface::getNColumns ( ) const

Wraps atspi_table_get_n_columns.

◆ getNRows()

int acacia::AtspiTableInterface::getNRows ( ) const

Wraps atspi_table_get_n_rows.

◆ getPosition() [1/2]

std::pair<int, int> acacia::AtspiComponentInterface::getPosition ( ) const

Wraps atspi_component_get_position.

Returns: A tuple in the form (x,y).

◆ getPosition() [2/2]

std::pair<int, int> acacia::AtspiTableCellInterface::getPosition ( ) const

Wraps atspi_table_cell_get_position.

Returns: An tuple in the form (row, column).

◆ getRelations()

std::vector<std::string> acacia::AtspiNode::getRelations ( ) const

Wraps atspi_accessible_get_relation_set.

Returns: A vector of strings.

◆ getRoleName()

std::string acacia::AtspiNode::getRoleName ( ) const

Wraps atspi_accessible_get_role_name.

◆ getRowIndex()

int acacia::AtspiTableCellInterface::getRowIndex ( ) const

Wraps atspi_table_cell_get_row_index.

◆ getRowSpan()

int acacia::AtspiTableCellInterface::getRowSpan ( ) const

Wraps atspi_table_cell_get_row_span.

◆ getSize()

std::pair<int, int> acacia::AtspiComponentInterface::getSize ( ) const

Wraps atspi_component_get_size.

Returns: An tuple in the form (width, height).

◆ getStartIndex()

int acacia::AtspiHyperlinkInterface::getStartIndex ( ) const

Wraps atspi_hyperlink_get_start_index.

◆ getStates()

std::vector<std::string> acacia::AtspiNode::getStates ( ) const

Wraps atspi_accessible_get_states_set to get the state set, and calls atspi_state_set_get_states to get the string values for the state set.

Returns: A vector of strings.

◆ getTargetForRelationAtIndex()

AtspiNode acacia::AtspiNode::getTargetForRelationAtIndex	(	int	relation_index,
		int	target_index = `0`
	)		const

Helper function to get an AtspiNode referred to by relation to this node.

Parameters

relation_index	Index of the relation in array returned by getRelations.
target_index	Optional. Defaults to 0.

Returns: An AtspiNode.

◆ getText()

std::string acacia::AtspiTextInterface::getText	(	int	start_offset,
		int	end_offset
	)		const

Wraps atspi_text_get_text.

Parameters

start_offset
end_offset

◆ getURI()

std::string acacia::AtspiHyperlinkInterface::getURI ( int index = 0 ) const

Wraps atspi_hyperlink_get_uri.

Parameters

index Indiciates which hyperlink anchor to query.

◆ isNull()

bool acacia::AtspiNode::isNull ( ) const

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