Макросы, диалоги и библиотеки (Basic)

Ocean Basic Tools - это расширение OpenOffice.org.

Оно создано разработчиком для разработчиков, доступно для свободной загрузки на этом сайте и включает в себя модификацию уже известного программистам расширения Xray и собственный набор инструментов Basic Tools.

Работа этого расширения тестировалась MyOOo.ru в версиях OpenOffice.org 2.4 pro, OpenOffice.org 3.0beta.

Примечание от MyOOo.ru: далее в этой статье немного переработанное справочное руководство по расширению Ocean Basic Tools. Оригинальный вариант справочного руководства вы можете получить, установив упомянутое расширение.

Вы можете установить и использовать это расширение на условиях стандартной общественной лицензии GNU GPL.

Технические Требования

• Операционная система: любая
• Рекомендумые версии OpenOffice.org: 2.4, 2.4.1, 3.0beta

Установка

Пакет Ocean Basic Tools поставляется в виде расширения oxt.

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

Но перед установкой вам необходимо выполнить следующие действия:

1. Удалить приложение Xray Tool, если оно установлено. Можно удалить только библиотеку XrayTool, не удаляя библиотеку XrayDyn, в этом случае ваши старые настройки Xray сохранятся.
2. Убедиться, что сочетания горячих клавиш, заданные для IDE Basic, идентичны стандартным, так как после установки Ocean Basic Tools они будут заменены.
3. Проверить отсутствие заданных действий на событие Запуск приложения (Сервис - Настройка - События). Если на него назначено какое либо действие, Ocean Basic Tools не сможет правильно подключить свой модуль автозапуска, что, в принципе, ошибкой не является, но может приводить к некоторым неприятным последствиям при вызове Xray из вашего приложения. Подробнее смотрите раздел, посвящённый Xray.

Первый запуск

После установки Ocean Basic Tools в окне IDE появится соответствующая панель. При первом вызове любой функции пакета будет выведено окно О программе и сообщение о необходимости настройки системы для работы с Ocean Basic Tools. После выполнения настройки необходимо перезапустить OpenOffice.org.

Удаление

Перед удалением Ocean Basic Tools с помощью стандартного окна управления расширениями необходимо запустить процедуру отключения пакета от системы.

Для этого выберите пункт Удалить регистрацию Ocean Basic Tools в меню Справка окна IDE. Если удаление было произведено без предварительного отключения пакета, необходимо удалить его системные вызовы: автозапуск при старте OpenOffice.org и назначенные комбинации клавиш.

Basic Tools

Библиотека Basic Tools является составной частью Ocean Basic Tools и добавляет ряд возможностей редактирования кода ООBasic в окне IDE. Это как стандартные возможности редакторов (закомментировать блок кода, раскомментировать блок кода и т.д.), так и весьма специфичные, например, отражение выражений - о возможностях будет рассказано чуть ниже.

Вид панели инструментов Ocean Basic Tools:

Кнопки панели слева направо:

• Xray Storm - вызов Xray Storm.
  
• Закомментировать блок  - преобразует выделенный блок кода в комментарий.
• Раскомментировать блок  - действие, обратное предыдущему.
• Удалить комментарии - удаляет комментарии из выделенного текста. Если часть комментариев необходимо оставить, применяйте для комментирования зарезервированное слово REM.
• Вставить стандартную конструкцию - открывает окно выбора и вставки базовых конструкций. Подробности смотрите в следующем разделе.
  
• Журнал буфера обмена - открывает окно слежения за системным буфером обмена. Подробнее об этом читайте в соответствующем разделе.
  
• Отразить выражение - переворачивает выражение вокруг осевого знака. Подробнее смотрите далее.
• Преобразовать список в массив строк - вставляет скопированный в буфер обмена список (например из документа) как функцию массива строк. Подробнее смотрите далее.
  
• Справка -вызов страницы справочного руководства.

Вставка базовых конструкций

Окно базовых конструкций позволяет выполнять быструю вставку основных конструкций Star Basic в текст модуля.

