Tenesta SFDialogs.Dialog

Tenesta Dialog bidreg til handsaminga av dialogar oppretta med Basic lDialog Editor. Kvar fÞrekomst av den nÄverande klassen representerer éin dialogboks som vert vist for brukaren.

tip

Ein dialogboks kan visast i modal eller ikkje-modal modus.


I modal modus vert boksen vist og utfÞringa av makroprosessen vert utsett til ein av OK- eller Avbryt -knappane vert trykt pÄ. I mellomtida kan brukarhandlingar utfÞrt pÄ boksen lÞysa ut spesifikke handlingar.

I ikkje-modal modus er dialogvindauget «flytande» pÄ brukarskrivebordet, og kÞyringa av makroprosessen held fram som normalt. Eit ikkje-modalt dialogvindauge vert lukka nÄr den vert avslutta med Terminate()-metoden eller nÄr LibreOffice-Þkta vert avslutta. Lukkeknappen for vindauget er inaktiv i ikkje-modale dialogvindauge.

Eit dialogvindauge forsvinn frÄ minnet etter eksplisitt avslutning.

tip

Tenesta SFDialogs.Dialog er i nĂŠrt slektskap med tenesta SFDialogs.DialogControl.


Oppkall og bruk av tenester

FÞr du brukar Dialog-tenesta, mÄ ScriptForge-biblioteket lastast inn eller importerast:

note

‱ 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


Tenesta Dialog vert kalla opp med metoden CreateScriptService. Ho krev tre posisjons-argument for Ă„ opna dialogvindauget.

Container: "GlobalScope" for fÞrehandsinstallerte bibliotek eller eit vindaugenamn som er definert av tenesta ScriptForge.UI. Standardverdien tom streng "" stÄr for det gjeldande dokumentet.

Bibliotek: Biblioteknamn (som skil mellom store og smÄ bokstavar) finst i behaldaren. Standardverdien er «Standard».

Dialognamn: Ein streng som skil mellom store og smÄ bokstavar, gjev dialogvindauget.

Eksempla nedanfor i Basic og Python viser dialogvindauget dlgConsole, som hĂžyrer til det delte biblioteket 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 av kontrollelementa vert skrivne her

      lButton = oDlg.Execute()
      ' Standardmodus = Modal
      If lButton = oDlg.OKBUTTON Then
      ' 
 Handsama kontrollelementa og gjera det som trengst her
      End If
      oDlg.Terminate()
  

Eller med Python:


    dlg = CreateScriptService('SFDialogs.Dialog', 'GlobalScope', 'ScriptForge', 'dlgConsole')
    ' 
 initialisering av kontrollelementa vert skrivne her

    rc = dlg.Execute()
    ' Standardmodus er Modal
    if rc == dlg.OKBUTTON:
        ' 
 Handsama kontrollelementa og gjera det som trengst her
    dlg.Terminate()
  
note

Bruk strengen «GlobalScope» som container-argumentet nÄr dialogvindauget er lagra anten i Mine makroar og dialogvindauge eller i Programmakroar og dialogvindauge.


Hentar dialogfĂžrekomsten som lĂžyste ut ei dialoghending

Du kan henta ein fĂžrekomst av tenesta Dialog via tenesta SFDialogs.DialogEvent viss dialogvindauget vart opna med tenesta Dialog. I eksempelet nedanfor inneheld fĂžrekomsten av oDlg fĂžrekomsten av Dialog som utlĂžyste dialoghendinga.


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

Eller bruka Python:


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

Merk at i dei tidlegare eksempla kan prefikset «SFDialogs.» slÞyfast nÄr det passar best.

Handsaming av unnatak i hendingshandsamarane

NÄr du opprettar ein hendingshandsamar for dialoghendingar, er det god praksis Ä handsama feil inne i sjÞlve underrutinen.For eksempel gÄr du ut frÄ at hendingshandsamaren nedanfor vert kalla opp nÄr museknappen vert trykt i dialogvindauget.


    Sub OnMouseButtonPressed(ByRef oEvent As Object)
    On Local Error GoTo Catch
        Dim oDialog As Object
        oDialog = CreateScriptService("DialogEvent", oEvent)
        ' KĂžyr hendinga
        Exit Sub
    Catch:
        MsgBox SF_Exception.Description
        SF_Exception.Clear
    End Sub
  
