Tjenesten SFDialogs. Dialog

Tjenesten Dialog bidrager til håndteringen af dialoger, der er oprettet med Basics Dialog-redigering. Hver forekomst af den aktuelle klasse repræsenter et enkelt dialogfelt, der vises for brugeren.

tip

Et dialogfelt kan vises i modal eller ikke-modal tilstand.


I modal tilstand vises feltet og udførelsen af makro-processen er udsat, indtil der trykkes på en af knapperne OK eller Annuller. I mellemtiden kan brugerhandlinger, udført på feltet, udløse bestemte handlinger.

I ikke-modal tilstand "Flyder" dialogfeltet på brugerskrivebordet og udførelsen af makroprocessen fortsætter normalt. En ikke-modal dialog lukker, når den afsluttes med metoden Terminate() eller når sessionen LibreOffice Slutter. Knappen Luk vindue er inaktiv i ikke-modale dialoger.

Et dialogfelt forsvinger fra hukommelsen efter dets udtrykkelige afslfutning.

tip

Tjenesten SFDialogs.Dialog er nært beslægtet med tjenesten SFDialogs.DialogControl.


Kald og brug af tjeneste

Før brug af tjenesten Dialog skal biblioteket ScriptForge være indlæst eller importeret:

note

• 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


Tjenesten Dialog kaldes med metoden CreateScriptService. Den kræver tre positions-argumenter til at angive dialogfeltet, der skal aktiveres:

Container: "GlobalScope" til forudinstallerede biblioteker eller et vinduesnavn som defineret af tjenesten ScriptForge.UI. Standardværdien tom streng "" står for det aktuelle dokument.

Bibliotek: Biblioteksnavn med skelnen mellem Store og små bogstaver, der findes i containeren. Standardværdien er "Standard".

DialogNavn: En streng, hvor der skelnes mellem Store og smĂĄ bogstaver, og som betegner dialogen.

PRODUCTNAME Basic- og Python-eksemplerne herunder viser dialogen dlgConsole, der tilhører det delte bibliotek ScriptForge:


      Dim oDlg As Object, lButton As Long
      Dim Container As String, Library As String, DialogName As String
      Set oDlg = CreateScriptService("SFDialogs.Dialog", "GlobalScope", "ScriptForge", "dlgConsole")
      '... initialisering af kontrolelementer skrives her...
      lButton = oDlg.Execute()
      'Standard tilstand = Modal
      If lButton = oDlg.OKBUTTON Then
      '... Proceskontrollerer og gør, hvad der er nødvendigt her
      End If
      oDlg.Terminate()
  

Eller med Python:


    dlg = CreateScriptService('SFDialogs.Dialog', 'GlobalScope', 'ScriptForge', 'dlgConsole')
    # ... initialisering af kontroller skrives her...
    rc = dlg.Execute()
    # Standard-tilstand er Modal
    if rc == dlg.OKBUTTON:
        # ... Behandl kontroller og gør, hvad der er nødvendigt her
    dlg.Terminate()
  

Alternativt kan en forekomst af Dialog hentes via tjenesten SFDialogs.DialogEvent, forudsat at dialogen blevinitieret med tjenesten Dialog. DialogEvent returnerer den forekomst af tjenesten SFDialogs.Dialog, der udløste hændelsen.


    Sub SomeEvent(ByRef poEvent As Object)
        Dim oDlg As Object
        Set oDlg = CreateScriptService("SFDialogs.DialogEvent", poEvent)
    End Sub
  

med Python:


    def some_event(event: uno):
        dlg = CreateScriptService("SFDialogs.DialogEvent", event)
  

Bemærk, at i de tidligere eksempler kan præfikset "SFDialogs." udelades, når det skønnes passende.

Egenskaber

Navn

Skrivebeskyttet

Type

Beskrivelse

OKBUTTON

Ja

Integer

Værdi = 1. Der blev trykket på en OK-knap.

CANCELBUTTON

Ja

Integer

Værdi = 1. Der blev trykket på en OK-knap.

Caption

Nej

String

Angiv dialogens titel.

Height

Nej

Long

Angiv højden på dialogfeltet.

Modal

Ja

Boolean

Angiver, om dialogfeltet aktuelt er i udførelse i modal tilstand.

Name

Ja

String

Dialogens navn

Page

Nej

Integer

En dialog kan have flere sider, som brugeren kan gĂĄ igennem trin for trin. Dialogobjektets sideegenskab definerer, hvilken af dialogens sider, der er aktiv.

Visible

Nej

Boolean

Angiv, om dialogfeltet er synligt på skrivebordet. Som standard er det ikke synligt, før metoden Execute() køres og synligt derefter.

XDialogModel

Ja

UNO
object

Det UNO-objekt, der repræsenter dialogenmodellen. Se detaljeret information i XControlModel og UnoControlDialogModel i APIens (Application Programming Interface) dokumentation.