Список в левой части окна отображает имена доступных конструкций, например, Sub. Текст выбранной в этом списке конструкции отображается в текстовом поле в нижней части окна. Двойной клик мышью по пункту этого списка или нажатие клавиши ENTER вставляет конструкцию в текст модуля.

• Группа Показывать в правой верхней части окна содержит флажки, указывающие, какие группы конструкций отображать в списке.
• Поле Длина разделителей позволяет задать количество символов в разделительных линиях.
• Поле Пустых строк - количество пустых строк внутри конструкций.

Журнал буфера обмена

Ocean Basic Tools умеет следить за системным буфером обмена, сохраняя копируемую в него текстовую информацию. Использование окна, отвечающего за эту возможность, аналогично использованию окна Базовые конструкции.

Отличия существуют только в настройках окна.

• Флажок Следить за буфером обмена включает функцию слежения. По умолчанию эта функция выключена.
• Поле Сохранять записей указывает, какое количество записей следует хранить. Максимум доступно 512, по умолчанию - 128 записей. Слишком большое значение может приводить к значительному потреблению ресурсов оперативной памяти (до 32 Мб).
• Поле Пропускать слова короче указывает минимальную длину копируемого текста, заносимого в журнал.
• Флажок Обрабатывать имена API включает функцию обработки имён интерфейсов, сервисов, структур и т.п., копируемых из SDK, при занесении в журнал. Например, при копировании следующего текста со страницы SDK:
  
  он будет помещён в буфер обмена, а в журнал будет записан текст com.sun.star.frame.XDesktop. Это позволяет легко вставлять в код скопированные имена сервисов как параметры, например, для функции createUNOService(). 

 Отражение выражений

Позволяет перевернуть выражение относительно знака равенства или некоторых других символов. Например, часто приходится получать значение свойства объекта, запоминать его, изменять, и затем снова восстанавливать:

sVar = oDialog.getModel.Label1.Label

...

...

...

oDialog.getModel.Label1.Label = sVar

В этом случае достаточно скопировать первую строку кода, затем разместить курсор там, где требуется строка, аналогичная последней, и нажать данную кнопку панели или соответствующее сочетание клавиш. Можно также выделить строку. В этом случае она будет заменена перевёрнутой строкой.

Хотя встроенная проверка синтаксиса позволяет избежать совсем уж очевидных ошибок, правильность выделения строки полностью остаётся на совести пользователя.

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

• "=" - для переворота выражений присвоения;
• "&" - для переворота (обмена местами) конкатенации строк;
  
• "," - для переворота (обмена местами) элементов массива;
  
• ":" - для изменения порядка выполнения кода в строке;
  
• "-", "/", " mod " - для переворота математических выражений.
  

Преобразование списка в массив строк

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

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

Пример:

Скопирован следующий список:

• Дёшево
• Быстро
• Качественно

Будет вставлена строка:

= Array("Дёшево","Быстро","Качественно")

Xray Storm

Данный инструмент также является составной частью Ocean Basic Tools и создан на основе широко распространённого приложения Xray Tool.

Основное его предназначение - изучение объектов OpenOffice.org при разработке макросов на встроенном макроязыке StarBasic (OpenOffice.org Basic).

Использование приложения весьма просто. Достаточно вызвать Xray из своего кода, передав ему в качестве параметра переменную, содержащую ссылку на объект, который требуется изучить:

xray oObject

Здесь oObject - имя изучаемого объекта. В отличии от оригинальной версии, Xray Storm может быть вызван без параметров: с помощью кнопки Xray на панели инструментов Ocean Basic Tools, нажатием комбинации клавиш в окне IDE, или же прямо из кода:

xray

В этом случае перед отображением главного окна будет выведено предложение выбрать изучаемый объект:

Можно выбрать следующие объекты:

• StarDesktop - объект рабочего стола OpenOffice.org
• ThisComponent - текущий компонент.
• GlobalScope.BasicLibraries - обзор библиотек Basic глобального контейнера библиотек.
• GlobalScope.DialogLibraries - обзор библиотек диалогов глобального контейнера библиотек.
• Секцию настроек - секцию реестра OpenOffice.org, имя которой можно выбрать в выпадающем списке, расположенном ниже.