tip

Kall opp SF_Exception.Clear viss du ikkje vil at feilen skal overfĂžrast vidare etter at dialogvindauget er avslutta.


I Python brukar du native try/except-blokker for unntakshandsaming som vist nedanfor:


    def on_mouse_button_pressed(event=None):
        try:
            dlg = CreateScriptService("DialogEvent", event)
            # KĂžyr hendinga
        except Exception as e:
            # Objektet «oBase» er ein fÞrekomst av Basic-tenesta
            bas.MsgBox(str(e))
  

Eigenskapar

Namn

Skriveverna

Type

Beskriving

OKBUTTON

Ja

Integer

Verdi = 1. Der vart trykt pÄ ein OK-knapp.

CANCELBUTTON

Ja

Integer

Verdi = 0. Der vart trykt pÄ ein Avbryt-knapp.

Caption

Nei

String

Spesifiser tittelen pÄ dialogvindauget.

Height

Nei

Long

Spesifiser hÞgda pÄ dialogvindauget.

Modal

Ja

Boolean

Viser om dialogvindauget vert kĂžyrd i modal-modus.

Name

Ja

String

Namnet pÄ dialogvindauget

Page

Nei

Integer

Eit dialogvindauge kan ha fleire sider som brukaren kan gÄ gjennom steg for steg. Kva side i dialogvindauget som er gjeldande, vert definert i sideeigenskapen.

Visible

Nei

Boolean

Spesifiserer om dialogvindauget er synleg pÄ skrivebordet. Som standard er han ikkje synleg fÞr etter at metoden Execute() er utfÞrt.

XDialogModel

Ja

UNO
object

Det UNO-objektet som representer modellen for dialogvindauget. SjÄ detaljert informasjon i XControlModel og UnoControlDialogModel i dokumentasjonen for API-en ( Application Programming Interface).

XDialogView

Ja

UNO
object

Det UNO-objektet som representer modellen for dialogvindauget. SjÄ detaljert informasjon i XControlModel og UnoControlDialogModel i dokumentasjonen for API-en ( Application Programming Interface).

Width

Nei

Long

Spesifiser breidda pÄ dialogvindauget.


Hendingseigenskapar

Returnerer ein URI-streng med referansen til skriptet som vert utlĂžyst av hendinga. Les spesifikasjonen i scripting framework URI specification.

Skriv inn eit namn for objektet

Skriveverna

Basic IDE-beskriving

OnFocusGained

Ja

NÄr han fÄr fokus

OnFocusLost

Ja

NÄr han mistar fokus

OnKeyPressed

Ja

Ved tastetrykk

OnKeyReleased

Ja

Etter tastetrykk

OnMouseDragged

Ja

MuserĂžrsle medan ein tast er trykt

OnMouseEntered

Ja

Mus innanfor

OnMouseExited

Ja

Mus utanfor

OnMouseMoved

Ja

Mus flytt

OnMousePressed

Ja

Museknapp trykt ned

OnMouseReleased

Ja

Museknapp sloppe


Liste over metodar i tenesta Dialog

Activate
Center
Controls

EndExecute
Execute
GetTextsFromL10N

Resize
SetPageManager
Terminate


Activate

Set fokus pÄ det gjeldande dialogvindauget. Returner Sann viss fokuseringa lukkast.

Denne metoden vert kalla opp frÄ eit dialogvindauge, ei kontrollhending eller nÄr det vert vist eit dialogvindauge i ikkje-modal modus.

Syntaks:

svc.Activate(): bool

Eksempel:


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

BÄde Python- og LibreOffice-Basic-eksempla gÄr ut frÄ at dialogvidauget er lagra i Standard-biblioteket i det gjeldande dokument.


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

Center

Sentrerer det gjeldande dialogvindauget i midten av eit overordna vindauge. Utan argument sentrerer metoden dialogvindauget i midten av det gjeldande vindauget.

Returnerer Sann nÄr han lukkast.

Syntaks:

svc.Center(opt Parent: obj): bool