XDialogView

Ja

UNO
object

Det UNO-objekt, der repræsenter dialogvisningen. Se detaljeret information i XControl og UnoControlDialog i APIens (Application Programming Interface) dokumentation.

Width

Nej

Long

Angiv dialogfeltets bredde.


Hændelsesegenskaber

Returns a URI string with the reference to the script triggered by the event. Read its specification in the scripting framework URI specification.

Navn

Skrivebeskyttet

Beskrivelse af Basic IDE

OnFocusGained

Ja

NĂĄr fokus modtages

OnFocusLost

Ja

NĂĄr fokus mistes

OnKeyPressed

Ja

Tast trykket

OnKeyReleased

Ja

Tast sluppet

OnMouseDragged

Ja

Mus flyttet mens tast trykkes

OnMouseEntered

Ja

Mus indenfor

OnMouseExited

Ja

Mus udenfor

OnMouseMoved

Ja

Mus flyttet

OnMousePressed

Ja

Museknap trykket

OnMouseReleased

Ja

Museknap sluttet


Metoder

Activate
Center
Controls

EndExecute
Execute
GetTextsFromL10N

Resize
Terminate


Activate

Sæt fokus på den aktuelle forekomst af Dialog. Returner True, hvis fokuseringen lykkedes.

Den metode kaldes fra en dialog, en kontrolhændelse eller når der vises en dialog i ikke-modal tilstand.

Syntaks:

svc.Activate(): bool

Eksempel:


      Dim oDlg As Object
      Set oDlg = CreateScriptService(,, "myDialog")
      oDlg.Execute()
      ' ...
      oDlg.Activate()
   

BĂĄde Python- og LibreOffice-Basic-eksempler antager, at dialogen er gemt i det aktuelle dokuments Standard-bibliotek.


     dlg = CreateScriptService(,,'myDialog')
     dlg.Execute()
     # ...
     dlg.Activate()
   

Center

Centrerer den aktuelle forekomst af dialogen midt pĂĄ det ordnede vindue. Uden argumenter centrerer metoden dialogen i midten af det aktuelle vindue.

Returnerer True (Sand), nĂĄr den lykkes.

Syntaks:

svc.Center(opt Parent: obj): bool

Parametre:

Overordnet: Et valgfrit objekt kan være enten…

Eksempel:

I Basic

     Sub TriggerEvent(oEvent As Object)
         Dim oDialog1 As Object, oDialog2 As Object, lExec As Long
         Set oDialog1 = CreateScriptService("DialogEvent", oEvent) ' Dialogen, der udløste hændelsen
         Set oDialog2 = CreateScriptService("Dialog", ...) ' Ă…bn en anden dialog
         oDialog2.Center(oDialog1)
         lExec = oDialog2.Execute()
         Select Case lExec
             ...
     End Sub
  
I Python

     def triggerEvent(event: uno):
       dlg1 = CreateScriptService('DialogEvent.Dialog', event)  # Dialogen, der har udløst hændelsen
       dlg2 = CreateScriptService('Dialog', ...)  # Ă…bn en anden dialog
       dlg2.Center(dlg1)
       rc = dlg2.Execute()
       if rc is False:
         # ...
   

Controls

Returner enten:

Syntaks:

svc.Controls(): str[0..*]

svc.Controls(controlname: str): svc

Parametre:

KontrolNavn: Et gyldigt kontrolnavn som en streng, der skelner mellem Store og smĂĄ bogstaver. Hvis den mangler, returneres listen over kontrolnavne som en nul-baseret matrix.

Eksempel:


      Dim myDialog As Object, myList As Variant, myControl As Object
      Set myDialog = CreateScriptService("SFDialogs.Dialog", , "Standard", "Dialog1")
      myList = myDialog.Controls()
      Set myControl = myDialog.Controls("myTextBox")
   

     dlg = CreateScriptService('SFDialogs.Dialog','', 'Standard', 'Dialog1')
     ctrls = dlg.Controls()
     ctrl = dlg.Controls('myTextBox')
   

EndExecute

Afslutter visningen af en modal dialog og giver argumentet tilbage som den aktuelle Execute() løbende handlings returværdi.

EndExecute() opbevares sædvanligvis i behandlingen af en makro, der udløstes af en dialog eller en kontrolhændelse.

Syntaks:

svc.EndExecute(returnvalue: int)

Parametre:

returværdi: Den værdi, der videregives til den kørende Execute()-metode.

Eksempel:

Med LibreOffice-Basic:


      Sub OnEvent(poEvent As com.sun.star.lang.EventObject)
          Dim oDlg As Object
          Set oDlg = CreateScriptService("SFDialogs.DialogEvent", poEvent)
          oDlg.EndExecute(ReturnValue := 25)
      End Sub
   

Med Python:


     from com.sun.star.lang import EventObject
     def on_event(event: EventObject):
         dlg = CreateScriptService("SFDialogs.DialogEvent", event)
         dlg.EndExecute(25)
   
