SFDialogs.Dialog szolgáltatás

Tartalom
Index 🔎︎

# SFDialogs.Dialog service

The Dialog service contributes to the management of dialogs created with the Basic Dialog Editor. Each instance of the current class represents a single dialog box displayed to the user.

A dialog box can be displayed in modal or in non-modal modes.

Modális módban a doboz megjelenik, és a makrófolyamat végrehajtása felfüggesztésre kerül, amíg az OK vagy a Mégse gombok valamelyikét meg nem nyomja. Eközben a dobozon végrehajtott felhasználói műveletek meghatározott műveleteket indíthatnak el.

Nem modális módban a párbeszédablak "lebeg" a felhasználói asztalon, és a makrófolyamat végrehajtása normálisan folytatódik. A nem-modális párbeszédablak bezárul, amikor a Terminate() metódussal befejezésre kerül vagy a LibreOffice munkamenet befejeződik. A nem modális párbeszédpanelekben az ablak bezárása gomb nem aktív.

A dialog box disappears from memory after its explicit termination.

The SFDialogs.Dialog service is closely related to the SFDialogs.DialogControl service.

## Service invocation and usage

Before using the Dialog service the ScriptForge library needs to be loaded or imported:

• 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

The Dialog service is invoked through the CreateScriptService method. It requires three positional arguments to specify the dialog box to activate:

Container: "GlobalScope" for preinstalled libraries or a window name as defined by ScriptForge.UI service. Empty string "" default value stands for the current document.

Library: The case-sensitive name of a library contained in the container. Default value is "Standard".

DialogName: A case-sensitive string designating the dialog.

The examples below in Basic and Python display the dlgConsole dialog that belongs to the ScriptForge shared library:

          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")
          '... controls initialization goes here...
          lButton = oDlg.Execute()
          'Default mode = Modal
          If lButton = oDlg.OKBUTTON Then
          '... Process controls and do what is needed here
          End If
          oDlg.Terminate()

Vagy Python használatával:

        dlg = CreateScriptService('SFDialogs.Dialog', 'GlobalScope', 'ScriptForge', 'dlgConsole')
        # ... controls initialization goes here...
        rc = dlg.Execute()
        # Default mode is Modal
        if rc == dlg.OKBUTTON:
            # ... Process controls and do what is needed here
        dlg.Terminate()

Use the string "GlobalScope" as the container argument when the dialog is stored either in My Macros & Dialogs or in Application Macros & Dialogs.

## Retrieving the Dialog instance that triggered a dialog event

A Dialog szolgáltatás egy példánya a SFDialogs.DialogEvent szolgáltatáson keresztül kérhető le, feltéve, hogy a párbeszédet a Dialog szolgáltatással kezdeményezték. Az alábbi példában az oDlg tartalmazza a Dialog példányt, amely a párbeszédeseményt kiváltotta.

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

Or using Python:

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

Note that in the previous examples, the prefix "SFDialogs." may be omitted when deemed appropriate.

## Handling exceptions in event handlers

A párbeszédesemények eseménykezelőjének létrehozásakor jó gyakorlat, ha a hibákat magában a szubrutinban kezeli. Tegyük fel például, hogy az alábbi eseménykezelőt akkor hívjuk meg, amikor a párbeszédablakban megnyomjuk az egérgombot.

        Sub OnMouseButtonPressed(ByRef oEvent As Object)
        On Local Error GoTo Catch
            Dim oDialog As Object
            oDialog = CreateScriptService("DialogEvent", oEvent)
            ' Process the event
            Exit Sub
        Catch:
            MsgBox SF_Exception.Description
            SF_Exception.Clear
        End Sub

Call SF_Exception.Clear if you do not want the error to propagate after the dialog execution ended.

In Python use native try/except blocks for exception handling as shown below:

        def on_mouse_button_pressed(event=None):
            try:
                dlg = CreateScriptService("DialogEvent", event)
                # Process the event
            except Exception as e:
                # The object "bas" is an instance of the Basic service
                bas.MsgBox(str(e))

## Tulajdonságok

Név | Írásvédett | Típus | Leírás
--- | --- | --- | ---
OKBUTTON | Igen | Integer | Value = 1. An OK button was pressed.
CANCELBUTTON | Igen | Integer | Value = 0. A Cancel button was pressed.
Caption | Nem | String | Specify the title of the dialog.
Height | Nem | Long | Specify the height of the dialog box.
Modal | Igen | Boolean | Specifies if the dialog box is currently in execution in modal mode.
Name | Igen | String | The name of the dialog
Page | Nem | Integer | A dialog may have several pages that can be traversed by the user step by step. The Page property of the Dialog object defines which page of the dialog is active.
Visible | Nem | Boolean | Specify if the dialog box is visible on the desktop. By default it is not visible until the Execute() method is run and visible afterwards.
XDialogModel | Igen | UNO object | The UNO object representing the dialog model. Refer to XControlModel and UnoControlDialogModel in Application Programming Interface (API) documentation for detailed information.
XDialogView | Igen | UNO object | The UNO object representing the dialog view. Refer to XControl and UnoControlDialog in Application Programming Interface (API) documentation for detailed information.
Width | Nem | Long | Specify the width of the dialog box.

