Spec-Zone .ru
спецификации, руководства, описания, API

Библиотека разработчика Mac

Разработчик

Ссылка AXUIElement.h

Опции
Развертывание Target:

На этой странице
Язык:

Ссылка AXUIElement.h

Вспомогательные приложения используют функции, определяемые в этом заголовочном файле, чтобы связаться с и управлять доступными приложениями, работающими в Mac OS X.

Каждый доступный элемент пользовательского интерфейса в приложении представлен AXUIElementRef, который является CFTypeRef. AXUIElementRefs (как весь CFTypeRefs) может использоваться со всеми Базовыми полиморфными функциями Основы, такими как CFRetain, CFRelease и CFEqual.

Все функции, определяемые в этом возврате заголовочного файла kAXErrorSuccess на успехе. Если существует своего рода отказ системной памяти, такой как отказ выделить объект, все функции могут возвратиться kAXErrorFailure. В маловероятном случае, что некоторый процесс не полностью поддерживает доступность API, функция может возвратиться kAXErrorNotImplemented.

Кроме того, некоторые функции могут возвратить следующие коды ошибки:

kAXErrorInvalidUIElement

Переданный - в AXUIElementRef недопустим. Все функции, включающие параметр AXUIElementRef, могут возвратить этот код ошибки.

kAXErrorIllegalArgument

По крайней мере один из параметров недопустим (например, NIL передал в для указателя).

kAXErrorCannotComplete

Существует проблема с обменом сообщениями (такой, обмениваясь сообщениями к сбоям сервера или когда доступное приложение безразлично или ожидает ввода данных пользователем). Все функции, выполняющие обмен сообщениями, могут возвратить этот код ошибки.

kAXErrorAPIDisabled

Доступность API отключена. Все функции, выполняющие обмен сообщениями, могут возвратить этот код ошибки.

Для получения дополнительной информации об определении и использовании объектов доступности и на поддержке доступности Mac OS X в целом, см. Обзор Доступности для OS X.

Включенные заголовки

  • <AvailabilityMacros.h>

  • <CoreFoundation/CoreFoundation.h>

  • <ApplicationServices/ApplicationServices.h>

Функции

