Работа со скриптами

(По материалам Freedom Scientific Developer Network)
Дата публикации:2004
Twitter Facebook Vkontakte

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

Функция Delay

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

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

Параметр 1:

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

Параметр 2:

Int, TRUE, если надо подавлять проверку и обработку функций FocusChangedEvent и NewTextEvent перед возвращением из задержки. Этот параметр является необязательным.

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

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

Функция GetCurrentScriptKeyName

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

Возвращаемое значение: String, наименование комбинации клавиш.

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

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

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

Функция GetScriptDescription

Описание: Возвращает описание определённого скрипта.

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

Параметр 1:

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

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

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

Функция GetScriptFileName

Описание: Возвращает имя файла, в котором находится активный скрипт (либо это файл скриптов по умолчанию, либо это скрипты активного приложения). Для файла скриптов приложения функция возвращает то же имя, что и у исполняемого файла приложения. исключение составляют те случаи, когда загружаемый при старте приложения файл со скриптами во время выполнения заменяет сам себя другим файлом посредством функции SwitchToScriptFile.Аналогичным образом для файла скриптов по умолчанию возвращается имя файла, определённого в JFW.INI, исключая те случаи, когда происходит замена файла скриптов при помощи функции SwitchToScriptFile.

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

Параметр 1:

Int, True - если нужно получить имя файла скриптов приложения, False - если надо получить имя файла скриптов по умолчанию. Этот параметр является обязательным.

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

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

Функция GetScriptKeyName

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

Возвращаемое значение: String, наименование комбинации клавиш.

Параметр 1:

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

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

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

Функция GetScriptKeyNames

Описание: Возвращает список всех клавиш и клавиатурных комбинаций, связанных с указанным скриптом.

Возвращаемое значение: String, Список с разделёнными элементами, содержащий все клавиши, связанные с указанным скриптом.

Параметр 1:

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

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

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

Функция GetScriptSynopsis

Описание: Возвращает краткое описание (synopsis) указанного скрипта.

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

Параметр 1:

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

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

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

Функция IsSameScript

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

Возвращаемое значение: Int, число, указывающее сколько раз вызывался скрипт. 0 означает, что до текущего вызова скрипт не вызывался ни разу.

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

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

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

Функция Pause

Описание: Приостанавливает выполнение скрипта так, чтобы другое приложение могло завершить текущую операцию. Если функция Pause помещается в скрипт, Jaws уступает процессорное время, необходимое другим приложениям. После того, как другим приложениям будет дана возможность использовать процессорное время, Jaws продолжит выполнение скрипта. Как сказано в оригинальном руководстве, функция Pause эквивалентна функции Delay со значением 1.Не следует помещать функцию Pause внутрь цикла, так как это может привести к зависанию компьютера.

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

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

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

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

Функция ReformatKeyName

Описание: Получает наименование клавиатурной комбинации, назначенной скрипту, и переформатирует это наименование в строку, которую можно использовать в сообщении.

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

Параметр 1:

string, правильное (допустимое) наименование клавиатурной комбинации. Этот параметр является обязательным.

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

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

Функция SayCurrentScriptKeyLabel

Описание: Сообщает наименование клавиши, назначенной текущему скрипту, учитывая настройки эха ввода и метку, определённую в DEFAULT.JCF.

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

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

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

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

Функция ScheduleFunction

Описание: Вызывает назначенную пользователем функцию после истечения определённого периода времени. Может быть полезна, когда вы хотите выполнить задачу через определённый интервал времени. После запуска таймера этой функцией, вы можете вызвать UnscheduleFunction, чтобы отменить вызов пользовательской функции.

Возвращаемое значение: Int, ID (идентификатор), который следует использовать при вызове функции UnSchedule. Если возвращен 0, то таймер не был установлен.

Параметр 1:

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

Параметр 2:

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

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

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

Пример

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

Script TimerTest()
MessageBox ("Сейчас будет запущен таймер!")
If !ScheduleFunction ("timer", 10*600) Then
SayString("Таймер не запущен")
EndIf
EndScript
Void Function timer ()
MessageBox ("Прошло 10 минут")
If !ScheduleFunction ("timer", 10*600) Then
SayString("Таймер не запущен")
EndIf
EndFunction

Функция ScriptAndAppNames

Описание: Может быть необходима во время работы приложения. Информация, возвращаемая этой функцией, может быть получена при помощи комбинации клавиш JAWSKey+ Q.

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

Параметр 1:

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

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

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

Скрипт ScriptFileName

Описание: Используется для определения текущего скрипта и активного приложения.

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

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

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

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

Скрипт ScriptManager

Описание: Используется для редактирования и компиляции скриптов JAWS. Скрипты (сценарии) - это небольшие программы, которые управляют работой JAWS и которые обычно запускаются нажатием определённой клавиатурной комбинации.

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

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

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

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

Скрипт ScriptManagerDefault

Описание: Запускает ScriptManager (Диспетчер скриптов) с файлом скриптов по умолчанию (default.jss).

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

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

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

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

Функция SwitchToScriptFile

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

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

Параметр 1:

String, имя бинарного файла скриптов, который должен быть загружен в память. В качестве параметра может быть указано имя файла, заключенное в двойные кавычки, или имя строковой переменной, содержащей имя файла. Имя файла должно быть указано без расширения jsb. Попытка использовать расширение JSS в имени файла приведёт к ошибке и появлению предупреждающего сообщения. Этот параметр является обязательным.

Параметр 2:

String, имя альтернативного бинарного файла скриптов, который будет загружен в случае, если первый файл не существует. В качестве параметра может быть указано имя файла, заключённое в двойные кавычки, или имя строковой переменной, содержащей имя файла. Имя файла должно быть указано без расширения jsb. Попытка использовать расширение JSS в имени файла приведёт к ошибке и появлению предупреждающего сообщения. Этот параметр является обязательным.

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

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

Функция TpeCurrentScriptKey

Описание: Передает код нажатой клавиши текущему приложению без обработки.

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

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

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

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

Функция Unknown

Описание: Срабатывает, если не удалось найти скрипт или функцию в сценариях JAWS. Сообщает имя неизвестных функции или скрипта.

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

Параметр 1:

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

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

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

Функция UnScheduleFunction

Описание: Используется для прекращения работы функции ScheduleFunction, то есть останавливает таймер.

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

Параметр 1:

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

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

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


Распространение материалов сайта означает, что распространитель принял условия лицензионного соглашения.
Идея и реализация: © Владимир Довыденков и Анатолий Камынин,  2004-2019