## Esemény tulajdonságai

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

Név | Írásvédett | Basic IDE leírása
--- | --- | ---
OnFocusGained | Igen | Amikor a fókuszt megkapja
OnFocusLost | Igen | Amikor a fókuszt elveszti
OnKeyPressed | Igen | Billentyű lenyomva
OnKeyReleased | Igen | Billentyű felengedve
OnMouseDragged | Igen | Mouse moved while key presses
OnMouseEntered | Igen | Egér belül
OnMouseExited | Igen | Egér kívül
OnMouseMoved | Igen | Egér mozdult
OnMousePressed | Igen | Egérgomb lenyomása
OnMouseReleased | Igen | Egérgomb elengedése

| Metódusok |
--- | --- | ---
Activate Center Controls | EndExecute Execute GetTextsFromL10N | Resize SetPageManager Terminate

## Activate

Set the focus on the current Dialog instance. Return True if focusing was successful.

This method is called from a dialog or control event, or when a dialog is displayed in non-modal mode.

### Szintaxis:

svc.Activate(): bool

### Példa:

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

Python and LibreOffice Basic examples both assume that the dialog is stored in current document's Standard library.

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

## Center

Centers the current dialog instance in the middle of a parent window. Without arguments, the method centers the dialog in the middle of the current window.

Returns True when successful.

### Szintaxis:

svc.Center(opt Parent: obj): bool

### Paraméterek:

Parent: An optional object that can be either …

- a ScriptForge dialog object

- a ScriptForge document (Calc, Base, ...) object

### Példa:

##### A Basic nyelvben

         Sub TriggerEvent(oEvent As Object)
             Dim oDialog1 As Object, oDialog2 As Object, lExec As Long
             Set oDialog1 = CreateScriptService("DialogEvent", oEvent) ' The dialog that caused the event
             Set oDialog2 = CreateScriptService("Dialog", ...) ' Open a second dialog
             oDialog2.Center(oDialog1)
             lExec = oDialog2.Execute()
             Select Case lExec
                 ...
         End Sub

##### A Python nyelvben

         def triggerEvent(event: uno):
           dlg1 = CreateScriptService('DialogEvent.Dialog', event)  # The dialog having caused the event
           dlg2 = CreateScriptService('Dialog', ...)  # Open a second dialog
           dlg2.Center(dlg1)
           rc = dlg2.Execute()
           if rc is False:
             # ...

## Controls

Return either:

- the list of the controls contained in the dialog

- a DialogControl class instance based on its name

### Szintaxis:

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

svc.Controls(controlname: str): svc

### Paraméterek:

ControlName : A valid control name as a case-sensitive string. If absent, the list of control names is returned as a zero-based array.

### Példa:

          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

Ends the display of a modal dialog and gives back the argument as return value for the current Execute() running action.

EndExecute() is usually contained in the processing of a macro triggered by a dialog or control event.

### Szintaxis:

svc.EndExecute(returnvalue: int)

### Paraméterek:

returnvalue: The value passed to the running Execute() method.

### Példa:

Using 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

Python használatával:

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

Above com.sun.star.lang.EventObject mentions are optional. Such annotations help identify LibreOffice Application Programming Interface (API).

## Execute

Display the dialog box and, when modal, wait for its termination by the user. The returned value is either:

- 0 : Cancel button pressed

- 1 : OK button pressed

- Otherwise the dialog stopped with an EndExecute() statement issued by a dialog or control event

For non-modal dialog boxes the method always returns 0 and the execution of the macro continues.

### Szintaxis:

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

### Paraméterek:

modal: False when non-modal dialog. Default = True.

### Példa:

In this Basic example myDialog dialog is stored in current document's Standard library.

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

This Python code displays DlgConvert modal dialog from Euro shared Basic library.

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

## GetTextsFromL10N

Replaces all fixed text strings in a dialog by their translated versions based on a L10N service instance. This method translates the following strings:

- The title of the dialog.

- The caption of the following control types: Button, CheckBox, FixedLine, FixedText, GroupBox and RadioButton.

- Static strings in ListBoxes and ComboBoxes.

- The tooltip or help text displayed when the mouse hovers over the control.

The method returns True if successful.

To create a list of translatable strings in a dialog use the AddTextsFromDialog method from the L10N service.

### Szintaxis:

