Metodowe signatury ScriptForge

Biblioteki ScriptForge resursy skriptowanja makrow z LibreOffice nahromadźuja, kotrež so maja z makrow Basic abo skriptow Python wuwołać. Jeho module a klasy so z wužiwarskich skriptow jako „Słužby“ wuwołuja, kotrež kajkosće, metody a podawki wotkrywaja.

Hdyžkuli so słužbowe metody jenož za LibreOffice Basic namjetuja, wotpowěduje jich syntaksowe předstajenje tym, kotrež podrutiny, funkcije abo kajkosće Basic wužiwaja.
Hdyžkuli so słužbowe metody za Python a Basic namjetuja, abo jenož za Python, jich syntaksa a argumenty wěsty tekstowe wuhotowanje wužiwaja.

Słužbowa metoda jenož za Basic

Typografiske znamješka kaž na přikład róžkate spinki, wuwostajenske dypki abo kwaklate spinki opcionalne, wospjetowace so abo obligatoriske argumenty poznamjenjeja:

[opt1|opt2|opt3] Items inside brackets are optional, alternatives are indicated with a vertical bar,
case[[sep]…] An ellipsis indicates a possible repetition, an optional separator may be specified,
{choice1|choice2} Items inside curly braces are mandatory, alternatives are indicated with a vertical bar.

Přikład:


       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

Słužbowe metody Python abo Basic

Slědowace typografiske prawidła notaciju UML, wuhotowanje dokumentacije API a wužiwarski powjerch objektoweho inspektora UNO měšeja:

Opcionalne parametry so pak z opt, '=' hromadźe ze standardnej hódnotu pak z róžkatymi spinkami '[]' podawaja.
arguments are lowercased, in order to comply with Python PEP 8 while Basic is case-agnostic.
Collections arguments or API sequences are denoted using UML multiplicity. That applies also to return values.
Basic data types and Python annotations are syntactically transposed as:

LibreOffice Basic	Syntax	Python
Boolean	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 Object	uno
User Defined Type (UDT)	obj
ScriptForge service	svc

Přikład:

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