Уведомление API
  • AXObserverAddNotification (_: _: _: _:) AXObserverAddNotification

    Регистрирует указанного наблюдателя для получения уведомлений из указанного объекта доступности.

    Объявление

    Swift

    func AXObserverAddNotification(_ observer: AXObserver!, _ element: AXUIElement!, _ notification: CFString!, _ refcon: UnsafeMutablePointer<Void>) -> AXError

    Objective C

    AXError AXObserverAddNotification ( AXObserverRef observer, AXUIElementRef element, CFStringRef notification, void *refcon );

    Параметры

    observer

    Объект наблюдателя, создаваемый от вызова до AXObserverCreate.

    element

    Объект доступности, для которого можно наблюдать уведомления.

    notification

    Имя уведомления для наблюдения.

    refcon

    Определенные с помощью приложения данные передали обратному вызову, когда это вызывают.

    Возвращаемое значение

    Если неуспешный, AXObserverAddNotification может возвратить один из следующих кодов ошибки, среди других:

    kAXErrorInvalidUIElementObserver

    Наблюдатель не является допустимым типом AXObserverRef.

    kAXErrorIllegalArgument

    Один или больше параметров недопустимое значение, или длина имени уведомления больше, чем 1 024.

    kAXErrorNotificationUnsupported

    Объект доступности не поддерживает уведомления (обратите внимание на то, что объект доступности в масштабе всей системы не поддерживает уведомления).

    kAXErrorNotificationAlreadyRegistered

    Уведомление было уже зарегистрировано.

    kAXErrorCannotComplete

    Функция не может завершиться, потому что обмен сообщениями перестал работать в некотором роде.

    kAXErrorFailure

    Существует своего рода отказ системной памяти.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.2 и позже.

  • AXObserverCreate (_: _: _:) AXObserverCreate

    Создает нового наблюдателя, который может получить уведомления от указанного приложения.

    Объявление

    Swift

    func AXObserverCreate(_ application: pid_t, _ callback: AXObserverCallback, _ outObserver: UnsafeMutablePointer<Unmanaged<AXObserver>?>) -> AXError

    Objective C

    AXError AXObserverCreate ( pid_t application, AXObserverCallback callback, AXObserverRef *outObserver );

    Параметры

    application

    Процесс ID приложения.

    callback

    Функция обратного вызова.

    outObserver

    По возврату, AXObserverRef, представляющий объект наблюдателя.

    Возвращаемое значение

    Если неуспешный, AXObserverCreate может возвратить один из следующих кодов ошибки, среди других:

    kAXErrorIllegalArgument

    Один или больше параметров недопустимое значение.

    kAXErrorFailure

    Существует своего рода отказ системной памяти.

    Обсуждение

    Когда наблюдаемое уведомление получено, оно передается AXObserverCallback.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.2 и позже.

  • AXObserverCreateWithInfoCallback (_: _: _:) AXObserverCreateWithInfoCallback

    Создает нового наблюдателя, который может получить уведомления с информационным словарем из указанного приложения.

    Объявление

    Swift

    func AXObserverCreateWithInfoCallback(_ application: pid_t, _ callback: AXObserverCallbackWithInfo, _ outObserver: UnsafeMutablePointer<Unmanaged<AXObserver>?>) -> AXError

    Objective C

    AXError AXObserverCreateWithInfoCallback ( pid_t application, AXObserverCallbackWithInfo callback, AXObserverRef *outObserver );

    Параметры

    application

    Процесс ID приложения.

    callback

    Функция обратного вызова.

    outObserver

    По возврату, AXObserverRef, представляющий объект наблюдателя.

    Возвращаемое значение

    Если неуспешный, AXObserverCreateWithInfoCallback может возвратить один из следующих кодов ошибки, среди других:

    kAXErrorIllegalArgument

    Один или больше параметров недопустимое значение.

    kAXErrorFailure

    Существует своего рода отказ системной памяти.

    Обсуждение

    Когда наблюдаемое уведомление получено, оно передается AXObserverCallbackWithInfo.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.9 и позже.

  • AXObserverGetRunLoopSource (_:) AXObserverGetRunLoopSource

    Возвращает источник цикла выполнения наблюдателя.

    Объявление

    Swift

    func AXObserverGetRunLoopSource(_ observer: AXObserver!) -> Unmanaged<CFRunLoopSource>!

    Objective C

    CFRunLoopSourceRef AXObserverGetRunLoopSource ( AXObserverRef observer );

    Параметры

    observer

    Объект наблюдателя (создаваемый от вызова до AXObserverCreate), для которого можно получить источник цикла выполнения.

    Возвращаемое значение

    Возвращает CFRunLoopSourceRef наблюдателя; NIL, если Вы передаете NIL в observer.

    Обсуждение

    Наблюдатель должен быть добавлен к циклу выполнения, прежде чем он сможет получить уведомления. Обратите внимание на то, что выпуск AXObserverRef автоматически удаляет источник цикла выполнения из цикла выполнения (можно также сделать это явно путем вызова CFRunLoopRemoveSource).

    AXObserverGetRunLoopSource мог бы использоваться в коде таким образом:

    • CFRunLoopAddSource(CFRunLoopGetCurrent(), AXObserverGetRunLoopSource(observer), kCFRunLoopDefaultMode);

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.2 и позже.

  • AXObserverGetTypeID () AXObserverGetTypeID

    Возвращает уникальный идентификатор типа для типа AXObserverRef.

    Объявление

    Swift

    func AXObserverGetTypeID() -> CFTypeID

    Objective C

    CFTypeID AXObserverGetTypeID ( void );

    Возвращаемое значение

    Возвращает CFTypeID типа AXObserverRef.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.2 и позже.

  • AXObserverRemoveNotification (_: _: _:) AXObserverRemoveNotification

    Удаляет указанное уведомление из списка уведомлений, которые наблюдатель хочет получить от объекта доступности.

    Объявление

    Swift

    func AXObserverRemoveNotification(_ observer: AXObserver!, _ element: AXUIElement!, _ notification: CFString!) -> AXError

    Objective C

    AXError AXObserverRemoveNotification ( AXObserverRef observer, AXUIElementRef element, CFStringRef notification );

    Параметры

    observer

    Объект наблюдателя, создаваемый от вызова до AXObserverCreate.

    element

    Объект доступности, для которого этот наблюдатель наблюдает уведомления.

    notification

    Имя уведомления для удаления из списка наблюдаемых уведомлений.

    Возвращаемое значение

    Если неуспешный, AXObserverRemoveNotification может возвратить один из следующих кодов ошибки, среди других:

    kAXErrorInvalidUIElementObserver

    Наблюдатель не является допустимым типом AXObserverRef.

    kAXErrorIllegalArgument

    Один или больше параметров недопустимое значение, или длина имени уведомления больше, чем 1 024.

    kAXErrorNotificationUnsupported

    Объект доступности не поддерживает уведомления (обратите внимание на то, что объект доступности в масштабе всей системы не поддерживает уведомления).

    kAXErrorNotificationNotRegistered

    Этот наблюдатель не зарегистрировался ни для каких уведомлений.

    kAXErrorCannotComplete

    Функция не может завершиться, потому что обмен сообщениями перестал работать в некотором роде.

    kAXErrorFailure

    Существует своего рода отказ системной памяти.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.2 и позже.

