Автор:	© Анатолий Камынин
Дата публикации:	2005

Продолжение описания встроенных функций языка сценариев JAWS для работы с окнами приложений и навигации по элементам диалоговых окон.

• Функция navGetNextObjectID
• Функция navGetObjectContainerHelp
• Функция navGetObjectHelp
• Функция navGetObjectName
• Функция navGetObjectTypeCode
• Функция navGetObjectTypeString
• Функция navGetParentObjectID
• Функция navGetPrevObjectID
• Функция navGetRealObjectID
• Функция navGetTopLevelObjectID
• Функция navSayObjectTypeAndText
• Функция PostMessage
• Функция RefocusToForegroundDialog
• Функция Refresh
• Скрипт RefreshScreen
• Функция RefreshWindow
• Скрипт SayBottomLineOfWindow
• Функция SayFocusedWindow
• Функция SayFocusRect
• Функция SayFocusRects

Функция navGetNextObjectID

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

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

Параметр 1:

Handle, ID объекта, с которого функция начнёт свою работу (то есть объект, относительно которого будет определяться следующий объект). Этот параметр является обязательным.

Параметр 2:

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

Эта функция доступна в следующих версиях:

1. JAWS 5.0 и более поздних

Функция navGetObjectContainerHelp

Описание: Возвращает набор (container) строк помощи для объекта с определённым ID в указанном родительском окне. Если не указаны родительское окно и ID объекта, то используется объект, расположенный в позиции активного курсора.

Возвращаемое значение: String, набор (container) строк помощи для указанного объекта.

Параметр 1:

Handle, ID объекта, о котором нужно получить информацию. Если ID объекта не указан, то используется navGetCurrentObjectID, чтобы получить ID объекта по умолчанию. Этот параметр не является обязательным.

Параметр 2:

Handle, дескриптор родительского окна, в котором расположен объект. Если дескриптор окна не указан, то используется GetCurrentWindow,чтобы определить дескриптор окна по умолчанию. Этот параметр не является обязательным.

Эта функция доступна в следующих версиях:

1. JAWS 5.0 и более поздних

Функция navGetObjectHelp

Описание: Возвращает строку помощи для объекта с определённым ID в указанном окне. Если не указаны родительское окно и ID объекта, то используется объект, расположенный в позиции активного курсора.

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

Параметр 1:

Handle, ID объекта, о котором надо получить информацию. Если ID объекта не указан, то используется navGetCurrentObjectID, чтобы определить значение этого параметра по умолчанию. Этот параметр не является обязательным.

Параметр 2:

Handle, дескриптор родительского окна, в котором расположен объект. Если дескриптор окна не указан, то используется GetCurrentWindow(), чтобы определить значение этого параметра по умолчанию. Этот параметр не является обязательным.

Эта функция доступна в следующих версиях:

1. JAWS 5.0 и более поздних

Функция navGetObjectName

Описание: Возвращает имя объекта с определённым ID в указанном окне. Если не указаны родительское окно и ID объекта, то используется объект, расположенный в позиции активного курсора.

Возвращаемое значение: String, имя указанного объекта.

Параметр 1:

Handle, ID объекта, о котором надо получить информацию. Если ID объекта не указан, то используется navGetCurrentObjectID, чтобы определить значение этого параметра по умолчанию. Этот параметр не является обязательным.

Параметр 2:

Handle, дескриптор родительского окна, в котором расположен объект. Если дескриптор окна не указан, то используется GetCurrentWindow(), чтобы определить значение этого параметра по умолчанию. Этот параметр не является обязательным.

Эта функция доступна в следующих версиях:

1. JAWS 5.0 и более поздних

Функция navGetObjectTypeCode

Описание: Возвращает код типа объекта с определённым ID в указанном родительском окне. Если не указаны дескриптор родительского окна и ID объекта, то возвращается код типа объекта, находящегося в позиции активного курсора.

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

Параметр 1:

Handle <, ID интересующего объекта или функция, возвращающая ID объекта, для которого необходимо получить код типа объекта. Если ID объекта не указан, то используется функция navGetCurrentObjectID(), чтобы получить значение этого параметра по умолчанию. Этот параметр не является обязательным.

Параметр 2:

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

Эта функция доступна в следующих версиях:

1. JAWS 5.0 и более поздних

