Structure

UIAccessibility

No overview available.

Declaration

struct UIAccessibility

Topics

Type Aliases

struct UIAccessibility.Notification

A notification that an accessible application can send.

struct UIAccessibilityTraits

A mask that contains the OR combination of the accessibility traits that best characterize an accessibility element.

Notifications

static let announcementDidFinishNotification: NSNotification.Name

Posted by UIKit when the system has finished reading an announcement.

static let assistiveTouchStatusDidChangeNotification: NSNotification.Name

Posted by UIKit when the enabled status of AssistiveTouch changes in system preferences.

static let boldTextStatusDidChangeNotification: NSNotification.Name

Posted by UIKit when the system’s Bold Text setting has changed.

static let closedCaptioningStatusDidChangeNotification: NSNotification.Name

Posted by UIKit when the setting for closed captioning has changed.

static let darkerSystemColorsStatusDidChangeNotification: NSNotification.Name

Posted by UIKit when the system’s Darken Colors setting has changed.

static let elementFocusedNotification: NSNotification.Name

Posted by UIKit when an assistive technology focuses on an element.

static let grayscaleStatusDidChangeNotification: NSNotification.Name

Posted by UIKit when the system’s Grayscale setting has changed.

static let guidedAccessStatusDidChangeNotification: NSNotification.Name

Posted by UIKit when a Guided Access session starts or ends.

static var hearingDevicePairedEar: UIAccessibility.HearingDeviceEar

Returns the current pairing status of MFi hearing aids.

static let hearingDevicePairedEarDidChangeNotification: NSNotification.Name

Posted by UIKit when there is a change to the currently paired hearing devices.

static let invertColorsStatusDidChangeNotification: NSNotification.Name

Posted by UIKit when the setting for inverted colors has changed.

static let monoAudioStatusDidChangeNotification: NSNotification.Name

Posted by UIKit when system audio changes from stereo to mono.

static let reduceMotionStatusDidChangeNotification: NSNotification.Name

Posted by UIKit when the system’s Reduce Motion setting has changed.

static let reduceTransparencyStatusDidChangeNotification: NSNotification.Name

Posted by UIKit when the system’s Reduce Transparency system setting has changed.

static let shakeToUndoDidChangeNotification: NSNotification.Name

Posted by UIKit when the system's shake to undo feature is enabled or disabled.

static let speakScreenStatusDidChangeNotification: NSNotification.Name

Posted by UIKit when the system’s Speak Screen setting has changed.

static let speakSelectionStatusDidChangeNotification: NSNotification.Name

Posted by UIKit when the system’s Speak Selection setting has changed.

static let switchControlStatusDidChangeNotification: NSNotification.Name

Posted by UIKit when the system’s Switch Control setting has changed.

static let voiceOverStatusDidChangeNotification: NSNotification.Name

Posted by UIKit when VoiceOver starts or stops.

Getting Capabilities

static var isAssistiveTouchRunning: Bool

Returns a Boolean value indicating whether the system preference for AssistiveTouch is enabled.

static var isBoldTextEnabled: Bool

Returns a Boolean value indicating whether bold text is enabled.

static var isClosedCaptioningEnabled: Bool

Returns a Boolean value indicating whether closed captioning is enabled.

static var isDarkerSystemColorsEnabled: Bool

Returns a Boolean value indicating whether darken colors is enabled.

static var isGrayscaleEnabled: Bool

Returns a Boolean value indicating whether grayscale is enabled.

static var isGuidedAccessEnabled: Bool

Returns a Boolean value indicating whether the app is running in Guided Access mode.

static var isInvertColorsEnabled: Bool

Returns a Boolean value indicating whether inverted colors is enabled.

static var isMonoAudioEnabled: Bool

Returns a Boolean value indicating whether system audio is set to mono.

static var isReduceMotionEnabled: Bool

Returns a Boolean value indicating whether reduce motion is enabled.

static var isReduceTransparencyEnabled: Bool

Returns a Boolean value indicating whether reduce transparency is enabled.

static var isShakeToUndoEnabled: Bool

Returns a Boolean value indicating whether the system preference for Shake to Undo is enabled.

static var isSpeakScreenEnabled: Bool

Returns a Boolean value indicating whether speaking the screen is enabled.

static var isSpeakSelectionEnabled: Bool

Returns a Boolean value indicating whether speaking the selection is enabled.

static var isSwitchControlRunning: Bool

Returns a Boolean value indicating whether Switch Control is enabled.

static var isVoiceOverRunning: Bool

Returns a Boolean value indicating whether VoiceOver is running.

Type Methods

static func convertToScreenCoordinates(UIBezierPath, in: UIView) -> UIBezierPath

Converts the specified path object to screen coordinates and returns a new path object with the results.

static func convertToScreenCoordinates(CGRect, in: UIView) -> CGRect

Converts the specified rectangle from view coordinates to screen coordinates.

static func focusedElement(using: UIAccessibility.AssistiveTechnologyIdentifier?) -> Any?

Returns the element that is currently focused by the specified assistive technology.

static func guidedAccessRestrictionState(forIdentifier: String) -> UIAccessibility.GuidedAccessRestrictionState

Returns the restriction state for the specified guided access restriction.

static func registerGestureConflictWithZoom()

Warns users that application-specific gestures conflict with the system-defined Zoom accessibility gestures.

static func requestGuidedAccessSession(enabled: Bool, completionHandler: (Bool) -> Void)

Transitions the app to or from Single App mode asynchronously.

static func zoomFocusChanged(zoomType: UIAccessibility.ZoomType, toFrame: CGRect, in: UIView)

Notifies the system that the app’s focus has changed to a new location.

Structures

struct UIAccessibility.HearingDeviceEar

Constants that specify how a hearing device is being used.

Enumerations

enum UIAccessibilityContainerType

Constants indicating the type of content stored in a data-based container.

enum UIAccessibilityNavigationStyle

Constants that describe how an object’s elements should be navigated by an assistive technology.

enum UIAccessibilityScrollDirection

The direction of a scrolling action.

enum UIAccessibility.ZoomType

The types of system zoom that can be in effect.

enum UIAccessibility.GuidedAccessRestrictionState

The state of a restriction, either allow or deny.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software