Перейти к оглавлению, на следующую или предыдущую страницу.

Для продвинутых пользователей

Библиотечка CyrillicTools содержит ряд внутренних функций, которые могут пригодиться продвинутым пользователям при создании собственных программ на OpenOffice.org Basic. Далее следует описание функций, входящих в состав модулей CommonFuncs и AccessRegistry.

Функции, входящие в состав модуля CommonFuncs

getDocumentType As Boolean

Возвращает тип документа: «Text», «Spreadsheet», «Presentation» или «Drawing». Если переданный в функцию объект не является документом, возвращается строка «Unknown».

Функция использует три аргумента (последние два являются необязательными):

• oTestDocument As Object

Документ, тип которого подлежит проверке.

• sAllowedTypes () As String

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

• bCorrectType As Boolean

Флаг, используемый для того, чтобы выяснить, относится ли тип данного документа к числу допустимых. В качестве этого аргумента необходимо передавать переменную типа Boolean; после выполнения функции она будет равна True, если возвращаемое функцией значение совпадет с одним из членов массива sAllowedTypes (), и False в противном случае.

Если этот аргумент был задан, и в ходе работы функции ему было присвоено значение False, функция выведет сообщение с указанием на несоответствие типа документа тому, который требуется в данной ситуации.

IsSelectedText As Boolean

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

Функция использует два аргумента (последний из них является необязательным):

• oTestDocument As Object

Документ, наличие выделения в котором подлежит проверке.

• bReportError As Boolean

Флаг, которым устанавливается, нужно ли выводить сообщение об ошибке в случае, если выделение в документе отсутствует. Имеет смысл задать значение True, если контекст макроса предполагает работу с выделенным фрагментом. По умолчанию False.

Функции для работы с реестром OpenOffice.org (модуль «AccessRegistry»)

getRegistryKeyInstance As Object

Обеспечивает доступ к ключу реестра OpenOffice.org, над которым потом можно производить операции по чтению и записи данных. Использует три аргумента, из которых последние два являются необязательными:

• sKeyName As String

Имя ключа реестра, например, «org.openoffice.Office.Common/».

• bForUpdate As Boolean

Должно быть задано как True, если предполагается запись данных в реестр. По умолчанию False.

• oLocale As com.sun.star.lang.Locale

Структура, представляющая локаль. Имеет смысл только в приложении к тем ключам реестра, которые допускают локализацию. По умолчанию не используется, возвращаемые значения соответствуют локали текущей инсталляции OOo.

getRegistryString As String

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

• oRoot As Object

Ключ реестра, предварительно полученный с помощью функции getRegistryKeyInstance ().

• sSection As String

Иерархический путь к требуемому подуровню ключа oRoot.

• sKey As String

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

• sDefaultVal As String

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

getRegistryInt As Integer

То же, что и getRegistryString, но используется для получения числовых данных. Требует тех же аргументов, что и getRegistryString, но последний (необязательный) аргумент имеет тип Integer.

getRegistryBool As Boolean

То же, что и getRegistryString, но используется для получения булевых значений (Истина или Ложь). Требует тех же аргументов, что и getRegistryString, но последний (необязательный) аргумент имеет тип Boolean.

getRegistryFlag As Integer

Преобразует полученную из реестра строку («Yes», «No» или «As Is») в числа 1, 0 и 2 соответственно. Полученное число может быть использовано для установки значения элемента управления CheckBox в диалогах. Использует четыре аргумента, первые три те же, что и у getRegistryString. Последний аргумент является необязательным:

• iDefaultVal As Integer

Значение, возвращаемое функцией по умолчанию (например, если требуемый ключ реестра не найден). Если не задано, то устанавливается равным двум, что соответствует строке реестра «As Is».

setRegistryString

Используется для сохранения строковых данных в реестр. Требует четырех аргументов:

• oRoot As Object

Ключ реестра, предварительно полученный с помощью функции getRegistryKeyInstance ().

• sSection As String

Иерархический путь к требуемому подуровню ключа oRoot.

• sKey As String

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

• sValue As String

Значение, подлежащее записи в реестр.

setRegistryInt As Integer

То же, что и setRegistryString, но используется для записи числовых данных. Требует тех же аргументов, что и setRegistryString, но последний аргумент имеет тип Integer.

setRegistryBool As Integer

То же, что и setRegistryString, но используется для записи булевых значений (Истина или Ложь). Требует тех же аргументов, что и setRegistryString, но последний аргумент имеет тип Boolean.

setRegistryFlag As Integer

Преобразует число (1, 0 или 2) соответственно в одну из следующих строк: «Yes», «No» или «As Is». Может быть полезна для сохранения в реестре значений элементов управления CheckBox в удобочитаемой форме. Требует четырех аргументов, первые три те же, что и у setRegistryString, а последний имеет тип Integer:

• iValue As Integer

Значение, подлежащее записи в реестр после преобразования в одну из названных строк.

Перейти к оглавлению, на следующую или предыдущую страницу.