Vsebina

# Podpisi metod ScriptForge

Knjižnice ScriptForge združujejo vire za skriptanje makrov za LibreOffice, klicanih iz makrov Basic ali skriptov Python. Njegovi moduli in razredi se prikličejo iz uporabniških skriptov kot »storitve«, ki razkrijejo lastnosti, metode in dogodke.

- Kadar koli so metode storitev predlagane zgolj za LibreOffice Basic, se njihova skladenjska predstavitev ujema s skladnjo podprogramov, funkcij in lastnosti Basic.

- Kadar koli so metode storitev predlagane za Python in Basic hkrati ali zgolj za Python, uporabljajo njihova skladnja in argumenti natanko določeno postavitev besedila.

## Metoda storitev samo za Basic

Tipografski znaki, kot so oklepaji, tropičja in zaviti oklepaji, označujejo neobvezne, ponavljajoče se ali obvezne argumente:

- [možn1|možn2|možn3] Elementi v oklepajih so neobvezni, možne vrednosti nakazuje navpična črtica,

- primer[[loč]…] tripičje nakazuje možno ponavljanje, neobvezno ločilo je lahko določeno,

- {izbira1|izbira2} elementi v ovitih oklepajih so obvezni, možne vrednosti so nakazane z navpično črtico.

### Primer:

           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

## Metode storitev za Python in Basic

Naslednja tipografska pravila mešajo notacijo UML, postavitev dokumentacije API-ja in uporabniški vmesnik inšpektorja predmetov UNO:

- Neobvezne parametre nakazujejo opt, »=« s privzeto vrednostjo ali oglati oklepaji (»[ ]«).

- argumenti so zapisani z malimi črkami, da so skladni s PEP 8 Pythona, medtem ko je za Basic velikost črk nepomembna.

- Argumenti zbirk ali sekvence API-ja so označene z multiplikativnostjo UML. To velja tudi za vrnjene vrednosti.

- Osnovne podatkovne vrste in označbe Pythona se skladenjsko transponirajo na sledeč način:

LibreOffice Basic | Skladnja | Python
--- | --- | ---
Logična vrednost | bool | bool
Date | datetime | datetime
Double | float | float
Integer | int | int
Long | int | int
Object | obj |
Single | float | float
String | str | str
Variant | any |
Predmet UNO | uno |
Uporabniško določena vrsta (UDT) | obj |
Storitev ScriptForge | svc |

### Primer:

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