"QSP: Экран" — Модуль работы с экраном

Версия: 1.1


Автор: Olegus t.Gl.
e-mail: olegus.tgl@gmail.com
jabber: olegus@jabber.ru
icq: 145540276

Тема на форуме iFiction.Ru: ссылка
Тема на форуме QSP: ссылка
Актуальная документация к последней версии: ссылка

О модуле

Перечень операторов платформы QSP для работы с экраном основного описания ограничен очисткой, выводом и получением всего содержимого. Данный модуль расширяет этот функционал, добавляя возможность (в html-режиме) манипулировать отдельными областями экрана, не затрагивая остальные.

Для реализации возможностей модуля выводимый на экран текст (или html-код) необходимо разбить на области с помощью тега <region id="ID">…</region>, например:

<region id="title">Заголовок</region> / <region id="text">Текст</region>

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

Варианты модуля

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

Входящие в пакет файлы

otg_lib_screen.qspСам модуль.
example_screen.qspПример работы с модулем.
otg_lib_screen_help.htmlДокументация по работе с модулем (вы как раз её читаете)

Подключение модуля

Первым делом необходимо подключить к своему проекту сам модуль. Для этого файл модуля нужно скопировать в тот же каталог, в котором находится основной проект, после чего в начало кода проекта добавить команду "ADDQST" (для QSP версии 5.7.0):

ADDQST 'otg_lib_screen.qsp'

Все локации модуля начинаются с префикса "Экран.", а переменные — с префикса "otg_", поэтому пересечения с данными основного проекта быть не должно.

Перечень команд

Экран.ПолучитьПолучает содержимое указанной области.
Экран.УстановитьУстанавливает содержимое указанной области.
Экран.ДобавитьДобавляет текст в конец содержимого указанной области.
Экран.ВставитьДобавляет текст в начало содержимого указанной области.

Описание команд


Экран.Получить

Получает содержимое указанной области.

Синтаксис:

func('Экран.Получить', <Имя области>, <Текст>)

Параметры:

Имя областиОбязательный параметр. Строка с уникальным строковым идентификатором области.
ТекстНеобязательный параметр. Текст, в котором нужно искать указанную область. Если параметр не указан, то берётся содержимое экрана основного описания.

Пример:

$Заголовок = func('Экран.Получить', 'title')

Экран.Установить

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

Синтаксис:

GS 'Экран.Установить', <Имя области>, <Устанавливаемый текст>, <Текст>, <Не выводить на экран>

Параметры:

Имя областиОбязательный параметр. Строка с уникальным строковым идентификатором области.
Устанавливаемый текстОбязательный параметр. Текст, которым необходимо заменить содержимое указанной области.
ТекстНеобязательный параметр. Текст, в котором нужно искать указанную область. Если параметр не указан, то берётся содержимое экрана основного описания.
Не выводить на экранНеобязательный параметр. Если параметр не указан или равен 0, то после изменения содержимого указанной области содержимое экрана будет замещено текстом, в котором содержалась область.

Пример:

GS 'Экран.Установить', 'title', 'Мрачная поляна'

Экран.Добавить

Добавляет текст в конец содержимого указанной области.

Синтаксис:

GS 'Экран.Добавить', <Имя области>, <Добавляемый текст>, <Текст>, <Не выводить на экран>

Параметры:

Имя областиОбязательный параметр. Строка с уникальным строковым идентификатором области.
Добавляемый текстОбязательный параметр. Текст, который необходимо добавить в конец содержимого указанной области.
ТекстНеобязательный параметр. Текст, в котором нужно искать указанную область. Если параметр не указан, то берётся содержимое экрана основного описания.
Не выводить на экранНеобязательный параметр. Если параметр не указан или равен 0, то после изменения содержимого указанной области содержимое экрана будет замещено текстом, в котором содержалась область.

Пример:

GS 'Экран.Добавить', 'text', 'Вы подобрали камень'

Экран.Вставить

Добавляет текст в начало содержимого указанной области.

Синтаксис:

GS 'Экран.Вставить', <Имя области>, <Добавляемый текст>, <Текст>, <Не выводить на экран>

Параметры:

Имя областиОбязательный параметр. Строка с уникальным строковым идентификатором области.
Добавляемый текстОбязательный параметр. Текст, который необходимо добавить в начало содержимого указанной области.
ТекстНеобязательный параметр. Текст, в котором нужно искать указанную область. Если параметр не указан, то берётся содержимое экрана основного описания.
Не выводить на экранНеобязательный параметр. Если параметр не указан или равен 0, то после изменения содержимого указанной области содержимое экрана будет замещено текстом, в котором содержалась область.

Пример:

GS 'Экран.Вставить', 'text', 'Вы подобрали камень'

Перечень изменений

Версия 1.1:





Copyright © 2011 iFiction.Ru / Olegus t.Gl. · Пользуйтесь с умом и по закону. Гарантии не прилагаются.