Knjižnica ScriptForge
Odprite in nato izberite vsebnik .
Knjižnica ScriptForge je tvorijo razširljivo zbirko virov za skripte makrov za LibreOffice, ki jih prikličete iz makrov BASIC ali skriptov Python.
• Basic macros require to load ScriptForge library using the following statement:
GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")
• Python scripts require an import from scriptforge module:
from scriptforge import CreateScriptService
Opisani moduli in razredi se iz uporabniških skriptov kličejo kot storitve (Service). Za ta namen je izdelan generični konstruktor teh storitev za vsak jezik:
GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")
Set oSvc = CreateScriptService("servicename"[, arg0, arg1, ...])
from scriptforge import CreateScriptService
svc = CreateScriptService('servicename'[, arg0, arg1, ...])
Knjižnica ScriptForge Basic je na voljo od LibreOffice 7.1 naprej.
Modul Python scriptforge je na voljo od LibreOffice 7.2 naprej.
Storitve, ki jih zagotavlja knjižnica ScriptForge
Ponuja zbirko metod za ravnanje z in preoblikovanje enodimenzionalnih polj (vektorjev) in dvodimenzionalnih polj (matrik). To vključuje operacije nad množicami, razvrščanje ter uvažanje in izvažanje besedilnih datotek.
Polj z več kot dvema dimenzijama ni možno uporabljati z metodami te storitve, edina izjema je metoda CountDims, ki sprejema polja poljubnih dimenzij.
Storitev Base ponuja številne metode in lastnosti, ki lajšajo upravljanje in ravnanje z dokumenti LibreOffice Base.
Ta storitev je tesno povezana s storitvijo Document, ki ponuja splošne metode za ravnanje z dokumenti LibreOffice, vključno z dokumenti programa Base. Zatorej storitev Base razširja storitev Document in ponuja dodatne metode, ki so specifične za dokumente programa Base, saj uporabnikom omogoča:
-
pridobivanje dostopa do zbirke podatkov, vsebovane v dokumentu programa Base;
-
odpiranje dokumentov obrazcev, shranjenih v dokumentu programa Base;
-
preverjanje, če je dokument obrazca iz dokumenta programa Base trenutno naložen.
Ta storitev je na voljo od LibreOffice 7.2 naprej.
Storitev ScriptForge.Basic ponuja zbirko metod LibreOffice Basic, ki jih je moč izvajati v kontekstu Pythona. Metode storitve Basic imajo isto skladnjo in vedenje kot vgrajene funkcije Basica.
Ta storitev je na voljo od LibreOffice 7.2 naprej.
Knjižnica SFDocuments vsebuje metode in lastnosti, ki pomagajo pri upravljanju in ravnanju z dokumenti LibreOffice Calc.
Nekatere metode so generične za vse vrste dokumentov in se dedujejo iz storitve Document, medtem ko so druge metode specifične za modul SF_Calc.
Modul SF_Calc se osredotoča na:
-
ravnanje z delovnimi listi v dokumentu Calc (kopiraj, vstavi, premakni itn.);
-
izmenjavo podatkov med podatkovnimi strukturami Basica in obsegi programa Calc;
-
kopiranje in uvažanje ogromnih količin podatkov.
Storitev Database zagotavlja dostop do zbirk podatkov, ki so vdelane ali opisane v dokumentih Base. Ta storitev zagotavlja metode za:
-
pridobivanje dostopa do podatkov v tabelah zbirke podatkov;
-
zagon povpraševanj SELECT in izvajanje sestavljenih funkcij;
-
izvajanje ukazov dejanj SQL , kot so INSERT, UPDATE, DELETE itn.
Storitev Dialog prispeva upravljanju pogovornih oken, ustvarjenih z Basicovim Urejevalnikom pogovornih oken. Vsaka instanca trenutnega razreda predstavlja posamezno pogovorno okno, prikazano uporabniku.
Storitev DialogControl upravlja s kontrolniki, ki pripadajo pogovornemu oknu, določenemu z Urejevalnikom pogovornih oken Basica. Vsaka instanca trenutne storitve predstavlja posamezen kontrolnik v pogovornem oknu.
Pozornost je nastavljena na pridobivanje in določanje vrednosti, prikazanih na kontrolnikih pogovornega okna. Oblikovanje je dostopno prek lastnosti XControlModel in XControlView.
Upoštevajte, da so enkratne vsebine lastnosti DialogControl.Value razlikujejo glede na vrsto kontrolnika.
Posebna pozornost velja za drevesne kontrolnike. Drevo je enostavno napolniti: vejo po vejo ali pa z množico vej naenkrat. Napolnjevanje drevesnega kontrolnika se lahko izvede statično ali dinamično.
Slovar je zbirka parov ključ-element
Ključ je niz, pri katerem razlike med velikimi in malimi črkami ne štejejo
Elementi so lahko poljubne vrste
Knjižnica SFDocuments vsebuje metode in lastnosti, ki lajšajo upravljanje in ravnanje z dokumenti LibreOffice.
Metode, ki veljajo za vse vrste dokumentov (besedilne dokumente, preglednice, predstavitve itn.) so vključene v storitev SFDocuments.Document. Nekaj primerov:
-
Odpiranje, zapiranje in shranjevanje dokumentov
-
Dostop do standardnih lastnosti ali lastnosti po meri dokumentov
Storitev Exception je nabor metod za razhroščevanje kode skriptov Basic in Python ter za ravnanje ob napakah v skriptih Basic.
V primeru napake v skriptih Basic ob izvajanju lastnosti in metode storitve Exception pomagajo identificirati kontekst napake in omogočajo ravnanje z njo.
Storitev FileSystem vključuje metode za ravnanje z datotekami in mapami. Sledi nekaj primerov funkcionalnosti, ki jih zagotavlja ta storitev:
-
preverjanje, ali datoteka oz. mapa obstaja.
-
ustvarjanje in brisanje map in datotek;
-
odpiranje pogovornih oken za odpiranje/shranjevanje datotek;
-
dostop do seznama datotek v mapi itn.
Storitev Form ponuja metode in lastnosti za upravljanje z obrazci v dokumentih LibreOffice. Storitev podpira obrazce v dokumentih programov Base, Calc in Writer ter omogoča, da:
-
odprete in aktivirate obrazce;
-
krmarite po zapisih, ki jih prikazuje obrazec;
-
pridobite dostop do kontrolnikov v obrazcu;
-
pridobite dostop do podobrazcev nadrejenega obrazca.
Storitev FormControl omogoča dostop do kontrolnikov, ki pripadajo obrazcu, podobrazcu ali kontrolniku tabele FormDocument. Vsaka instanca storitve FormControl se nanaša na posamezen kontrolnik v obrazcu. Ta storitev omogoča uporabnikom:
-
pridobiti in določiti lastnosti kontrolnika, ki ga predstavlja instanca FormControl;
-
dostopati do trenutne vrednosti, ki jo prikazuje kontrolnik;
-
določiti pozornost na želeni kontrolnik.
Ta storitev zagotavlja številne metode, ki se nanašajo na prevod nizov z minimalnim vplivom na izvorno kodo programa. Metode, ki jih zagotavlja storitev L10N, lahko predvsem uporabite za:
-
ustvarjanje datotek POT, ki jih je mogoče uporabiti kot predloge za prevod vseh nizov v programu;
-
pridobivanje prevedenih nizov v času izvajanja za jezik, definiran z lastnostjo Locale.
Storitev Platform ponuja zbirko lastnosti o trenutnem izvajalnem okolju in kontekstu, kot so:
-
strojna platforma (arhitektura, število CPE, vrsta računalnika itn.),
-
podatki o operacijskem sistemu (vrsta OS, izdaja, različica itn.),
-
različica LibreOffice,
-
ime trenutnega uporabnika
Knjižnica ScriptForge je zgrajena nad razširljivo zbirko t.i. storitev, "Services".
Ta zbirka je implementirana kot kategorije knjižnic Basic ali modulov Python:
-
standardna knjižnica ScriptForge, ki je del paketa LibreOffice;
-
številne "povezane" knjižnice, ki so tudi del paketa LibreOffice;
-
poljubna uporabniška razširitev LibreOffice, ki želi ustrezati istemu ogrodju.
Storitev Session obsega različne splošne metode glede:
-
okolja nameščanja ali izvajanja,
-
vpogleda v delovanje UNO in
-
priklica zunanjih skriptov ali programov.
Storitev String ponuja zbirko metod za obdelavo nizov. S temi metodami lahko:
-
potrdite veljavnost vsebine niza;
-
oblikujete nize z obrezovanjem, poravnavanjem ali oblivanjem njihove vsebine;
-
uporabite regularne izraze za iskanje in zamenjevanje podnizov;
-
izvedete algoritme zgoščevalne funkcije nad nizi itn.
Storitev TextStream se uporablja za zaporedno branje in pisanje v datoteke, odprte ali ustvarjene s storitvijo ScriptForge.FileSystem.
Metodi OpenTextFile in CreateTextFile iz storitve FileSystem vrneta instanco storitve TextStream.
Storitev Timer meri pretečeni čas ob izvajanju uporabniških skriptov.
Timer meri trajanje. Lahko je:
-
zagnan, kar nakazuje, da meri čas delovanja;
-
začasno zaustavljen, t.j. začasno ne meri časa delovanja;
-
v nadaljevanju, da nadaljuje z merjenjem časa delovanja, potem ko je bil začasno zaustavljen;
-
ponovno zagnan, kar prekliče prejšnje meritve in zažene časovnik Timer z ničelno vrednostjo.
Storitev UI (User Interface, angl. za uporabniški vmesnik) poenostavlja identifikacijo in ravnanje z različnimi okni, ki tvorijo celoten program LibreOffice:
-
izbiranje oken;
-
premikanje in spreminjanje oken;
-
nastavitve vrstice stanja;
-
prikaz plavajoče vrstice napredka;
-
ustvarjanje novih oken;
-
Dostop do osnovnih "dokumentov"
Opomba: drugi, neopisani moduli ScriptForge so rezervirani za interno uporabo. Njihova vsebina se lahko spremeni brez opozorila.
Vsi podprogrami ali identifikatorji ScriptForge Basic s predpono podčrtaja (»_«) so rezervirani za interno uporabo. Uporabi v makrih Basic niso namenjeni.