Функция navGetObjectTypeString

Описание: Возвращает строку, описывающую тип объекта с указанным идентификатором (ID) из определённого родительского окна. Если родительское окно и ID объекта не указаны, то возвращается строка описания типа для объекта, расположенного в текущей позиции активного курсора.

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

Параметр 1:

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

Параметр 2:

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

Эта функция доступна в следующих версиях:

1. JAWS 5.0 и более поздних

Функция navGetParentObjectID

Описание: Определяет, какой объект является непосредственным родителем текущего объекта (то есть какой объект находится на более высоком логическом уровне в иерархии объектов). Например, если воспользоваться этой функцией в диалоговом окне, то она вернёт дескриптор окна, создавшего данный диалог. Функция navGetParentObjectID может быть использована для того, чтобы, пройдя через список ID объектов, добраться до нужного объекта.

Возвращаемое значение: Handle, ID родительского объекта.

Параметр 1:

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

Параметр 2:

Handle, дескриптор родительского окна. Если дескриптор не указан, то для определения значения параметра по умолчанию используется функция GetCurrentWindow(). Этот параметр не является обязательным.

Эта функция доступна в следующих версиях:

1. JAWS 5.0 и более поздних

Функция navGetPrevObjectID

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

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

Параметр 1:

Handle, ID объекта, с которого функция начнёт свою работу (то есть объект, относительно которого будет определяться предыдущий объект). Этот параметр является обязательным.

Параметр 2:

Handle, дескриптор родительского окна, в котором находятся интересующие объекты. Если дескриптор родительского окна не указан, то по умолчанию используется функция GetCurrentWindow(), чтобы определить дескриптор текущего окна. Этот параметр не является обязательным.

Эта функция доступна в следующих версиях:

1. JAWS 5.0 и более поздних

Функция navGetRealObjectID

Описание: Перебирает список объектов в поисках id реального объекта. Реальным считается объект, имеющий заголовок.

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

Параметр 1:

Handle, id объекта, с которого функция начнёт свою работу. Этот параметр является обязательным.

Параметр 2:

Handle, дескриптор родительского окна, в котором находятся интересующие объекты. Если дескриптор родительского окна не указан, то по умолчанию используется функция GetCurrentWindow(), чтобы определить дескриптор текущего окна. Этот параметр не является обязательным.

Эта функция доступна в следующих версиях:

1. JAWS 5.0 и более поздних

Функция navGetTopLevelObjectID

Описание: Похожа на функцию navGetAppMainObjectID . Однако эти две функции отличаются тем, что navGetAppMainObjectID будет всегда возвращать ID объекта, находящегося на вершине иерархии объектов текущего приложения. Напротив, navGetTopLevelObjectID может использоваться в диалоговых окнах для получения ID верхнего объекта диалогового окна, что может быть полезно, когда у приложения есть несколько дочерних окон, являющихся реальными объектами. Следует использовать navGetTopLevelObjectID, если NavGetRealWindowObjectID не возвращает ID верхнего объекта в диалоговом окне.

Возвращаемое значение: Handle, ID объекта верхнего уровня.

Параметр 1:

Handle, ID объекта, с которого функция начнёт свой поиск объекта верхнего уровня. Этот параметр является обязательным.

Параметр 2:

Handle, дескриптор родительского окна. Если дескриптор не указан, то для определения значения параметра по умолчанию будет использована функция GetCurrentWindow(). Этот параметр не является обязательным.

Эта функция доступна в следующих версиях:

1. JAWS 5.0 и более поздних

Функция navSayObjectTypeAndText

Описание: Сообщает название и тип объекта, указанного в её параметрах, или, если функция вызвана без параметров, объекта, расположенного в позиции активного курсора. Эта функция похожа на функцию SayWindowTypeAndText. Отличия заключаются в том, что если окно содержит несколько объектов, то функция navSayObjectTypeAndText сообщит название и тип одного объекта, который находится в позиции курсора, а функция SayWindowTypeAndText расскажет обо всем, что содержится в окне. Если окно не содержит несколько объектов, то результат действия этих функций будет одинаковым. Когда используется эта функция, то она помечает текст, который читает так, что функции SayHighlightedText и SayNonHighlightedText, если они включены, не повторяли ту же самую информацию.

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