Parametrar:

Overordna: Eit valfritt objekt som kan vera anten


Eksempel:

I Basic

     Sub TriggerEvent(oEvent As Object)
         Dim oDialog1 As Object, oDialog2 As Object, lExec As Long
         Set oDialog1 = CreateScriptService("DialogEvent", oEvent) ' Dialogvindauget som var Ärsaka til hendinga
         Set oDialog2 = CreateScriptService("Dialog", ...) ' Opnar eit anna dialogvindauge
         oDialog2.Center(oDialog1)
         lExec = oDialog2.Execute()
         Select Case lExec
             ...
     End Sub
  
I Python

     def triggerEvent(event: uno):
       dlg1 = CreateScriptService('DialogEvent.Dialog', hendelse) # Dialogvindauget som var Ärsaka til hendinga
       dlg2 = CreateScriptService("Dialog", ...) # Opnar eit anna dialogvindauge
       dlg2.Center(dlg1)
       rc = dlg2.Execute()
       if rc is False:
         # ...
   

Controls

Returner anten:

Syntaks:

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

svc.Controls(controlname: str): svc

Parametrar:

KontrolNamn: Eit gyldig kontrollnamn som ein streng (som skil mellom smÄ og store bokstavar). Viss denne manglar vert lista over kontrollnamn returnert som ei nullbasert matrise.

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

Avsluttar visinga av eit modalt dialogvindauge og returnerer argumentet som returverdi for den gjeldande kĂžyrehandlinga Execute ().

EndExecute() er til vanleg Ă„ finna i handsaminga av ein makro som er utlĂžyst av ei hending i eit dialogvindauge eller eit kontrollelement.

Syntaks:

svc.EndExecute(returnvalue: int)

Parametrar:

returverdi: Verdien som vert sendt til den kĂžyrande Execute()-metoden.

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

Overnemnde com.sun.star.lang.EventObject er valfrie. Slike merknadar hjelper til med Ă„ identifisere LibreOffice Application Programming Interface (API).


Execute

Viser dialogvindauget og ventar, nÄr modal, pÄ avslutning av brukaren. Den returnerte verdien er anten:

For ikkje-modale dialogvindauge returnerer metoden alltid 0 og utfĂžringa av makroen held fram-.

Syntaks:

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

Parametrar:

modal: Usann ved eit ikkje-modalt dialogvindauge. Standard = Sann .

Eksempel:

I dette Basic-eksempelet er dialogvindauget myDialog lagra i det gjeldande dokumentet sitt 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-koden viser det modale dialogvindauget DlgConvert i det delte Basic-biblioteket DlgConvert.


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

GetTextsFromL10N

Bytar ut alle faste tekststrengar i eit dialogvindauge med den omsette versjonen basert pÄ ein fÞrekomst av tenesta L10N . Denne metode omsett desse strengane:

Metoden returnerer Sann viss han lukkast.

Bruk metoden AddTextsFromDialog frÄ tenesta L10N for Ä laga ei liste over strengar som kan omsetjast i eit dialogvindauge.

Syntaks:

svc.GetTextsFromL10N(l10n: svc): bool

Parametrar:

l10n: Ein fÞrekomst av tenesta L10N som dei omsette strengane vert henta frÄ.

Eksempel:

Dei neste eksempla lastar inn omsette strengar og brukar dei i dialogvindauget «MinDialog»:

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

Les hjelpsida L10N service for Ă„ lĂŠra meir om korleis PO. og POT-filer vert handsama.


Resize

Flyttar det Þvre, hÞgre hjÞrnet i eit dialogvindauge til nye koordinat eller endrar storleiken pÄ det. Alle avstandane vert viste i 1/100 mm. Viss argumenta manglar, vert vindauget sett til den opphavlege storleiken. Returnerer Sann viss endringa av storleiken var vellukka.

Syntaks:

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

Parametrar:

Venstre: den vassrette avstanden frÄ Þvre venstre hjÞrne

Topp: den loddrette avstanden frÄ Þvste venstre hjÞrne

Breidd: breidda pÄ rektangelet som inneheld dialogvindauget

HÞgd: hÞgda pÄ rektangelet som inneheld dialogvindauget

