ScriptForge Mga Lagda ng Pamamaraan

Pinagsasama-sama ng mga library ng ScriptForge ang mga mapagkukunan ng macro scripting para sa LibreOffice na ma-invoke mula sa mga Basic na macro o Python script. Ang mga module at klase nito ay ginagamit mula sa mga script ng user bilang "Mga Serbisyo" na naglalantad ng mga katangian, pamamaraan at kaganapan.

Sa tuwing iminumungkahi ang mga paraan ng serbisyo para lamang sa LibreOffice Basic, tumutugma ang kanilang syntax presentation sa mga Basic na subroutine, function o property.
Sa tuwing ang mga pamamaraan ng serbisyo ay iminungkahi para sa Python at Basic, o para lamang sa Python, ang kanilang syntax at mga argumento ay gumagamit ng isang partikular na layout ng teksto.

Pangunahing paraan lamang ng serbisyo

Ang mga typographical na character gaya ng mga bracket, ellipsis o curly braces ay tumutukoy sa opsyonal, paulit-ulit o sapilitang argumento:

[opt1|opt2|opt3] Ang mga item sa loob ng mga bracket ay opsyonal, ang mga alternatibo ay ipinahiwatig ng isang patayong bar,
kaso[[sep]...] Ang isang ellipsis ay nagpapahiwatig ng isang posibleng pag-uulit, isang opsyonal na separator ay maaaring tukuyin,
{choice1|choice2} Ang mga bagay sa loob ng mga kulot na brace ay sapilitan, ang mga alternatibo ay ipinahiwatig sa isang vertical bar.

Halimbawa:


       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 o Basic na mga pamamaraan ng serbisyo

Ang mga sumusunod na panuntunan sa typographical ay pinaghahalo ang UML notation, ang API documentation layout at ang UNO object inspector user interface:

Ang mga opsyonal na parameter ay ipinahiwatig na may alinman sa opt, '=' na may kasamang default na halaga, o '[ ]' na mga bracket.
ang mga argumento ay lowercase, para makasunod sa Python PEP 8 habang ang Basic ay case-agnostic.
Ang mga argumento ng koleksyon o mga pagkakasunud-sunod ng API ay tinutukoy gamit ang multiplicity ng UML. Nalalapat din iyon sa pagbabalik ng mga halaga.
Ang mga pangunahing uri ng data at Python annotation ay syntactically transposed bilang:

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
Tinukoy ng User Uri (UDT)	obj
ScriptForge serbisyo	svc

Halimbawa:

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