Параметр 1:

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

Параметр 2:

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

Эта функция доступна в следующих версиях:

1. JAWS 5.0 и более поздних

Функция PostMessage

Описание: Предоставляет ограниченный доступ к одноимённой функции Windows API (более подробную информацию по функциям Windows API следует искать в the Windows Platform SDK и других руководствах по программированию в среде Microsoft Windows). Для параметров wParam и lParam допускаются только числовые значения. Указатели на строки или структуры для этих параметров не поддерживаются.

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

Параметр 1:

Handle, дескриптор окна, которому адресовано сообщение. Этот параметр является обязательным.

Параметр 2:

Int, числовой код сообщения. Этот параметр является обязательным.

Параметр 3:

Int, значение параметра wParam (по умолчанию 0).< Этот параметр не является обязательным.

Параметр 4:

Int, значение параметра lParam (по умолчанию 0). Этот параметр не является обязательным.

Эта функция доступна в следующих версиях:

1. PAC Mate 1.10 и более поздних
2. JAWS 5.10 и более поздних

Функция RefocusToForegroundDialog

Описание: Пытается поместить фокус переднего плана в диалоговое окно поверх остальных окон.

Возвращаемое значение: Handle, в случае успешного завершения функция возвращает дескриптор диалогового окна, куда был помещён фокус.

Параметры: отсутствуют

Эта функция доступна в следующих версиях:

1. PAC Mate 2.0 и более поздних

Функция Refresh

Описание: Обновляет экран.

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

Параметр 1:

Int, 1 - принудительное обновление, 0 - обновление только в случае необходимости. Этот параметр не является обязательным.

Эта функция доступна в следующих версиях:

1. PAC Mate 1.10 и более поздних
2. JAWS 4.51 и более поздних

Скрипт RefreshScreen

Описание: Обновляет экран и изменяет состояние информации о Screen Model. Как правило, по умолчанию для этого скрипта назначена комбинация клавиш Insert + Escape.

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

Параметры: отсутствуют

Этот скрипт доступен в следующих версиях:

1. PAC Mate 1.10 и более поздних
2. JAWS 4.51 и более поздних

Функция RefreshWindow

Описание: Обновляет содержимое окна и всех входящих в него окон. Функция работает быстрее, чем функция обновления всего экрана.

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

Параметр 1:

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

Эта функция доступна в следующих версиях:

1. PAC Mate 1.10 и более поздних
2. JAWS 4.51 и более поздних

Скрипт SayBottomLineOfWindow

Описание: Читает содержимое нижней строки окна, которая обычно является строкой статуса. Как правило, по умолчанию для этого скрипта назначена комбинация клавиш Insert + PageDown.

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

Параметры: отсутствуют

Этот скрипт доступен в следующих версиях:

1. PAC Mate 1.10 и более поздних
2. JAWS 4.51 и более поздних

Функция SayFocusedWindow

Описание: Используется, чтобы озвучить элемент, который владеет фокусом ввода (аналогично скрипту, выполняемому по комбинации клавиш INSERT+TAB). Функция может быть использована в скриптах для конкретного приложения в тех случаях, когда необходимо реализовать специальную обработку текста в окне, содержащем фокус, не изменяя при этом функцию-обработчик события изменения фокуса.

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

Параметры: отсутствуют

Эта функция доступна в следующих версиях:

1. PAC Mate 1.10 и более поздних
2. JAWS 4.51 и более поздних

Функция SayFocusRect

Описание: Озвучивает содержимое, находящееся внутри прямоугольной области фокуса ввода. Она возвращает TRUE, если какой-нибудь текст был прочитан, и FALSE - в противном случае.

Возвращаемое значение: Int, True или False, 1 или 0.

Параметр 1:

Handle, дескриптор окна. Этот параметр является обязательным.

Эта функция доступна в следующих версиях:

1. PAC Mate 1.10 и более поздних
2. JAWS 4.51 и более поздних

Функция SayFocusRects

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

Возвращаемое значение: Int, TRUE, если текст был прочитан, FALSE - в противном случае.

Параметр 1:

Handle, дескриптор окна. Этот параметр является обязательным.

Эта функция доступна в следующих версиях:

1. PAC Mate 1.10 и более поздних
2. JAWS 4.51 и более поздних