tip

Ovennævnte omtaler af com.sun.star.lang.EventObject er valgfrie. Disse anmærkninger hjælper med at identificere LibreOffice Application Programming Interface (API).


Execute

Viser dialogfeltet og venter, når modal, på den afslutning af brugeren. Den returnerede værdi er enten:

Ved ikke-modale dialogfelter returnerer metoden altid 0 og udførelsen af makroen fortsætter.

Syntaks:

svc.Execute(modal: bool = True): int

Parametre:

modal: False (falsk) ved en ikke-modal dialog. Standard = True (sand).

Eksempel:

I dette Basic-eksempel er dialogen myDialog gemt i det aktuelle dokuments Standard-bibliotek.


      Dim oDlg As Object, lReturn As Long
      Set oDlg = CreateScriptService("SFDialogs.Dialog", , , "myDialog")
      lReturn = oDlg.Execute(Modal := False)
      Select Case lReturn
          ' ...
      End Select
   

Denne Python-kode viser den modale dialog DlgConvert i det delte Basic-bibliotek DlgConvert.


     dlg = CreateScriptService("SFDialogs.Dialog", 'GlobalScope', 'Euro', "DlgConvert")
     rc = dlg.Execute()
     if rc == dlg.CANCELBUTTON:
         # ...
   

GetTextsFromL10N

Erstatter alle faste tekststrenge i en dialog med deres oversatte versioner baseret på en forekomst af tjenesten L10N . Denne metode oversætter følgende strenge:

Metoden returnerer True (sand), hvis den lykkes.

For at oprette en liste over strenge, der kan oversættes i en dialog, bruger du metoden AddTextsFromDialog fra tjenesten L10N.

Syntaks:

svc.GetTextsFromL10N(l10n: svc): bool

Parametre:

l10n: En forekomst af tjenesten L10N, som de oversatte strenge hentes fra.

Eksempel:

Det følgende eksempel indlæser oversatte strenge og anvender dem på dialogen "Min dialog".

I Basic

     oDlg = CreateScriptService("Dialog", "GlobalScope", "Standard", "MyDialog")
     myPO = CreateScriptService("L10N", "/home/user/po_files/")
     oDlg.GetTextsFromL10N(myPO)
     oDlg.Execute()
   
I Python

     dlg = CreateScriptService("Dialog", "GlobalScope", "Standard", "MyDialog")
     myPO = CreateScriptService("L10N", "/home/user/po_files/")
     dlg.GetTextsFromL10N(myPO)
     dlg.Execute()
   
tip

Læs hjælpesiden tjenesten L10N for at få mere at vide om, hvordan PO- og POT-filer håndteres.


Resize

Flytter det øverste venstre hjørne af en dialog til nye koordinater og/eller ændrer dets dimensioner. Alle afstanden udtrykkes i 1/100 mm. Uden argumenter nulstiller metoden de oprindelige dimensioner. Returnerer True (Sand), hvis ændringen af størrelse lykkedes.

Syntaks:

svc.Resize(opt Left: num, opt Top: num, opt Width: num, opt Height: num): bool

Parametre:

Venstre: den vandrette afstand fra det øverste, venstre hjørne

Top: den lodrette afstand fra det øverste, venstre hjørne

Bredde: bredden pĂĄ den rektangel, der indeholder dialogen

Hæjde: højden på det rektangel, der indeholder dialogen

Negative eller manglende argumenter efterlades uændrede

Eksempel:

I Basic

     oDialog.Resize(1000, 2000, Height := 6000) ' Bredden ændres ikke
   
I Python

Med Python:


     oDialog.Resize(1000, 2000, Height = 6000)  # Bredden ændres ikke
   

Terminate

Afslut tjenesten Dialog i den aktuelle forekomst. Returner True (sand), hvis afslutningen lykkedes.

Syntaks:

svc.Terminate(): bool

Eksempel:

Basic- og Python-eksemplerne herunder åbner de ikke modale dialoger DlgConsole og dlgTrace. De gemmes henholdsvis i de delte biblioteker ScriptForge og Access2Base. Luk dialog-knapperne er deaktiveret og der udføres udtrykkelig afslutning i slutningen af en kørselsproces.

I dette eksempel erstatter en knap i DlgConsole hæmmet lukning af vinduet:

I Basic

     oDlg = CreateScriptService("SFDialogs.Dialog","GlobalScope","ScriptForge","DlgConsole")
     oDlg.Execute(modal:=False)
     Wait 5000
     oDlg.Terminate()
   

Med Python:

I Python

     from time import sleep
     dlg = CreateScriptService('SFDialogs.Dialog',"GlobalScope",'Access2Base',"dlgTrace")
     dlg.Execute(modal=False)
     sleep 5
     dlg.Terminate()
   
warning

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.


Støt os venligst!