Главное окно Xray Storm:

Как видно на изображении, главное окно мало чем отличается от оригинальной версии приложения и ещё больше похоже на версии Xray Tool 5.2+ и Xray Tool 5.2++.

Работа с ним интуитивно понятна для разработчика ООП.

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

Кнопка '...' слева от него позволяет перейти к объекту напрямую, что может понадобиться, если интересующий объект возвращается методом, который требует аргумент. Например, чтобы получить элемент активного фрейма по известному URL ресурса из объекта StarDesktop в окне прямого доступа нужно ввести следующую строку

'.ActiveFrame.LayoutManager.getElement("private:resource/toolbar/standardbar")'.

Кнопка '▴' вернёт вас к просмотру исходного объекта.

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

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

Кнопка Анализировать это ... позволяет перейти к изучению свойства или значения, возвращаемого методом, в строке которого расположен курсор. То же действие можно сделать, дважды щёлкнув левой клавишей мыши в строке интересующего свойства в главном окне программы.

Кнопка Командная строка позволяет выполнить строку кода StarBasic, не выходя из Xray Storm. Если в выполняемой строке требуется использовать исходный объект (объект, переданный Xray Storm в качестве параметра при вызове), к нему можно обратиться по имени «Исходный_объект»

Свойства объектов, ранее отображённые в данном сеансе работы с Xray Storm будут изменяться, однако эти изменения не будут наблюдаться в этом сеансе.

Если требуется выполнить несколько выражений, их следует разделить знаком двоеточия (:). В случае, когда Xray Storm не может по каким-либо причинам выполнить введённую команду, возвращается соответствующие сообщение.

Блок кнопок Фильтр позволяет отфильтровать строки главного окна Xray Storm по их содержимому. Кнопка '...' позволяет ввести произвольный текст фильтра, или выбрать предлагаемый текст из списка. Следующие пять кнопок содержат наиболее вероятные строки фильтрации по мнению Xray Storm.

Группа Вид позволяет изменять способ отображение свойств в главном окне. Эти настройки действуют до закрытия окна Xray Storm.

Кнопка Конфигурация предоставляет доступ к настройке приложения.

Здесь можно указать путь к локальной копии SDK, если таковая имеется на вашем компьютере. По умолчанию используется SDK расположенный в интернете по адресу http://api.openoffice.org.

Секция Браузер позволяет указать, какой браузер использовать для отображения страниц SDK. Флажок Отметьте, если браузер не вызывается позволяет включить альтернативный режим вызова браузера. Установите его в том случае, если Xray Storm не может открыть браузер, или генерируется системное сообщение о невозможности найти требуемый файл.

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

Кнопка Описание в SDK позволяет перейти к описанию объекта из главного окна, в строке которого находится курсор.

Кнопка com::sun::star открывает страницу SDK с описанием одноименного модуля.

Выбор буквы алфавита в окне алфавитного указателя открывает соответствующую страницу указателя SDK.

Кнопка Developers Guide открывает страницу с содержанием руководства разработчика. Если SDK, находящийся на локальном ресурсе, не включает руководство разработчика, Xray Storm будет пытаться получить доступ к нему в сети интернет.

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

Обсудить на форуме...

•  Если при использовании Ocean Basic Tools вы столкнулись с проблемами, пожалуйста, посмотрите раздел встроенного справочного руководства Возможные проблемы и методы их решения. Если ваша проблема не указана в этом списке, пожалуйста, свяжитесь с автором: Этот e-mail защищен от спам-ботов. Для его просмотра в вашем браузере должна быть включена поддержка Java-script
•  В текст данной статьи не были включены разделы  Некоторые необходимые замечания для желающих изучать исходный код; Возможные проблемы и методы их решения. Для ознакомления с этими разделами, обратитесь к справочному руководству
•  Если вы хотите, чтобы в следующих версиях были добавлены какие-либо требуемые вам функции или желаете заказать разработку любого другого дополнения для OpenOffice.org, напишите нам.
•  Перейти на страницу загрузки