ScriptForge Assinaturas de métodos

As bibliotecas do ScriptForge reúnem recursos de scripting de macros para o LibreOffice, para que possam ser chamadas a partir de macros Basic ou de scripts Python. Os seus módulos e classes são chamados a partir de scripts do utilizador como «Serviços» que expõem propriedades, métodos e eventos.

Sempre que são propostos métodos de serviço exclusivamente para o LibreOffice Basic, a sua sintaxe corresponde à das sub-rotinas, funções ou propriedades do Basic.
Sempre que são propostos métodos de serviço para Python e Basic, ou apenas para Python, a sua sintaxe e os seus argumentos seguem um formato textual específico.

Método de serviço apenas básico

Os símbolos tipográficos, tais como parênteses, reticências ou chaves, indicam argumentos opcionais, repetitivos ou obrigatórios:

[opt1|opt2|opt3] Os elementos entre parênteses são opcionais; as alternativas são indicadas por uma barra vertical,
caso[[sep]…] As reticências indicam uma possível repetição; pode ser especificado um separador opcional,
{opção1|opção2} Os elementos entre chaves são obrigatórios; as alternativas são indicadas por uma barra vertical.

Exemplo:


       FSO.HashFile(FileName As String, _
           Algorithm As String = {MD5|SHA1|SHA224|SHA256|SHA384|SHA512}) As String
       SF_Array.ImportFromCSVFile(FileName As String, _
           [Delimiter = ","], [DateFormat As String]) As Variant
       SF_String.SplitNotQuoted(InputStr As String, _
          [Delimiter As String], [Occurrences As Long], [QuoteChar As String]) As Variant

Métodos de serviço em Python ou Basic

As seguintes regras tipográficas combinam a notação UML, o formato da documentação da API e a interface de utilizador do inspetor de objetos do UNO:

Os parâmetros opcionais são indicados com «opt», com «=» seguido de um valor por predefinição ou entre parênteses «[ ]».
os argumentos são escritos em minúsculas, de modo a cumprir a norma PEP 8 do Python, enquanto o Basic não faz distinção entre maiúsculas e minúsculas.
Os argumentos das coleções ou as sequências da API são representados utilizando a multiplicidade da UML. O mesmo se aplica aos valores de retorno.
Os tipos de dados básicos e as anotações do Python são transpostos sintaticamente da seguinte forma:

LibreOffice Basic	Sintaxe	Python
Booleano	bool	bool
Date	datetime	datetime
Double	float	float
Integer	int	int
Long	int	int
Object	obj
Single	float	float
String	str	str
Variant	any
Objeto UNO	uno
Tipo Definido pelo Utilizador (UDT)	obj
ScriptForge serviço	svc

Exemplo:

svc.Forms( opt form: any ): svc[0..*]

svc.MsgBox( prompt: str, buttons = svc.MB_OK , opt title: str ): opt str

svc.InputBox( prompt: str, default = "", [ title: str ], [ xpostwips: int, ypostwips: int ] ): str