ScriptForge-biblioteket
ScriptForge-biblioteker byggjer opp ei samling av makroskriptressursar, som kan utvidast, for LibreOffice som skal startast frå grunnleggjande makroar eller Python-skript.
• Grunnleggjande makroar krev innlasting av biblioteket ScriptForge ved hjelp av denne setninga:
GlobalScope.BasicLibraries.loadLibrary("ScriptForge")
• Python-skript krev import frå scriptforge-modulen:
from scriptforge import CreateScriptService
Slå på ScriptForge-tenester
Dei omtalte modulane og klassane vert kalla opp frå brukarskriptet som «tenester». Til dette føremålet er det utforma ein generisk konstruktør for desse tenestene for kvart språk:
Metoden Dispose er tilgjengeleg i alle tenester og bør kallast opp for å frigjera ressursar etter bruk.
GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")
Set oSvc = CreateScriptService("servicename"[, arg0, arg1, ...])
' ...
oSvc.Dispose()
from scriptforge import CreateScriptService
svc = CreateScriptService('servicename'[, arg0, arg1, ...])
# ...
svc.Dispose()
Tenester leverte av biblioteket ScriptForge
Inneheld ei samling metodar for å redigera og transformera matriser med éin dimensjon (vektorar) og matriser med to dimensjonar. Dette inkluderer settoperasjonar, sortering, import frå og eksport til tekstfiler.
Matyriser med meir enn to dimensjonar kan ikkje brukast med metodane i denne tenesta. Einaste unnataket er metoden CountDims, som godtar matriser med kor mange dimensjonar som helst.
Tenesta Base inneheld ei rad metodar og eigenskapar for å forenkla administreringa og hanfsaminga av LibreOffice Base-dokument.
Denne tenesta er nært knytt til tenesta ;Document, som inneheld generiske metodar for handsaming av LibreOffice-dokument, inkludert Base-dokument. Difor utvidar tenesta Base Document-tenesta og inneheld fleire metodar som er spesifikke for Base-dokument, slik at brukarane kan:
-
Få tilgang til databasen innebygd i eit Base-dokument.
-
Opna skjemadokument som er lagra i eit Base-dokument.
-
Kontrollera om eit skjemadokument frå eit Base-dokument er lasta inn.
Tenesta ScriptForge.Basic tilbyr ei samling av LibreOffice Basic-metodar som kan køyrast i ein Python-samanheng. Tenesta Basic sine metodar reproduserer dei innebygde Basic-funksjonane nøyaktig i høve til syntaks og oppførsel.
Det delte biblioteket SFDocuments som gjev mange metodar og eigenskapar som letter administrasjon og handsaming av LibreOffice-dokument.
Tenesta SFDocuments.Calc er ein underklasse av SFDocuments.Document -tenesta. Alle metodar og eigenskapar definerte for tenesta Document kan også nåast ved å bruka ein førekomst av Calc-tenesta.
Tenesta Calc er fokusert på:
-
Handsaming av ark i eit Calc-dokument (kopiera, setja inn, flytta osv.)
-
Dataudveksling mellom Basic data-strukturar og Calc-område
-
Kopiering og import av enorme datamengder
Teenesta Chart (diagram) leverer eit sett eigenskapar og metodar for å handsama diagram i Calc-dokument. Med denne tenesta er det råd å:
-
Få tilgang til diagram-objekt i Calc-dokument og endra eigenskapane deira.
-
Laga og setja inn nye diagram i eit Calc-dokument.
-
Eksportera diagram som biletfiler.
Tenesta Database gjev tilgang til databasar anten innebygde eller omtalte i Base-dokument. Denne tenesta leverer metodar til:
-
Få tilgang til data i databasetabellar
-
Køyr SELECT-spørjingar og utfør SAMANDRAG-funksjonar.
-
Køyr SQL-handlingsuttrykk som INSERT (set inn), UPDATE (oppdater), DELETE (slett) og så vidare.
Database-tenesta er brukt for å representera tabulerte data laga av ein database. Med denne tenesta er det råd å:
-
Navigere gjennom og få tilgang til dataa i eit datasett.
-
Oppdatera, setja inn og sletta postar i datasettet.
Tjenesten Datasheet gjer det mogleg å visualisera innhaldet i databasetabellar og resultata av spørjingar og SQL-setningar ved å bruke datavisinga i Base. I tillegg tillet denne tenesta å:
-
Leggja til eigendefinerte menyar i datavisinga.
-
Få tilgang til verdiar i bestemte posisjonar i datavisinga.
-
Plassera markøren i ei bestemt celle i datavisinga.
Tenesta Dialog bidreg til handsaminga av dialogar oppretta med Basic lDialog Editor eller dialogar som er oppretta direkte. Kvar førekomst av den nåverande klassen representerer éin dialogboks som vert vist for brukaren.
Tenesta DialogControl handsamar dei kontrollelementa som høyrer til eit dialogvindauge som er definert med Dialog Editor i Basic. Kvar førekomst av den gjeldande tenesta representerer eitt kontrollelement i eit dialogvindauge.
Fokus vert sett på å hente verdiane som vert viste av kontrollelementa i dialogvindauget. Formatering er tilgjengeleg via eigenskapane XControlModel og XControlView.
Merk at innhaldet av den unike eigenskapen DialogControl.Value varierer i høve til type kontrollelement.
Kontrollar av typen trekontroll får spesiell merksemd. Det er enkelt å fylla eit tre, anten forgreina etter grein eller med eit sett med greiner samstundes. Utfylling av ein trekontroll kan gjerast statisk eller dynamisk.
Ei ordliste er ei samling av nøkkelelementpar
Biblioteket SFDocuments gjev metodar og eigenskapar for å letta handsaming og manipulering av LibreOffice-dokument.
Metodar som kan brukast på alle typar av dokument (tekstdokument, rekneark, presentasjonar og så vidare) vert leverte av tenesta SFDocuments.Document. Nokre eksempel er:
Tenesta Exception (unnatak) er ei samling av metodar som hjelper til med med feilsøking (debugging) av kode i Basic- og Python-skript og feilhandsaming i Basic-skript.
Når det oppstår ein køyretidsfeil i Basic-skript, hjelper metodane og eigenskapane til Exception-tenesta til å identifisere feilsamanhengen og tillata å handsama han.
Tenesta FileSystem inneheld rutinar for handsaming av filer og mapper. Her kjem nokre eksempel på funksjonane som vert leverte av denne tenesta:
-
Verifiserer om ei fil eller ei mappa finst.
-
Laga og sletta filer og mapper.
-
Starta dialogvindauge for å opna og gøyma filer.
-
Få tilgang til lista over filer i ei mappe osv.
Tenesta Form har metodar og eigenskapar for å administrera skjema i LibreOffice-dokument. Denne tenesta har støtte for skjema i Base-, Calc- og Writer-dokument og tillet:
-
Opna og aktiver skjema.
-
Naviger gjennom postane som vert viste i skjemaet.
-
Få tilgang til kontrollelementa i skjemaet.
-
Få tilgang til underskjema til eit overordna skjema.
Tenesta FormControl gjev tilgang til kontrollane knytte til eit skjema, underskjema eller ein tabellkontroll for eit FormDocument. Kvar førekomst av FormControl-tenesta refererer til eitt enkelt kontrollelement i skjemaet. Denne tenesta tillet brukarane å:
-
Finn og set eigenskapane for kontrollelementet representert av førekomsten FormControl.
-
Få tilgang til den gjeldande verdien vist av kontrollelementet.
-
Set fokus på det ønskte kontrollelementet.
Tenesta FormDocument gjev tilgang til skjemadokument som er lagra i LibreOffice Base-dokument.
I eit Base-dokument kan skjemadokument som finst visast ved å velja i brukargrensesnittet. Kvart skjemadokument kan innehalda eitt eller fleire skjema, inkludert hovudskjemaet og andre delskjema.
Denne tenesta inneheld ei rekkje metodar knytt til omsetjinga av strengar med minimal innverknad på kjeldekodane for programmet. Metodane som er leverte av tenesta L10N kan i hovudsak brukast til å:
Tenesta Meny kan brukast for å laga og fjerna menyar frå menylinja i eit LibreOffice-dokumentvindauge. Kvar menyoppføring kan knytast til eit skript eller til ein UNO-kommando. Denne tenesta gjev desse funksjonane:
-
Oppretting av menyar med eigendefinerte oppføringar, avmerkingsboksar, radioknappar og skiljeteikn.
-
Utstyre menyelement med ikon og infotekstar
Tenesta Platform inneheld ei samling eigenskapar om gjeldande køyringsmiljø og samanheng, for eksempel:
-
Maskinvareplattforma (arkitektur, tal på CPU-ar, maskintype osv.)
-
Informasjon om operativsystemet (OS-type, utgjevnad, versjon osv.)
-
LibreOffice-versjonen
-
Det gjeldande brukarnamnet
Tenesta PopupMenu kan brukast til å laga sprettoppmenyar som kan knyttast til hendingar eller køyrast av skript. Denne tenesta inneheld desse funksjonane:
-
Lagar ein sprettoppmeny med tilpassa innføringar, avkryssingsfelt og radioknappar.
-
Dekorasjon av menyelement med ikon og infotekstar
Tenesta Region tilbyr ei samling eigenskapar og metodar for å handsama lokale og regionrelaterte aspekt ved programmering, for eksempel:
-
Få tilgang til lokale og regionavhengige innstillingar som talformatering, valuta og tidssoner.
-
Konvertera tidssoner og rekna ut forskyvingar av sommartid (DST).
-
Transformera tal til tekst på alle støtta språk.
Hovudføremålet med modulen Services er å gje tilgang til metoden CreateScriptService, som kan kallast opp i brukarskript for å setja opp tenester som vert implementerte med ScriptForge-miljøet.
Tenesta Session samlar ulike generelle metodar:
Tenesta String leverer ei samling av metodar til strenghandsaming. Desse metodane kan brukast til:
-
Kontrollera innhaldet i strengar
-
Formater strengar ved å trimma, justere eller tekstbryte innhaldet
-
Bruk regulære uttrykk til å søkja og erstatta understrengar
-
Bruka hash-algoritmar på strengar og så vidare.
Tenesta TextStream vert brukt til å lesa sekvensielt frå og skriva til filer som er opna eller laga ved hjelp av tenesta ScriptForge.FileSystem.
Metodane OpenTextFile og CreateTextFile frå tenesta FileSystem returnerer ein førekomst av tenesta TextStream.
Tenesta Timer måler kor lang tid det tar å køyra brukarskript.
Ein Timer mæler tidlengd. Det kan vera:
-
Starta for å visa når tidtakinga byrjar.
-
Suspendert for å laga pause i målinga under køyringa.
-
Gjenoppteken for å halda fram mælinga etter at «Timer» vart suspendert.
-
Starta på nytt. Dette vil avbryta tidlegare målingar og starta Timer frå null.
Toolbar-tenesta tillet å henta informasjon relatert til verktøylinja for eit spesifisert dokumentvindauge. Med denne tenesta er det mogleg å:
ToolbarButton-tenesta gjev høve til å få informasjon relatert til verktøylinjeknappane i ei gjeven verktøylinje. Med denne tenesta er det råd å:
T
Tenesta UI (User Interface = brukargrensesnitt) gjer identifikasjonen og handsaminga av dei ulike vindauga som heile LibreOffice-programmet er bygd opp av.
-
Windows selection
-
Flytting og endring av storleiken på vindauga
-
Innstillingar for statuslinja
-
Å visa ei flytande framdriftslinje
-
Laga nye vindauge
-
Tilgang til dei underliggjande «dokumenta»
Tenesta UnitTest gjev eit rammeverk for å automatisere testar av einingar ved å bruka BASIC-språket, inkludert høve til å:
-
Oppsummer testtilfelle i testsuiter og einingstestar.
-
Dela setup- og shutdown-kode mellom test-tilfella.
-
Rapportera testresultata ved hjelp av konsollen.
Det delte biblioteket SFDocuments gjev mange metodar og eigenskapar som letter administrasjon og handsaming av LibreOffice-dokument.
Nokre metodar gjeld for alle typar dokument og er nedarva frå modulen SF_Document, medan andre metodar som er spesifikke for Writer er definerte i modulen SF_Writer.
Merk: Andre ScriptForge-modular som ikkje er omtalte, er reserverte for internt bruk. Innhaldet i desse kan endrast utan varsel.
Alle ScriptForge Basic-rutinane og -identifikatorane som vert innleidde med understrek «_» er reserverte for internt bruk. Dei er ikkje meint brukte i Basic-makroar.