Прочие условия
  • AXAPIEnabled AXAPIEnabled (OS X v10.9)

    Возвраты, включена ли доступность API.

    Объявление

    Objective C

    Boolean AXAPIEnabled ( void );

    Возвращаемое значение

    Если доступность API в настоящее время включается, иначе FALSE, возвращает TRUE.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Доступность

    Доступный в OS X v10.0 и позже.

    Осуждаемый в OS X v10.9.

  • AXIsProcessTrusted () AXIsProcessTrusted

    Возвраты, является ли текущий процесс доверяемым клиентом доступности.

    Объявление

    Swift

    func AXIsProcessTrusted() -> Boolean

    Objective C

    Boolean AXIsProcessTrusted ( void );

    Возвращаемое значение

    Возвращает TRUE, если текущий процесс является доверяемым клиентом доступности, FALSE, если это не.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.4 и позже.

  • AXIsProcessTrustedWithOptions (_:) AXIsProcessTrustedWithOptions

    Возвраты, является ли текущий процесс доверяемым клиентом доступности.

    Объявление

    Swift

    func AXIsProcessTrustedWithOptions(_ options: CFDictionary!) -> Boolean

    Objective C

    Boolean AXIsProcessTrustedWithOptions ( CFDictionaryRef options );

    Параметры

    options

    Словарь опций или NULL для указания опций. Следующие опции доступны:

    KEY: kAXTrustedCheckOptionPrompt VALUE: ACFBooleanRef, указывающий, сообщат ли пользователю, недоверяем ли текущий процесс. Если доступность не включена для текущего процесса, это могло использоваться, например, на запуске приложения, чтобы всегда предупредить пользователя. Запрос происходит асинхронно и не влияет на возвращаемое значение.

    Возвращаемое значение

    Возвращает TRUE, если текущий процесс является доверяемым клиентом доступности, FALSE, если это не.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.9 и позже.

  • AXMakeProcessTrusted AXMakeProcessTrusted (OS X v10.9)

    Попытки сделать процесс представленным указанным путем доверяемый клиент доступности.

    Объявление

    Objective C

    AXError AXMakeProcessTrusted ( CFStringRef executablePath );

    Параметры

    executablePath

    Путь к исполнимой программе процесса для создания доверяемым.

    Возвращаемое значение

    AXError, указывающий успешность или неуспешность.

    Обсуждение

    Используйте эту функцию для создания процесса доверяемым клиентом доступности.Примечание: Вызывающая сторона должна работать как root успешно вызывать эту функцию. Кроме того, вызывающая сторона должна повторно запустить процесс после того, как эта функция возвратится успешно для доверяемого состояния для вступления в силу.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Доступность

    Доступный в OS X v10.4 и позже.

    Осуждаемый в OS X v10.9.

  • AXUIElementCopyActionDescription (_: _: _:) AXUIElementCopyActionDescription

    Возвращает локализованное описание указанного действия объекта доступности.

    Объявление

    Swift

    func AXUIElementCopyActionDescription(_ element: AXUIElement!, _ action: CFString!, _ description: UnsafeMutablePointer<Unmanaged<CFString>?>) -> AXError

    Objective C

    AXError AXUIElementCopyActionDescription ( AXUIElementRef element, CFStringRef action, CFStringRef *description );

    Параметры

    element

    AXUIElementRef, представляющий объект доступности.

    action

    Действие, которое будет описано.

    description

    По возврату, строка, содержащая описание действия.

    Возвращаемое значение

    Если неуспешный, AXUIElementCopyActionDescription может возвратить один из следующих кодов ошибки, среди других:

    kAXErrorActionUnsupported

    Указанный AXUIElementRef не поддерживает указанное действие (Вы также получите эту ошибку, если Вы передадите в объекте доступности в масштабе всей системы).

    kAXErrorIllegalArgument

    Один или больше параметров недопустимое значение.

    kAXErrorInvalidUIElement

    AXUIElementRef недопустим.

    kAXErrorCannotComplete

    Функция не может завершиться, потому что обмен сообщениями перестал работать в некотором роде.

    kAXErrorNotImplemented

    Процесс не полностью поддерживает доступность API.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.2 и позже.

  • AXUIElementCopyActionNames (_: _:) AXUIElementCopyActionNames

    Возвращает список всех действий, которые может выполнить указанный объект доступности.

    Объявление

    Swift

    func AXUIElementCopyActionNames(_ element: AXUIElement!, _ names: UnsafeMutablePointer<Unmanaged<CFArray>?>) -> AXError

    Objective C

    AXError AXUIElementCopyActionNames ( AXUIElementRef element, CFArrayRef *names );

    Параметры

    element

    AXUIElementRef, представляющий объект доступности.

    names

    По возврату массиву действий объект доступности может выполнить (пустой если поддержка объектов доступности никакие действия).

    Возвращаемое значение

    Если неуспешный, AXUIElementCopyActionNames может возвратить один из следующих кодов ошибки, среди других:

    kAXErrorIllegalArgument

    Один или оба из параметров недопустимое значение.

    kAXErrorInvalidUIElement

    AXUIElementRef недопустим.

    kAXErrorFailure

    Был своего рода отказ системной памяти.

    kAXErrorCannotComplete

    Функция не может завершиться, потому что обмен сообщениями перестал работать в некотором роде.

    kAXErrorNotImplemented

    Процесс не полностью поддерживает доступность API.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.2 и позже.

  • AXUIElementCopyAttributeNames (_: _:) AXUIElementCopyAttributeNames

    Возвращает список всех атрибутов, поддерживаемых указанным объектом доступности.

    Объявление

    Swift

    func AXUIElementCopyAttributeNames(_ element: AXUIElement!, _ names: UnsafeMutablePointer<Unmanaged<CFArray>?>) -> AXError

    Objective C

    AXError AXUIElementCopyAttributeNames ( AXUIElementRef element, CFArrayRef *names );

    Параметры

    element

    AXUIElementRef, представляющий объект доступности.

    names

    По возврату, массив, содержащий названия атрибута объекта доступности.

    Возвращаемое значение

    Если неуспешный, AXUIElementCopyAttributeNames может возвратить один из следующих кодов ошибки, среди других:

    kAXErrorAttributeUnsupported

    Указанный AXUIElementRef не поддерживает указанный атрибут.

    kAXErrorIllegalArgument

    Один или оба из параметров недопустимое значение.

    kAXErrorInvalidUIElement

    AXUIElementRef недопустим.

    kAXErrorFailure

    Был отказ системной памяти.

    kAXErrorCannotComplete

    Функция не может завершиться, потому что обмен сообщениями перестал работать в некотором роде.

    kAXErrorNotImplemented

    Процесс не полностью поддерживает доступность API.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.2 и позже.

  • AXUIElementCopyAttributeValue (_: _: _:) AXUIElementCopyAttributeValue

    Возвращает значение атрибута объекта доступности.

    Объявление

    Swift

    func AXUIElementCopyAttributeValue(_ element: AXUIElement!, _ attribute: CFString!, _ value: UnsafeMutablePointer<Unmanaged<AnyObject>?>) -> AXError

    Objective C

    AXError AXUIElementCopyAttributeValue ( AXUIElementRef element, CFStringRef attribute, CFTypeRef *value );

    Параметры

    element

    AXUIElementRef, представляющий объект доступности.

    attribute

    Название атрибута.

    value

    По возврату значение связалось с указанным атрибутом.

    Возвращаемое значение

    Если неуспешный, AXUIElementCopyAttributeValue может возвратить один из следующих кодов ошибки, среди других:

    kAXErrorAttributeUnsupported

    Указанный AXUIElementRef не поддерживает указанный атрибут.

    kAXErrorNoValue

    Указанный атрибут не имеет значения.

    kAXErrorIllegalArgument

    Один или больше параметров недопустимое значение.

    kAXErrorInvalidUIElement

    AXUIElementRef недопустим.

    kAXErrorCannotComplete

    Функция не может завершиться, потому что обмен сообщениями перестал работать в некотором роде.

    kAXErrorNotImplemented

    Процесс не полностью поддерживает доступность API.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.2 и позже.

  • AXUIElementCopyAttributeValues (_: _: _: _: _:) AXUIElementCopyAttributeValues

    Возвращает массив значений атрибута для атрибута объекта доступности, запускающегося в указанном индексе.

    Объявление

    Swift

    func AXUIElementCopyAttributeValues(_ element: AXUIElement!, _ attribute: CFString!, _ index: CFIndex, _ maxValues: CFIndex, _ values: UnsafeMutablePointer<Unmanaged<CFArray>?>) -> AXError

    Objective C

    AXError AXUIElementCopyAttributeValues ( AXUIElementRef element, CFStringRef attribute, CFIndex index, CFIndex maxValues, CFArrayRef *values );

    Параметры

    element

    AXUIElementRef, представляющий объект доступности.

    attribute

    Название атрибута.

    index

    Индекс в массив.

    maxValues

    Максимальное количество значений, которые Вы хотите (это может быть более или менее, чем число значений, связанных с атрибутом).

    values

    По возврату значения атрибута Вы запросили. Если maxValues больше, чем число значений, связанных с атрибутом, values массив будет содержать значения, найденные между index и конец массива атрибута, включительно.

    Возвращаемое значение

    Если неуспешный, AXUIElementCopyAttributeValues может возвратить один из следующих кодов ошибки, среди других:

    kAXErrorIllegalArgument

    Значение атрибута не является массивом, index или maxValues параметры вне диапазона массива, или одним из других параметров является недопустимое значение.

    kAXErrorNoValue

    Указанный атрибут не имеет значения.

    kAXErrorInvalidUIElement

    AXUIElementRef недопустим.

    kAXErrorCannotComplete

    Функция не может завершиться, потому что обмен сообщениями перестал работать в некотором роде.

    kAXErrorNotImplemented

    Процесс не полностью поддерживает доступность API.

    Обсуждение

    Эта функция полезна для контакта с большими массивами, например, табличного представления с большим количеством дочерних элементов.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.2 и позже.

  • AXUIElementCopyElementAtPosition (_: _: _: _:) AXUIElementCopyElementAtPosition

    Возвращает объект доступности в указанной позиции в верхних левых относительных координатах экрана.

    Объявление

    Swift

    func AXUIElementCopyElementAtPosition(_ application: AXUIElement!, _ x: Float, _ y: Float, _ element: UnsafeMutablePointer<Unmanaged<AXUIElement>?>) -> AXError

    Objective C

    AXError AXUIElementCopyElementAtPosition ( AXUIElementRef application, float x, float y, AXUIElementRef *element );

    Параметры

    application

    AXUIElementRef, представляющий приложение, содержащее координаты экрана (или объект доступности в масштабе всей системы).

    x

    Горизонтальная позиция.

    y

    Вертикальная позиция.

    element

    По возврату доступность возражает в позиции, указанной x и y.

    Возвращаемое значение

    Если неуспешный, AXUIElementCopyElementAtPosition может возвратить один из следующих кодов ошибки, среди других:

    kAXErrorNoValue

    Нет никакого объекта доступности в указанной позиции.

    kAXErrorIllegalArgument

    Один или больше параметров недопустимое значение.

    kAXErrorInvalidUIElement

    AXUIElementRef недопустим.

    kAXErrorCannotComplete

    Функция не может завершиться, потому что обмен сообщениями перестал работать в некотором роде.

    kAXErrorNotImplemented

    Процесс не полностью поддерживает доступность API.

    Обсуждение

    Эта функция делает тестирование хита на основе z-порядка окна (т.е. разделяя на уровни). Если одно окно поверх другого окна, возвращенный объект доступности прибывает из того, какой бы ни окно является самым верхним в указанном расположении. Обратите внимание на то, что, если объект доступности в масштабе всей системы передается в application параметр, тест позиции не ограничивается определенным приложением.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.2 и позже.

  • AXUIElementCopyMultipleAttributeValues (_: _: _: _:) AXUIElementCopyMultipleAttributeValues

    Возвращает значения многократных атрибутов в объекте доступности.

    Объявление

    Swift

    func AXUIElementCopyMultipleAttributeValues(_ element: AXUIElement!, _ attributes: CFArray!, _ options: AXCopyMultipleAttributeOptions, _ values: UnsafeMutablePointer<Unmanaged<CFArray>?>) -> AXError

    Objective C

    AXError AXUIElementCopyMultipleAttributeValues ( AXUIElementRef element, CFArrayRef attributes, AXCopyMultipleAttributeOptions options, CFArrayRef *values );

    Параметры

    element

    AXUIElementRef, представляющий объект доступности.

    attributes

    Массив названий атрибута.

    options

    Говорящее значение AXUIElementCopyMultipleAttributeValues как обработать ошибки.

    values

    По возврату, массиву, в котором каждая позиция содержит значение атрибута, который находится в соответствующей позиции в переданном - в attributes массив (или CFNull). Если options = 0, values массив может содержать AXValueRef типа kAXValueAXErrorType в соответствующей позиции. Если options = kAXCopyMultipleAttributeOptionStopOnError, эта функция возвратится сразу, когда это получит ошибку.

    Возвращаемое значение

    Если неуспешный, AXUIElementCopyMultipleAttributeValues может возвратить один из следующих кодов ошибки, среди других:

    kAXErrorIllegalArgument

    Одним из параметров является недопустимое значение.

    kAXErrorInvalidUIElement

    AXUIElementRef недопустим.

    kAXErrorCannotComplete

    Функция не может завершиться, потому что обмен сообщениями перестал работать в некотором роде.

    kAXErrorNotImplemented

    Процесс не полностью поддерживает доступность API.

    Обсуждение

    Если указанный AXUIElementRef не поддерживает атрибут, переданный в attributes массив, возвращенный массив может содержать ошибку или CFNull в соответствующей позиции.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.4 и позже.

  • AXUIElementCopyParameterizedAttributeNames (_: _:) AXUIElementCopyParameterizedAttributeNames

    Возвращает список всех параметризованных атрибутов, поддерживаемых указанным объектом доступности.

    Объявление

    Swift

    func AXUIElementCopyParameterizedAttributeNames(_ element: AXUIElement!, _ names: UnsafeMutablePointer<Unmanaged<CFArray>?>) -> AXError

    Objective C

    AXError AXUIElementCopyParameterizedAttributeNames ( AXUIElementRef element, CFArrayRef *names );

    Параметры

    element

    AXUIElementRef, представляющий объект доступности.

    names

    По возврату, массив, содержащий параметризованные названия атрибута объекта доступности.

    Возвращаемое значение

    Если неуспешный, AXUIElementCopyParameterizedAttributeNames может возвратить один из следующих кодов ошибки, среди других:

    kAXErrorAttributeUnsupported

    Указанный AXUIElementRef не поддерживает указанный параметризованный атрибут.

    kAXErrorIllegalArgument

    Один или оба из параметров недопустимое значение.

    kAXErrorInvalidUIElement

    AXUIElementRef недопустим.

    kAXErrorFailure

    Был своего рода отказ системной памяти.

    kAXErrorCannotComplete

    Функция не может завершиться, потому что обмен сообщениями перестал работать в некотором роде.

    kAXErrorNotImplemented

    Процесс не полностью поддерживает доступность API.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.3 и позже.

  • AXUIElementCopyParameterizedAttributeValue (_: _: _: _:) AXUIElementCopyParameterizedAttributeValue

    Возвращает значение параметризованного атрибута объекта доступности.

    Объявление

    Swift

    func AXUIElementCopyParameterizedAttributeValue(_ element: AXUIElement!, _ parameterizedAttribute: CFString!, _ parameter: AnyObject!, _ result: UnsafeMutablePointer<Unmanaged<AnyObject>?>) -> AXError

    Objective C

    AXError AXUIElementCopyParameterizedAttributeValue ( AXUIElementRef element, CFStringRef parameterizedAttribute, CFTypeRef parameter, CFTypeRef *result );

    Параметры

    element

    AXUIElementRef, представляющий объект доступности.

    parameterizedAttribute

    Параметризованный атрибут.

    parameter

    Параметр.

    result

    По возврату, значению параметризованного атрибута.

    Возвращаемое значение

    Если неуспешный, AXUIElementCopyParameterizedAttributeValue может возвратить один из следующих кодов ошибки, среди других:

    kAXErrorAttributeUnsupported

    Указанный AXUIElementRef не поддерживает указанный параметризованный атрибут.

    kAXErrorNoValue

    Указанный параметризованный атрибут не имеет значения.

    kAXErrorIllegalArgument

    Один или больше параметров недопустимое значение.

    kAXErrorInvalidUIElement

    AXUIElementRef недопустим.

    kAXErrorCannotComplete

    Функция не может завершиться, потому что обмен сообщениями перестал работать в некотором роде.

    kAXErrorNotImplemented

    Процесс не полностью поддерживает доступность API.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.3 и позже.

  • AXUIElementCreateApplication (_:) AXUIElementCreateApplication

    Создает и возвращает объект доступности верхнего уровня для приложения с указанным процессом ID.

    Объявление

    Swift

    func AXUIElementCreateApplication(_ pid: pid_t) -> Unmanaged<AXUIElement>!

    Objective C

    AXUIElementRef AXUIElementCreateApplication ( pid_t pid );

    Параметры

    pid

    Процесс ID приложения.

    Возвращаемое значение

    AXUIElementRef, представляющие доступность верхнего уровня, возражают для приложения с указанным процессом ID.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.2 и позже.

  • AXUIElementCreateSystemWide () AXUIElementCreateSystemWide

    Возвращает объект доступности, обеспечивающий доступ к системным атрибутам.

    Объявление

    Swift

    func AXUIElementCreateSystemWide() -> Unmanaged<AXUIElement>!

    Objective C

    AXUIElementRef AXUIElementCreateSystemWide ( void );

    Возвращаемое значение

    AXUIElementRef, представляющий объект доступности в масштабе всей системы.

    Обсуждение

    Это полезно для вещей как нахождение фокусируемого объекта доступности, независимо от которого приложение в настоящее время активно.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.2 и позже.

  • AXUIElementGetAttributeValueCount (_: _: _:) AXUIElementGetAttributeValueCount

    Возвращает количество массива значения атрибута объекта доступности.

    Объявление

    Swift

    func AXUIElementGetAttributeValueCount(_ element: AXUIElement!, _ attribute: CFString!, _ count: UnsafeMutablePointer<CFIndex>) -> AXError

    Objective C

    AXError AXUIElementGetAttributeValueCount ( AXUIElementRef element, CFStringRef attribute, CFIndex *count );

    Параметры

    element

    AXUIElementRef, представляющий объект доступности.

    attribute

    Название атрибута.

    count

    По возврату, размеру массива, который является значением атрибута.

    Возвращаемое значение

    Если неуспешный, AXUIElementGetAttributeValueCount может возвратить один из следующих кодов ошибки, среди других:

    kAXErrorIllegalArgument

    Значение атрибута не является массивом, или одним из других параметров является недопустимое значение.

    kAXErrorAttributeUnsupported

    Указанный AXUIElementRef не поддерживает указанный атрибут.

    kAXErrorInvalidUIElement

    AXUIElementRef недопустим.

    kAXErrorCannotComplete

    Функция не может завершиться, потому что обмен сообщениями перестал работать в некотором роде.

    kAXErrorNotImplemented

    Процесс не полностью поддерживает доступность API.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.2 и позже.

  • AXUIElementGetPid (_: _:) AXUIElementGetPid

    Возвращает процесс ID, связанный с указанным объектом доступности.

    Объявление

    Swift

    func AXUIElementGetPid(_ element: AXUIElement!, _ pid: UnsafeMutablePointer<pid_t>) -> AXError

    Objective C

    AXError AXUIElementGetPid ( AXUIElementRef element, pid_t *pid );

    Параметры

    element

    AXUIElementRef, представляющий объект доступности.

    pid

    По возврату процессу ID связался с указанным объектом доступности.

    Возвращаемое значение

    Если неуспешный, AXUIElementGetPid может возвратить один из следующих кодов ошибки, среди других:

    kAXErrorIllegalArgument

    Один или больше параметров недопустимое значение.

    kAXErrorInvalidUIElement

    AXUIElementRef недопустим.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.2 и позже.

  • AXUIElementGetTypeID () AXUIElementGetTypeID

    Возвращает уникальный идентификатор типа для типа AXUIElementRef.

    Объявление

    Swift

    func AXUIElementGetTypeID() -> CFTypeID

    Objective C

    CFTypeID AXUIElementGetTypeID ( void );

    Возвращаемое значение

    Возвращает CFTypeID, представляющий тип AXUIElementRef.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.2 и позже.

  • AXUIElementIsAttributeSettable (_: _: _:) AXUIElementIsAttributeSettable

    Возвраты, может ли быть изменен указанный атрибут объекта доступности.

    Объявление

    Swift

    func AXUIElementIsAttributeSettable(_ element: AXUIElement!, _ attribute: CFString!, _ settable: UnsafeMutablePointer<Boolean>) -> AXError

    Objective C

    AXError AXUIElementIsAttributeSettable ( AXUIElementRef element, CFStringRef attribute, Boolean *settable );

    Параметры

    element

    AXUIElementRef, представляющий объект доступности.

    attribute

    Название атрибута.

    settable

    По возврату, булево значение, указывающее, устанавливаем ли атрибут.

    Возвращаемое значение

    Если неуспешный, AXUIElementIsAttributeSettable может возвратить один из следующих кодов ошибки, среди других:

    kAXErrorCannotComplete

    Функция не может завершиться, потому что обмен сообщениями перестал работать в некотором роде (часто вследствие тайм-аута).

    kAXErrorIllegalArgument

    Один или больше параметров недопустимое значение.

    kAXErrorAttributeUnsupported

    Указанный AXUIElementRef не поддерживает указанный атрибут.

    kAXErrorNoValue

    Указанный атрибут не имеет значения.

    kAXErrorInvalidUIElement

    AXUIElementRef недопустим.

    kAXErrorNotImplemented

    Процесс не полностью поддерживает доступность API.

    Обсуждение

    Если Вы получаете a kAXErrorCannotComplete ошибка от этой функции, Вы могли бы хотеть повторить запрос или изменить значение тайм-аута.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.2 и позже.

  • AXUIElementPerformAction (_: _:) AXUIElementPerformAction

    Запросы, что указанный объект доступности выполняет указанное действие.

    Объявление

    Swift

    func AXUIElementPerformAction(_ element: AXUIElement!, _ action: CFString!) -> AXError

    Objective C

    AXError AXUIElementPerformAction ( AXUIElementRef element, CFStringRef action );

    Параметры

    element

    AXUIElementRef, представляющий объект доступности.

    action

    Действие, которое будет выполняться.

    Возвращаемое значение

    Если неуспешный, AXUIElementPerformAction может возвратить один из следующих кодов ошибки, среди других:

    kAXErrorActionUnsupported

    Указанный AXUIElementRef не поддерживает указанное действие (Вы также получите эту ошибку, если Вы передадите в объекте доступности в масштабе всей системы).

    kAXErrorIllegalArgument

    Один или больше параметров недопустимое значение.

    kAXErrorInvalidUIElement

    AXUIElementRef недопустим.

    kAXErrorCannotComplete

    Функция не может завершиться, потому что обмен сообщениями перестал работать в некотором роде, или приложение еще не ответило.

    kAXErrorNotImplemented

    Процесс не полностью поддерживает доступность API.

    Обсуждение

    Возможно получить kAXErrorCannotComplete код ошибки от этой функции, потому что доступные приложения часто должны выполнять своего рода модальную обработку в своих обратных вызовах действия и они могут не возвратить в наборе значений тайм-аута доступностью API. Это не обязательно означает, что функция перестала работать, как бы то ни было. При необходимости Ваше вспомогательное приложение может попытаться вызвать эту функцию снова. Кроме того, можно быть в состоянии увеличить стоимость тайм-аута (см. AXUIElementSetMessagingTimeout).

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.2 и позже.

  • AXUIElementPostKeyboardEvent AXUIElementPostKeyboardEvent (OS X v10.9)

    Ключи сообщений к указанному приложению.

    Объявление

    Objective C

    AXError AXUIElementPostKeyboardEvent ( AXUIElementRef application, CGCharCode keyChar, CGKeyCode virtualKey, Boolean keyDown );

    Параметры

    application

    AXUIElementRef, представляющий приложение (или объект доступности в масштабе всей системы).

    keyChar
    virtualKey
    keyDown

    Возвращаемое значение

    Если неуспешный, AXUIElementPostKeyboardEvent может возвратить один из следующих кодов ошибки, среди других:

    kAXErrorIllegalArgument

    Один или больше параметров недопустимое значение.

    kAXErrorInvalidUIElement

    AXUIElementRef недопустим.

    kAXErrorFailure

    Существует своего рода отказ системной памяти.

    kAXErrorCannotComplete

    Функция не может завершиться, потому что обмен сообщениями перестал работать в некотором роде.

    kAXErrorNotImplemented

    Процесс не полностью поддерживает доступность API.

    Обсуждение

    Это подобно CGPostKeyboardEvent (который синтезирует низкоуровневое событие клавиатуры на локальной машине), но это позволяет Вам указывать целевое приложение в противоположность всегда отправке событий к активному приложению. Если объект доступности в масштабе всей системы передается в application параметр, событие отправляется в активное приложение.

    Можно только передать в в масштабе всей системы или приложении AXUIElementRef.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Доступность

    Доступный в OS X v10.0 и позже.

    Осуждаемый в OS X v10.9.

  • AXUIElementSetAttributeValue (_: _: _:) AXUIElementSetAttributeValue

    Устанавливает атрибут объекта доступности в указанное значение.

    Объявление

    Swift

    func AXUIElementSetAttributeValue(_ element: AXUIElement!, _ attribute: CFString!, _ value: AnyObject!) -> AXError

    Objective C

    AXError AXUIElementSetAttributeValue ( AXUIElementRef element, CFStringRef attribute, CFTypeRef value );

    Параметры

    element

    AXUIElementRef, представляющий объект доступности.

    attribute

    Название атрибута.

    value

    Новое значение для атрибута.

    Возвращаемое значение

    Если неуспешный, AXUIElementSetAttributeValue может возвратить один из следующих кодов ошибки, среди других:

    kAXErrorIllegalArgument

    Значение не распознано доступным приложением, или одним из других параметров является недопустимое значение.

    kAXErrorAttributeUnsupported

    Указанный AXUIElementRef не поддерживает указанный атрибут.

    kAXErrorInvalidUIElement

    AXUIElementRef недопустим.

    kAXErrorCannotComplete

    Функция не может завершиться, потому что обмен сообщениями перестал работать в некотором роде.

    kAXErrorNotImplemented

    Процесс не полностью поддерживает доступность API.

    Обсуждение

    Можно отправить и получить много различных CFTypeRefs с помощью доступности API. Они включают все типы CFPropertyListRef, AXUIElementRef, AXValueRef, AXTextMarkerRef, AXTextMarkerRangeRef, CFNullRef, CFAttributedStringRef и CRURLRef.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.2 и позже.

  • AXUIElementSetMessagingTimeout (_: _:) AXUIElementSetMessagingTimeout

    Устанавливает значение тайм-аута, используемое в доступности API.

    Объявление

    Swift

    func AXUIElementSetMessagingTimeout(_ element: AXUIElement!, _ timeoutInSeconds: Float) -> AXError

    Objective C

    AXError AXUIElementSetMessagingTimeout ( AXUIElementRef element, float timeoutInSeconds );

    Параметры

    element

    AXUIElementRef, представляющий объект доступности.

    timeoutInSeconds

    Число секунд для нового значения тайм-аута.

    Возвращаемое значение

    Если неуспешный, AXUIElementSetMessagingTimeout может возвратить один из следующих кодов ошибки, среди других:

    kAXErrorIllegalArgument

    Один или больше параметров недопустимое значение (значения тайм-аута должны быть положительными).

    kAXErrorInvalidUIElement

    AXUIElementRef недопустим.

    Обсуждение

    Передайте объект доступности в масштабе всей системы (см. AXUIElementCreateSystemWide), если Вы хотите установить тайм-аут глобально для этого процесса. Установка тайм-аута на другом объекте доступности устанавливает его только для того объекта, не для других объектов доступности, которые равны ему.

    Установка timeoutInSeconds к 0 для объекта доступности в масштабе всей системы сбрасывает глобальный тайм-аут к его значению по умолчанию. Установка timeoutInSeconds к 0 для любого другого объекта доступности заставляет тот элемент использовать текущее глобальное значение тайм-аута.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.4 и позже.