svc.GetTextsFromL10N(l10n: svc): bool

### Paraméterek:

l10n: A L10N service instance from which translated strings will be retrieved.

### Példa:

The following example loads translated strings and applies them to the dialog "MyDialog".

##### A Basic nyelvben

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

##### A Python nyelvben

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

Read the L10N service help page to learn more about how PO and POT files are handled.

## Resize

A párbeszédablak bal felső sarkát új koordinátákra mozgatja és/vagy módosítja a méreteit. Minden távolság 1/100 mm-ben van megadva. Argumentumok nélkül a metódus visszaállítja a kezdeti méreteket. True értéket ad vissza, ha az átméretezés sikeres volt.

### Szintaxis:

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

### Paraméterek:

Left: the horizontal distance from the top-left corner

Top: the vertical distance from the top-left corner

Width: the width of the rectangle containing the dialog

Height: the height of the rectangle containing the dialog

Negative or missing arguments are left unchanged

### Példa:

##### A Basic nyelvben

         oDialog.Resize(1000, 2000, Height := 6000) ' Width is not changed

##### A Python nyelvben

Pythonnal:

         oDialog.Resize(1000, 2000, Height = 6000)  # Width is not changed

## SetPageManager

Defines which controls in a dialog are responsible for switching pages, making it easier to manage the Page property of a dialog and its controls.

A párbeszédablakoknak több oldala is lehet, és az aktuálisan látható oldalt a Page párbeszédablak-tulajdonság határozza meg. Ha a Page tulajdonság változatlanul marad, az alapértelmezett látható oldal értéke 0 (nulla), ami azt jelenti, hogy nincs meghatározott oldal definiálva, és minden látható vezérlőelem megjelenik, függetlenül a saját Page tulajdonságukban beállított értéktől.

Ha a párbeszédablak Page tulajdonságát más értékre, például 1, 2, 3 stb. értékre változtatjuk, akkor csak azok a vezérlők jelennek meg, amelyek Page tulajdonsága megfelel az aktuális párbeszédablak oldalának.

By using the SetPageManager method it is possible to define four types of page managers:

- Listapanel vagy kombinált lista: ebben az esetben a listapanel vagy kombinált lista minden egyes bejegyzése egy oldalnak felel meg. Az első elem az 1. oldalra, a második elem a 2. oldalra utal, és így tovább.

- Group of radio buttons: defines a group of radio buttons that will control which page is visible.

- Sequence of buttons: defines a set of buttons, each of which corresponding to a dialog page. This can be used to emulate a tabbed interface by placing buttons side by side in the dialog.

- Previous/Next buttons: defines which buttons in the dialog that will be used to navigate to the Previous/Next page in the dialog.

It is possible to use more than one page management mechanism at the same time.

This method is supposed to be called just once before calling the Execute method. Subsequent calls are ignored.

If successful this method returns True.

### Szintaxis:

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

### Paraméterek:

pilotcontrols: a comma-separated list of ListBox, ComboBox or RadioButton control names used as page managers. For RadioButton controls, specify the name of the first control in the group to be used.

tabcontrols: az oldalkezelőként használt gombok neveinek vesszővel elválasztott listája. Az ebben az argumentumban megadott sorrendjük megfelel a hozzájuk tartozó oldalszámnak.

wizardcontrols: a comma-separated list with the names of two buttons that will be used as the Previous/Next buttons.

lastpage: the number of the last available page. It is recommended to specify this value when using the Previous/Next page manager.

### Példa:

Tekintsünk egy három oldalas párbeszédablakot. A párbeszédablak rendelkezik egy ListBox vezérlővel, amelynek neve "aPageList", és amely a látható oldal vezérlésére szolgál. Ezenkívül van két, "btnPrevious" és "btnNext" nevű gomb, amelyek a párbeszédablak Előző/Következő gombjaiként lesznek használva.

##### A Basic nyelvben

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

##### A Python nyelvben

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

## Terminate

Terminate the Dialog service for the current instance. Return True if the termination was successful.

### Szintaxis:

svc.Terminate(): bool

### Példa:

Az alábbi Basic és Python példák megnyitják a DlgConsole és dlgTrace nem modális párbeszédablakokat. Ezek a ScriptForge és Access2Base megosztott könyvtárakban vannak tárolva. A párbeszédablakok bezárására szolgáló gombok le vannak tiltva, és a folyamat végén explicit befejezés történik.

In this example a button in DlgConsole is substituting inhibited window closing:

##### A Basic nyelvben

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

Pythonnal:

##### A Python nyelvben

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

All ScriptForge Basic routines or identifiers that are prefixed with an underscore character "_" are reserved for internal use. They are not meant be used in Basic macros or Python scripts.

Kapcsolódó témakörök

SFDialogs.DialogControl service

ScriptForge.UI service