QAccessibleActionInterface

The QAccessibleActionInterface class implements support for invocable actions in the interface. More

Inheritance diagram of PySide6.QtGui.QAccessibleActionInterface

Inherited by: QAccessibleWidget

Synopsis

Virtual functions

Static functions

Detailed Description

Accessible objects should implement the action interface if they support user interaction. Usually this interface is implemented by classes that also implement QAccessibleInterface .

The supported actions should use the predefined actions offered in this class unless they do not fit a predefined action. In that case a custom action can be added.

When subclassing QAccessibleActionInterface you need to provide a list of actionNames which is the primary means to discover the available actions. Action names are never localized. In order to present actions to the user there are two functions that need to return localized versions of the name and give a description of the action. For the predefined action names use localizedActionName() and localizedActionDescription() to return their localized counterparts.

In general you should use one of the predefined action names, unless describing an action that does not fit these:

Action name

Description

toggleAction()

toggles the item (checkbox, radio button, switch, …)

decreaseAction()

decrease the value of the accessible (e.g. spinbox)

increaseAction()

increase the value of the accessible (e.g. spinbox)

pressAction()

press or click or activate the accessible (should correspont to clicking the object with the mouse)

setFocusAction()

set the focus to this accessible

showMenuAction()

show a context menu, corresponds to right-clicks

In order to invoke the action, doAction() is called with an action name.

Most widgets will simply implement pressAction() . This is what happens when the widget is activated by being clicked, space pressed or similar.

IAccessible2 Specification

class PySide6.QtGui.QAccessibleActionInterface
PySide6.QtGui.QAccessibleActionInterface.actionNames()
Return type

list of strings

Returns the list of actions supported by this accessible object. The actions returned should be in preferred order, i.e. the action that the user most likely wants to trigger should be returned first, while the least likely action should be returned last.

The list does only contain actions that can be invoked. It won’t return disabled actions, or actions associated with disabled UI controls.

The list can be empty.

Note that this list is not localized. For a localized representation re-implement localizedActionName() and localizedActionDescription()

static PySide6.QtGui.QAccessibleActionInterface.decreaseAction()
Return type

str

Returns the name of the decrease default action.

PySide6.QtGui.QAccessibleActionInterface.doAction(actionName)
Parameters

actionName – str

Invokes the action specified by actionName. Note that actionName is the non-localized name as returned by actionNames() This function is usually implemented by calling the same functions that other user interaction, such as clicking the object, would trigger.

See also

actionNames()

static PySide6.QtGui.QAccessibleActionInterface.increaseAction()
Return type

str

Returns the name of the increase default action.

PySide6.QtGui.QAccessibleActionInterface.keyBindingsForAction(actionName)
Parameters

actionName – str

Return type

list of strings

Returns a list of the keyboard shortcuts available for invoking the action named actionName.

This is important to let users learn alternative ways of using the application by emphasizing the keyboard.

See also

actionNames()

PySide6.QtGui.QAccessibleActionInterface.localizedActionDescription(name)
Parameters

name – str

Return type

str

Returns a localized action description of the action actionName.

When using one of the default names, you can call this function in QAccessibleActionInterface to get the localized string.

PySide6.QtGui.QAccessibleActionInterface.localizedActionName(name)
Parameters

name – str

Return type

str

Returns a localized action name of actionName.

For custom actions this function has to be re-implemented. When using one of the default names, you can call this function in QAccessibleActionInterface to get the localized string.

static PySide6.QtGui.QAccessibleActionInterface.nextPageAction()
Return type

str

Returns the name of the next page default action.

static PySide6.QtGui.QAccessibleActionInterface.pressAction()
Return type

str

Returns the name of the press default action.

static PySide6.QtGui.QAccessibleActionInterface.previousPageAction()
Return type

str

Returns the name of the previous page default action.

static PySide6.QtGui.QAccessibleActionInterface.scrollDownAction()
Return type

str

Returns the name of the scroll down default action.

static PySide6.QtGui.QAccessibleActionInterface.scrollLeftAction()
Return type

str

Returns the name of the scroll left default action.

static PySide6.QtGui.QAccessibleActionInterface.scrollRightAction()
Return type

str

Returns the name of the scroll right default action.

static PySide6.QtGui.QAccessibleActionInterface.scrollUpAction()
Return type

str

Returns the name of the scroll up default action.

static PySide6.QtGui.QAccessibleActionInterface.setFocusAction()
Return type

str

Returns the name of the set focus default action.

static PySide6.QtGui.QAccessibleActionInterface.showMenuAction()
Return type

str

Returns the name of the show menu default action.

static PySide6.QtGui.QAccessibleActionInterface.toggleAction()
Return type

str

Returns the name of the toggle default action.