Обратные вызовы

Уведомление API
  • AXObserverCallback AXObserverCallback

    Объявление

    Swift

    typealias AXObserverCallback = CFunctionPointer<((AXObserver!, AXUIElement!, CFString!, UnsafeMutablePointer<Void>) -> Void)>

    Objective C

    typedef void ( *AXObserverCallback)( AXObserverRef observer, AXUIElementRef element, CFStringRef notification, void *refcon);

    Параметры

    observer

    AXObserverRef возражает для наблюдения уведомлений.

    element

    Объект доступности.

    notification

    Имя уведомления для наблюдения.

    refcon

    Определенные с помощью приложения данные указали при регистрации наблюдателя для уведомления

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.2 и позже.

  • AXObserverCallbackWithInfo AXObserverCallbackWithInfo

    Объявление

    Swift

    typealias AXObserverCallbackWithInfo = CFunctionPointer<((AXObserver!, AXUIElement!, CFString!, CFDictionary!, UnsafeMutablePointer<Void>) -> Void)>

    Objective C

    typedef void ( *AXObserverCallbackWithInfo)( AXObserverRef observer, AXUIElementRef element, CFStringRef notification, CFDictionaryRef info, void *refcon);

    Параметры

    observer

    AXObserverRef возражает для наблюдения уведомлений.

    element

    Объект доступности.

    notification

    Имя уведомления для наблюдения.

    info

    Соответствующая информация об уведомлении.

    refcon

    Определенные с помощью приложения данные указали при регистрации наблюдателя для уведомления

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.9 и позже.

