Biblioteket ScriptForge
Åbn og vælg containeren .
Bibliotekerne i ScriptForge opbygger en samling af makroscript-ressourcer, der kan udvides, til brug i LibreOffice, der skal kaldes fra Basic-makroer eller Python-scripts.
• Basic-makroer kræver, at biblioteket ScriptForge indlæses med følgende udtryk:
GlobalScope.BasicLibraries.loadLibrary("ScriptForge")
• Python-scripts kræver import af scriptforge-modulet:
from scriptforge import CreateScriptService
Kald af ScriptForge-tjenester
De beskrevne moduler og klasser kaldes fra brugerscripts som "Tjenester". Der er designet en generisk konstruktor af disse tjenester til det formål for hvert enkelt sprog.
Metoden Dispose (Bortskaf) er tilgængelig i alle tjenester og bør kaldes for at frigøre ressourcer efter brugen:
GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")
Set oSvc = CreateScriptService("servicename"[, arg0, arg1, ...])
' ...
oSvc.Dispose()
from scriptforge import CreateScriptService
svc = CreateScriptService('servicename'[, arg0, arg1, ...])
# ...
svc.Dispose()
Tjenester leveret af biblioteket ScriptForge
Giver en samling metoder til at manipulere og transformere en-dimensions matrixer (vektorer) og to-dimensions matrixer (matrixer). Dette omfatter sæt-operationer, sortering, import fra og eksport til tekstfiler.
Matrixer med mere end to dimensioner kan ikke bruges med metoderne i denne tjeneste; den eneste udtagelse er metoden CountDims, der accepterer matrixer med et vilkårligt antal dimensioner.
Tjenesten Base giver et antal metoder og egenskaber, der letter administration og håndtering af LibreOffice Base-dokumenter.
Denne tjeneste er nært relateret til tjenesten Document, som giver generiske metoder til at håndtere LibreOffice-dokumenter, herunder Base-dokumenter. Derfor udvider tjenesten Base tjenesten Document og giver yderligere metoder, der er specifikke for Base-dokumenter og lader brugerne:
-
Få adgang til databasen, der er indeholdt i et Base-dokument.
-
Åbne formular-dokumenter, der er gemt i et Base-dokument.
-
Tjekke om et formulardokument fra et Base-dokument aktuelt er indlæst.
Tjenesten ScriptForge.Basic tilbyder en samling af LibreOffice Basic-metoder til kørsel i en Python-kontekst. Tjenesten Basics metoder reproducerer de indbyggede Basic-funktioners præcise syntaks og adfærd.
Det delte bibliotek SFDocuments giver et antal metoder og egenskaber til at facilitere adminstrationen og håndteringen af LibreOffice-dokumenter.
Tjenesten SFDocuments.Calc er en delmængde af tjenesten SFDocuments.Document. Alle metoder og egenskaber, der er defineret til tjenesten Document (dokument) kan også tilgås med tjenesteforekomsten Calc.
Tjenesten Calc er fokuseret på:
-
Håndteringsark i et Calc dokument (kopier, indsæt, flyt osv.)
-
Dataudveksling mellem Basic data-strukturer og Calc-områder
-
Kopiering og import af enorme datamængder amounts of data
Tjenesten Chart (diagram) leverer et sæt egenskaber og metoder til at håndtere diagrammer i Calc-dokumenter. Med denne tjeneste er det muligt at:
-
Tilgå diagram-objekter i Calc-dokumenter og manipuler deres egenskaber.
-
Opret og indsæt nye diagrammer i et Calc-dokument.
-
Eksportere diagrammer som billedfiler.
Tjenesten Database giver adgang til databaser enten indlejrede eller beskrevet i Base-dokumenter. Denne tjeneste leverer metoder til:
-
Få adgang til data i databasetabeller
-
Kør SELECT (udvælg) forespørgsler og foretag AGGREGER-funktioner.
-
Kør SQL-handlingsudtryk såsom INSERT (indsæt), UPDATE (opdater), DELETE (slet) og så videre.
The Dataset service is used to represent tabular data produced by a database. With this service it is possible to:
The Datasheet service allows to visualize the contents of database tables as well as the results of queries and SQL statements using Base's Data View. Additionally, this service allows to:
-
Add custom menus to the data view.
-
Access values in specific positions of the data view.
-
Position the cursor in a specific cell of the data view.
The Dialog service contributes to the management of dialogs created with the Basic Dialog Editor or dialogs created on-the-fly. Each instance of the current class represents a single dialog box displayed to the user.
Tjenesten DialogControl håndterer de kontroller, der hører til en dialog, der er defineret med Basics Dialogredigering. Hver forekomst af den aktuelle tjeneste repræsenterer en enkelt kontrol indenfor et dialog felt.
Fokus sættes på at hente og sætte de værdier, der vises af dialogfeltets kontroller. Formatering er tilgængelig via egenskaberne XControlModel and XControlView.
Bemærk, at indholdet af den unikke egenskab DialogControl.Value (dialogkontrol.værdi) varierer efter kontroltypen.
Kontrolelementer ordnet i en træstruktur får særlig opmærksomhed. Det er let at fylde et træ med værdier, enten gren for gren eller med flere grene på én gang. Indsættelse af værdier i et "kontroltræ" kan gøres statisk eller dynamisk.
En ordbog er samling af nøgle-element-par
Nøglen er en streng, der ikke skelner mellem Store og små bogstaver
Elementer kan være af enhver type
The SFDocuments library provides methods and properties to facilitate the management and manipulation of LibreOffice documents.
Metoder, der kan anvendes på alle typer af dokumenter (tekstdokumenter, regneark, præsentationer og så videre) leveres af tjenesten SFDocuments.Document. Nogle eksempler er:
-
Åbning, lukning og lagring af dokumenter
-
Adgang til dokumenters standard- eller tilpassede egenskaber
Tjenesten Exception (undtagelse) er en samling af metoder, der hjælper med at debugge koder i Basic- og Python-sceripts og med håndtering af fejl i Basic-scripts.
I Basic-scripts hjælper tjenesten Exception (undtagelse) metoderne og egenskaberne med at identificere fejlens sammenhæng og tillader håndtering af den, når der forekommer en kørselsfejl.
Tjenesten FileSystem omfatter rutiner til håndtering af filer og mapper. Herefter er der nogle eksempler på funktionaliteter leveret af denne tjeneste:
-
Verificer, om en fil eller en mappe eksisterer.
-
Opret og slet mapper og filer.
-
Start dialoger, der skal åbne/gemme filer.
-
Tilgå listen over filer i en mappe og så videre.
Tjenesten Form giver metoder og egenskaber til administration af formularer i LibreOffice-dokumenter. Denne tjeneste understøtter formularer i Base-, Calc- og Writer-dokumenter og tillader:
-
Åbn og aktiver formularer.
-
Naviger gennem posterne, der vises i formularen.
-
Få adgang til kontrollerne i formularen.
-
Få adgang til til en ophavsformulars afkomsformularer.
Tjenesten FormControl (formularkontrol) giver adgang til de kontroller, der tilhører en formular, en underformular eller en tabel-kontrol i et FormDocument (formulardokument). Hver forekomst af tjenesten FormControl henviser til en enkelt kontrol i formularen. Denne tjeneste lader brugerne:
-
Find og sæt kontrollens egenskaber repræsenteret af forekomsten af FormControl (formularkontrol).
-
Tilgå den aktuelle værdi, der vises af kontrollen.
-
Sæt fokus på den ønskede kontrol.
The FormDocument service allows to access form documents stored in LibreOffice Base documents.
In a Base document, existing form documents can be viewed by selecting in the user interface. Each form document may be composed of one or more forms, including the main form and other sub-forms.
Denne tjeneste leverer et antal metoder i forbindelse med oversættelse af strenge med minimal indvirkning på programmets kildekode. Metoderne, der er leveret af tjenesten L10N kan hovedsagelig bruges til:
-
Opret POT-filer, der kan bruges som skabeloner til oversættelse af alle strenge i programmet.
-
Få oversatte strenge under kørslen til det sprog, der er defineret i egenskaben Locale.
Tjenesten Menu kan bruges til at oprette og fjerne menuer fra menulinjen i et LibreOffice dokumentvindue. Hvert menupunkt kan tilknyttes til et script eller til en UNO-kommando. Tjenesten giver disse muligheder:
-
Oprettelse af menuer med tilpassede elementer, afkrydsningsfelter, alternativknapper og skilletegn.
-
Udstyrelse af menuelementer med ikoner og værktøjstips.
Tjenesten Platform giver en samling af egenskaber vedrørerende det aktuelle kørselsmiljø og kontekst, såsom:
-
Den fysiske platform (arkitektur, CPU antal, maskintype og så videre)
-
Information og operativsystem (type af operativsystem, udgivelse, version og så videre)
-
LibreOffice version
-
Det aktuelle brugernavn
Tjenesten PopupMenu kan bruges til at oprette popup-menuer, der kan knyttes til hændelser eller udføres af scripts. Denne tjeneste giver disse muligheder:
-
Oprettelse af popup-menuer med tilpassede, afkrydsningsfelter og alternativknapper.
-
Udsmykning af menuelementer med ikoner og værktøjstips.
The Region service provides a collection of properties and methods to handle locale and region-related aspects of programming, such as:
-
Accessing locale and region-dependent settings such as number formatting, currency and timezones.
-
Converting timezones and calculate Daylight Saving Time (DST) offsets.
-
Transforming numbers into text in any supported language.
Hovedformålet med modulet Services (tjeneste) er at give adgang til metoden CreateScriptService (opret_script-tjeneste), som kan kaldes i brugerscripts til at instantiere tjenester, der implementeres med ScriptForge-miljøet.
Tjenesten Session samler forskellige generelle metoder:
Tjenesten String (streng) leverer en samling af metoder til streng-behandling. Disse metoder kan bruges til:
-
Validere strengenes indhold
-
Formatere strenge ved at trimme, justere eller ombryde deres indhold.
-
Bruge regulære udtryk til at søge og erstatte understrenge
-
Anvende hash-algoritmer på strenge og så videre.
Tjenesten TextStream bruges til fortløbende at læse og skrive i de filer, der er åbnet eller oprettet med tjenesten ScriptForge.FileSystem.
Metoderne OpenTextFile (åbn tekstfil) og CreateTextFile (opret tekstfil) fra tjenesten FileSystem (filsystem) returnerer en forekomst af tjenesten TextStream (tekst-strøm).
Tjenesten Timer (stopur) måler den tid, det tager at køre brugerscripts.
En Timer Måler varigheder. Det kan være:
-
Startet, for at vise, hvornår tidstagningen starter.
-
Udsat, pause i målingen af den løbende tid.
-
Genoptaget, for at fortsætte målingen af den løbende tid, efter at timeren har været stoppet.
-
Genstartet, hvilket vil annullere de tidligere målinger starter Timeren fra nul.
The Toolbar service allows to retrieve information related to the toolbars available for a specific document window. With this service it is possible to:
The ToolbarButton service allows to retrieve information related to the toolbar buttons available in a given toolbar. With this service it is possible to:
Tjenesten UI (User Interface = brugerflade) forenkler identifikationen og håndteringen af de forskellige vinduer, der udgør hele LibreOffice-programet.
-
Windows selection (vinduesudvælgelse)
-
Flytning og størrelsesændring af vinduer
-
Statuslinjens indstillinger
-
Visning af en flydende fremdriftslinje
-
Oprettelse af nye vinduer
-
Adgang til de underliggende "dokumenter"
The UnitTest service provides a framework for automating unit tests using the Basic language, including the ability to:
-
Aggregate test cases into test suites and unit tests.
-
Share setup and shutdown code among test cases.
-
Report test results using the Console.
Det delte bibliotek SFDocuments giver et antal metoder og egenskaber til at lette administration og håndtering af LibreOffice-dokumenter.
Nogle metoder et almindelige for alle dokumenttyper og er nedarvede fra modulet SF_Document, mens andre metoder, der er specifikke for Writer-dokumenter er defineret i modulet SF_Writer.
OBS: Andre ScriptForge ikke-beskrevne moduler er reserveret til internt brug. Deres indhold kan ændres uden varsel.
Alle ScriptForge Basic-rutiner eller identifikatorer, der er indledet med et understreget tegn "_" er reserveret til internt brug. Det er ikke meningen, at de skal bruges i Basic-makroer eller Python-scripts.
