UniversalAccess.h

Overview

This header file contains functions that give applications the ability to control the zoom focus. Using these functions, an application can tell the Mac OS X Universal Access zoom feature what part of its user interface needs focus.

Functions

UAZoomChangeFocus

Tells the Universal Access zoom feature where it should focus.

UAZoomEnabled

Determines if the Universal Access zoom feature is enabled.

Tells the Universal Access zoom feature where it should focus.

extern OSStatus UAZoomChangeFocus( 
    const CGRect *inRect, 
    const CGRect *inHighlightRect, 
    UAZoomChangeFocusType inType);  

Parameters

inRect

The frame of the element in focus, in global 72-dot-per-inch (dpi) coordinates.

inHighlightRect

The frame of the highlighted part of the element in focus, in global 72 dpi coordinates. If the whole element is in focus, and not just a smaller part of it, pass the inRect parameter and pass NULL for inHighlightRect.

inType

A value of type UAZoomChangeFocusType.

Return Value

Returns noErr if there were no problems, if Universal Access Zoom is zoomed all the way out, or if the feature is off; returns paramErr if inRect is NULL or if inType is out of range.

Discussion

This function tells Universal Access the frame of the element in focus and the part of the element that should be in focus.

Availability

Introduced in Mac OS X v10.4.

Determines if the Universal Access zoom feature is enabled.

extern Boolean UAZoomEnabled(
    void);  

Return Value

Returns true if the Universal Access zoom feature is on, false if the zoom feature is off or if the user has zoomed all the way out.

Availability

Introduced in Mac OS X v10.4.

Typedefs

Defines the Universal Access zoom change focus type.

typedef UInt32 UAZoomChangeFocusType;  

Enumerations

Values that tell the Universal Access zoom feature what type of event is causing the change in zoom focus.

enum {  
    kUAZoomFocusTypeOther = 0,  
    kUAZoomFocusTypeInsertionPoint = 1 
};  

Constants

kUAZoomFocusTypeOther

An event is requesting focus.

kUAZoomFocusTypeInsertionPoint

The text insertion point has moved.

Did this document help you? Yes: Tell us what works for you. It’s good, but: Report typos, inaccuracies, and so forth. It wasn’t helpful: Tell us what would have helped.