ScriptForge metodoen sinadurak

ScriptForge liburutegiek makro bidezko scriptak sortzeko baliabideak eransten dizkio LibreOffice aplikazioari. Baliabide horiek Basic makroetatik zein Python scriptetatik deitu daitezke. ScriptForge-ko moduluak eta klaseak "zerbitzu" gisa deitzen dira erabiltzaile-scriptetatik, eta zerbitzu horien propietateak, metodoak eta gertaerak erabili daitezke.

Zerbitzu-metodoak LibreOffice Basic lengoaiarako soilik badira, haien sintaxiaren aurkezpenak bat egingo du Basic azpierrutina, funtzio edo propietateekin.
Zerbitzu-metodoak Python zein Basic lengoaietarako direnean, edo soilik Python-erako, haien sintaxiak eta argumentuek testu-diseinu espezifikoa erabiliko dute.

Basic lengoaiarako soilik den zerbitzu-metodoa

Karaktere tipografikoek, adibidez kortxeteek, hiru puntuek edo giltzek, argumentu errepikakorrak, aukerakoak edo derrigorrezkoak adierazten dituzte:

[opt1|opt2|opt3] Kortxeteen arteko elementuak aukerakoak dira, ordezkoak barra bertikalen bidez adirezten dira.
case[[sep]…] Etenpuntuek errepikapen posible bat adierazten dute, aukeran bereizle bat zehaztu daiteke,
{choice1|choice2} Giltzen arteko elementuak derrigorrezkoak dira, ordezkoak barra bertikal baten bidez adierazten dira.

Adibidea:


       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

Python edo Basic zerbitzu-metodoak

Hurrengo erregela tipografikoek UML notazioa, API dokumentazioaren diseinua eta UNO objektu-ikuskatzailearen erabiltzaile-interfazea nahasten dute:

Aukerako karaktereak adierazteko, opt, '=' gehi balio lehenetsi bat edo '[]' kortxeteak erabiltzen dira.
Argumentuak minuskuletan ematen dira, Python PEP 8 gida bete dezaten (Basic lengoaiari berdin dio maiuskulak edo minuskulak erabili).
Bildumen argumentuak edo API sekuentziak UML anizkoitasuna erabilita adierazten dira. Hori itzulera-balioei ere aplikatzen zaie.
Basic datu motak eta Python oharpenak honako moduan konfiguratzen dira sintaktikoki:

LibreOffice Basic	Sintaxia	Python
Boolearra	bool	bool
Date	datetime	datetime
Double	float	float
Integer	int	int
Long	int	int
Object	obj
Single	float	float
String	str	str
Variant	any
UNO objektua	uno
Erabiltzaileak definitutako mota (UDT)	obj
ScriptForge zerbitzua	svc

Adibidea:

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