Negative eller manglande argument vert ikkje endra

Eksempel:

I Basic

     oDialog.Resize(1000, 2000, Height := 6000) ' Breidda er ikkje endra
   
I Python

Med Python:


     oDialog.Resize(1000, 2000, Height = 6000) # Breidda er ikkje endra
   

SetPageManager

Definerer kva kontrollelement i eit dialogvindauge som er ansvarlege for Ă„ byta sider, noko som gjer det enklare Ă„ administrera Side-eigenskapen til eit dialogvindauge og kontrollelementa i vindauget.

Dialogvindauge kan ha fleire sider, og den synlege siden er definert av dialogeigenskapen Side. Viss eigenskapen Side er uendra, er standard synleg side lik 0 (null), noeko som betyr at ingen bestemt side er definert og alle synlege kontrollelement vert viste uavhengig av verdien sett i deira eigen Side-eigenskap.

NÄr eigenskapen Page for eit dialogvindauge vert endra til ein annan verdi, som 1, 2, 3 og sÄ vidare, er det berre kontrollelementa som Page-eigenskap samsvarer med i det gjeldande dialogvindauget som vert viste.

Ved Ă„ bruka SetPageManager-metoden er det mogleg Ă„ definera fire typar sideadministratorar:

tip

Det er mogleg Ă„ bruka ein sidehandsamingsmekanisme samstundes.


Denne metoden er meint Ä kallast opp bere éin gong fÞr Execute-metoden vert kalla opp. EtterfÞlgjande oppkall vert ignorerte.

Viss han lukkast, returnerer denne metoden Sann.

Syntaks:

svc.SetPageManager(pilotcontrols: str = "", tabcontrols: str = "", wizardcontrols: str = "", opt lastpage: int): bool

Parametrar:

pilotcontrols: ei kommadelt liste over namna pÄ kontrollane ListBox, ComboBox og RadioButton som vert brukte som sideadministratorar. For kontrollelementa «RadioButton» vert namnet spesifisert pÄ det fÞrste elementet i gruppa som skal brukast.

tabcontrols: ei kommadelt liste over namn pÄ knappar som vert brukite som sideadministratorar. RekkjefÞlgja dei er spesifiserte i dette argumentet svarar til sidetalet dei er knytte til.

wizardcontrols: ei kommadelt liste med namna pÄ dei to knappane som vert brukte som knappar for «FÞrre» og «Neste».

lastpage: nummeret pÄ den siste tilgjengelege sida. Det vert rÄdd til Ä spesifisera denne verdien nÄr du brukar sidehandsaminga «FÞrre» og «Neste».

Eksempel:

Tenk deg eit dialogvindauge med tre sider. Dialogvindauget har ein ListBox-kontroll kalla «aPageList» som vert brukt til Ä kontrollera den synlege sida. I tillegg er det to knappar kalla «btnForrige» og «btnNeste» som vil verta brukte som «FÞrre/Neste»-knappane i dialogvindauget.

I Basic

    oDialog.SetPageManager(PilotControls := "aPageList", _
                           WizardControls := "btnPrevious,btnNext", _
                           LastPage := 3)
    oDialog.Execute()
  
I Python

    dlg.SetPageManager(pilotcontrols="aPageList",
                       wizardcontrols="btnPrevious,btnNext",
                       lastpage=3)
    dlg.Execute()
  

Terminate

Avslutt tenesta Dialog i den gjeldande fĂžrekomsten. Returner Sann viss avslutninga lukkast.

Syntaks:

svc.Terminate(): bool

Eksempel:

Basic- og Python-eksempla nedanfor opnar dei ikkje-modale dialogvindauga DlgConsole og dlgTrace. Dei er lagra i dei delte biblioteka ScriptForge og Access2Base. Knappane for Ä lukka dialogvindauga er kopla frÄ, og eksplisitt avslutning vert utfÞrt pÄ slutten av ein kÞyrande prosess.

I dette eksempelet erstattar ein knapp i DlgConsole hemma lukking av vindauget:

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-rutinane og -identifikatorane som vert innleidde med understrek «_» er reserverte for internt bruk. Dei er ikkje meint brukte i Basic-makroar.