Типы данных

Посмотрите раздел Overview выше для документации уровня заголовка.

  • AXCopyMultipleAttributeOptions AXCopyMultipleAttributeOptions

    Объявление

    Swift

    typealias AXCopyMultipleAttributeOptions = UInt32

    Objective C

    typedef UInt32 AXCopyMultipleAttributeOptions;

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.4 и позже.

  • AXObserverRef AXObserverRef

    Объявление

    Swift

    typealias AXObserverRef = AXObserver

    Objective C

    typedef struct __AXObserver *AXObserverRef;

    Обсуждение

    AXObserverRef является CFType. Как весь CFTypes, они - считаемая ссылка (CFRetain, CFRelease).

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.2 и позже.

  • AXUIElementRef AXUIElementRef

    Структура раньше относилась к объекту доступности.

    Объявление

    Swift

    typealias AXUIElementRef = AXUIElement

    Objective C

    typedef const struct __AXUIElement *AXUIElementRef;

    Обсуждение

    Объект доступности предоставляет информацию об объекте пользовательского интерфейса, который это представляет. Эта информация включает позицию объекта в иерархию доступности, ее позицию на дисплее, подробных данных о том, что это, и какие действия это может выполнить. Объекты доступности реагируют на сообщения, отправленные вспомогательными приложениями, и отправляют уведомления, описывающие изменения состояния.

    Оператор импорта

    Objective C

    @import ApplicationServices;

    Swift

    import ApplicationServices

    Доступность

    Доступный в OS X v10.2 и позже.

Константы

Посмотрите раздел Overview выше для документации уровня заголовка.