Accessibility API
Category: API Collection
Overview
Browse API in the Accessibility framework.
Details
Topics
- System settings
- struct AccessibilitySettings
- Notifications
- enum AccessibilityNotification
- struct AccessibilityTechnology
- static let automation: AccessibilityTechnology
- static let fullKeyboardAccess: AccessibilityTechnology
- static let hoverText: AccessibilityTechnology
- static let speakScreen: AccessibilityTechnology
- static let switchControl: AccessibilityTechnology
- static let voiceControl: AccessibilityTechnology
- static let voiceOver: AccessibilityTechnology
- static let zoom: AccessibilityTechnology
- class AccessibilityRequest
- Features
- API ReferenceCustomized accessibility content
- API ReferenceAudio graphs
- API ReferenceHearing device support
- func AXNameFromColor(CGColor) -> String
- Braille
- API ReferenceBraille displays
- class AXBrailleTable
- class AXBrailleTranslator
- class AXBrailleTranslationResult
- Math expressions
- class AXMathExpressionNumber
- class AXMathExpressionIdentifier
- class AXMathExpressionOperator
- class AXMathExpressionText
- class AXMathExpressionFenced
- class AXMathExpressionRow
- class AXMathExpressionTable
- class AXMathExpressionTableCell
- class AXMathExpressionTableRow
- class AXMathExpressionUnderOver
- class AXMathExpressionSubSuperscript
- class AXMathExpressionFraction
- class AXMathExpressionMultiscript
- class AXMathExpressionRoot
- class AXMathExpression
- protocol AXMathExpressionProvider
- Override sessions
- class AXFeatureOverrideSession
- class AXFeatureOverrideSessionManager
- struct Options
- let AXFeatureOverrideSessionErrorDomain: String
- struct AXFeatureOverrideSessionError
- enum Code
- com.apple.developer.accessibility.merchant-api-control
- Deprecated
- func AXAnimatedImagesEnabled() -> Bool
- func AXPrefersHeadAnchorAlternative() -> Bool
-
func AXPrefersHorizontalTextLayout() -> Bool
-
Accessibility
- Accessibility API
Overview
While many Apple frameworks provide built-in accessibility support, the Accessibility framework defines API for supporting additional accessibility features across multiple platforms. The Accessibility framework includes API that enable you to:
- Respond to changes in Accessibility system settings
- Post accessibility notifications
- Define an accessible representation of your chart to support audio graphs
- Interact with hardware such as braille displays and hearing devices
- Generate a localized description of a color
Topics (Grouped)
System settings
- AccessibilitySettings — struct; A structure for working with accessibility system settings.
Notifications
- AccessibilityNotification — enum; Types of accessibility notifications that an app can post.
Assistive technologies
- AccessibilityTechnology — struct
- letautomation:AccessibilityTechnology — static
- letfullKeyboardAccess:AccessibilityTechnology — static
- lethoverText:AccessibilityTechnology — static
- letspeakScreen:AccessibilityTechnology — static
- letswitchControl:AccessibilityTechnology — static
- letvoiceControl:AccessibilityTechnology — static
- letvoiceOver:AccessibilityTechnology — static
- letzoom:AccessibilityTechnology — static
- AccessibilityRequest — class
Features
- Customized accessibility content — API Reference; Customize your apps to deliver accessibility information to your users in measured portions as they need it.
- Audio graphs — API Reference; Define an accessible representation of your chart for VoiceOver to generate an audio graph.
- Hearing device support — API Reference; Access information about paired hearing aid devices and streaming status.
- AXNameFromColor(CGColor) ->String — func; Returns a localized description of the color to use in accessibility attributes.
Braille
- Braille displays — API Reference; Display a graphical representation of images, icons, data, and more on a two-dimensional braille display.
- AXBrailleTable — class; A rule for translating print text to Braille, and back-translating Braille to print text.
- AXBrailleTranslator — class; Translates print text to Braille and Braille to print text according to the given Braille table.
- AXBrailleTranslationResult — class; The result of translation or back-translation.
Math expressions
- AXMathExpressionNumber — class
- AXMathExpressionIdentifier — class
- AXMathExpressionOperator — class
- AXMathExpressionText — class
- AXMathExpressionFenced — class
- AXMathExpressionRow — class
- AXMathExpressionTable — class
- AXMathExpressionTableCell — class
- AXMathExpressionTableRow — class
- AXMathExpressionUnderOver — class
- AXMathExpressionSubSuperscript — class
- AXMathExpressionFraction — class
- AXMathExpressionMultiscript — class
- AXMathExpressionRoot — class
- AXMathExpression — class
- AXMathExpressionProvider — protocol
Override sessions
- AXFeatureOverrideSession — class; A token object that represents an override session held by your app.
- AXFeatureOverrideSessionManager — class; A manager class to begin and end accessibility feature override sessions. Multiple override sessions are reconciled by combining the requests, preferring feature enablement. Ending all sessions restores the prior state of Accessibility feature enablement. Your app must be entitled with com.apple.developer.accessibility.merchant-api-control.
- Options — struct; Options indicating which Accessibility features will be turned on or off when an override session is held by your app.
- AXFeatureOverrideSessionErrorDomain:String — let
- AXFeatureOverrideSessionError — struct
- Code — enum
- com.apple.developer.accessibility.merchant-api-control
Deprecated
- AXAnimatedImagesEnabled() ->Bool — func; Returns a Boolean value that indicates whether the system setting for Animated Images is on.
- AXPrefersHeadAnchorAlternative() ->Bool — func; Returns a Boolean value that indicates the person’s preference for content that follows their head position.
- AXPrefersHorizontalTextLayout() ->Bool — func; Returns a Boolean value that indicates whether the
Source: https://developer.apple.com/documentation/accessibility/accessibility-api