Std/Docu/ru/Api.odc

StdApi
ENGLISH
Редакция перевода: Ф.В.Ткачев, 2010-10-24

DEFINITION StdApi;

	IMPORT Views;

	PROCEDURE CloseDialog (OUT closedView: Views.View);
	PROCEDURE OpenAux (file, title: ARRAY OF CHAR; OUT v: Views.View);
	PROCEDURE OpenAuxDialog (file, title: ARRAY OF CHAR; OUT v: Views.View);
	PROCEDURE OpenBrowser (file, title: ARRAY OF CHAR; OUT v: Views.View);
	PROCEDURE OpenCopyOf (file: ARRAY OF CHAR; OUT v: Views.View);
	PROCEDURE OpenDoc (file: ARRAY OF CHAR; OUT v: Views.View);
	PROCEDURE OpenToolDialog (file, title: ARRAY OF CHAR; OUT v: Views.View);

END StdApi.


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

PROCEDURE CloseDialog (OUT closedView: Views.View)
Команда закрывает окно, находящееся в данный момент в фокусе. Если окно является окном документа, и его содержимое изменено (окно грязное), то будет выдано сообщение об ошибке. Корневая вьюшка закрытого окна будет возвращена в параметре closedView. Если CloseDialog терпит неудачу, возвращается NIL.

PROCEDURE OpenAux (file, title: ARRAY OF CHAR; OUT v: Views.View)
Получает спецификацию файла документа Блэкбокса (file) и заголовок окна (title), затем открывает вспомогательное (Aux) окно с указанным загловком. Параметр file должен быть именем пути к файлу. Корневая вьюшка открытого окна возвращается в v. Если OpenAux терпит неудачу, то v возвращает NIL.
Вспомогательные окна используются для предъявления временных данных, допускающих правку.

PROCEDURE OpenAuxDialog (file, title: ARRAY OF CHAR; OUT v: Views.View)
Получает спецификацию файла документа Блэкбокса (file) и заголовок окна (title), затем открывает диалоговое окно с заданным документом. Диалог открывается как вспомогательное окно. Параметр file должен быть именем пути к файлу. Корневая вьюшка открытого окна возвращается в v. Если OpenAuxDialog терпит неудачу, то v возвращает NIL. Вспомогательные диалоги используются для самодостаточных диалогов, то есть масок ввода данных или параметров для команд.
В отличие от OpenAux, OpenAuxDialog переводит открываемый документ в режим маски, если это контейнер, и открывает его в диалоговом окне, если операционная среда, в которой работает Блэкбокс, различает окна документов и диалогов (например, как в Windows).


PROCEDURE OpenBrowser (file, title: ARRAY OF CHAR; OUT v: Views.View)
Получает спецификацию файла документа Блэкбокса (file) и заголовок окна (title), затем открывает указанный документ во вспомогательном окне. Содержимое окна нельзя править, но в нем можно выделять фрагменты. Параметр file должен быть именем пути к файлу. Корневая вьюшка открытого окна возвращается в v. Если OpenBrowser терпит неудачу, то v возвращает NIL.
Окна, открываемые таким образом, используют для документации. В содержимом окна можно выделять фрагменты и копировать их. Можно применять команды поиска, команду Info->Interface и т.д.


PROCEDURE OpenCopyOf (file: ARRAY OF CHAR; OUT v: Views.View)
Открывает новый документ, являющийся копией документа, заданного параметром file. В случае успеха в v возвращается корневая вьюшка нового документа, иначе возвращается NIL.

PROCEDURE OpenDoc (file: ARRAY OF CHAR; OUT v: Views.View)
Получает спецификацию файла документа Блэкбокса (file) и открывает документ в окне документа. Параметр file должен быть именем пути к файлу. Если такой файл уже открыт в некотором окне документа, то это окно выводится наверх вместо открытия нового. Корневая вьюшка открытого окна (или старого окна) возвращается в v. Если OpenDoc терпит неудачу, то в v возвращается NIL.
Окна документов используются для показа редактируемых данных, предназначенных для хранения.

PROCEDURE OpenToolDialog (file, title: ARRAY OF CHAR; OUT v: Views.View)
Получает спецификацию файла документа Блэкбокса (file) и заголовок окна (title), затем открывает диалог с указанным документом. Диалог открывается как инструментальное окно. Параметр file должен быть именем пути к файлу. Корневая вьюшка открытого окна возвращается в v. Если OpenToolDialog терпит неудачу, то v возвращает NIL.
Инструментальные диалоги используются для диалогов, которые работают с окнами документов под ними, например, диалог поиска и замены, который работает с текстом под собой. В остальном все идентично OpenAuxDialog.