Service SFDialogs.Dialog

Contenu
Index 🔎︎

# SFDialogs. Service Dialog

Le service Dialog contribue à la gestion des dialogues créés avec le Dialog Editor Basic . Chaque instance de la classe actuelle représente une seule boîte de dialogue affichée à l'utilisateur.

Une boîte de dialogue peut être affichée en mode modal ou en mode non modal.

En mode modal, la boîte s'affiche et l'exécution du traitement de la macro est suspendue jusqu'à ce que l'un des boutons OK ou Annuler soit enfoncé. En attendant, les actions de l'utilisateur exécutées sur la boîte de dialogue peuvent déclencher des actions spécifiques.

En mode non modal, la boîte de dialogue est "flottante" sur le bureau de l'utilisateur et l'exécution du processus de macro se poursuit normalement. Une boîte de dialogue non modale se ferme lorsqu'elle est terminée avec la méthode Terminate() ou lorsque la session LibreOfficeDev se termine. Le bouton de fermeture de fenêtre est inactif dans les boîtes de dialogue non modales.

Une boîte de dialogue disparaît de la mémoire après sa fermeture explicite.

Le service SFDialogs.Dialog est étroitement lié au service SFDialogs.DialogControl.

## Invocation de service et utilisation.

Avant d'utiliser le service Dialog, la bibliothèque ScriptForge doit être chargée ou importée :

• Les macros Basic nécessitent de charger la bibliothèque ScriptForge à l'aide de l'instruction suivante :
GlobalScope.BasicLibraries.loadLibrary("ScriptForge")
• Les scripts Python nécessitent un import depuis le module scriptforge :
from scriptforge import CreateScriptService

Le service Dialog est appelé via la méthode CreateScriptService. Il nécessite trois arguments de position pour spécifier la boîte de dialogue à activer :

Container : "GlobalScope" pour les bibliothèques préinstallées ou un nom de la fenêtre tel que défini par le service ScriptForge.UI. La valeur par défaut de la chaîne vide "" correspond au document actuel.

Library : le nom sensible à la casse d'une bibliothèque contenue dans le conteneur. La valeur par défaut est "Standard".

DialogName : une chaîne sensible à la casse désignant la boîte de dialogue.

Les exemples ci-dessous en Basic et Python affichent la boîte de dialogue dlgConsole qui appartient à la bibliothèque partagée 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")
          '... l'initialisation des contrôles va ici...
          lButton = oDlg.Execute()
          'Mode par défaut = Modal
          If lButton = oDlg.OKBUTTON Then
          '... Traiter les contrôles et faire ce qui est nécessaire ici
          End If
          oDlg.Terminate()

Ou en utilisant Python :

        dlg = CreateScriptService('SFDialogs.Dialog', 'GlobalScope', 'ScriptForge', 'dlgConsole')
        #... l'initialisation des contrôles va ici...
        rc = dlg.Execute()
        # Le mode par défaut est Modal
        if rc == dlg.OKBUTTON:
            #... Traiter les contrôles et faire ce qui est nécessaire ici
        dlg.Terminate()

Utilisez la chaîne "GlobalScope" comme argument container lorsque la boîte de dialogue est stockée soit dans Mes macros et boîtes de dialogue ou dans Application Macros & Dialogs.

## Récupération de l'instance Dialog qui a déclenché un événement de dialogue

Une instance du service Dialog peut être récupérée via le service SFDialogs.DialogEvent, à condition que le dialogue ait été initié avec le service Dialog. Dans l'exemple ci-dessous, oDlg contient l'instance Dialog qui a déclenché l'événement dialog.

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

Ou en utilisant Python :

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

Notez que dans les exemples précédents, le préfixe "SFDialogs." peut être omis lorsque cela est jugé approprié.

## Gestion des exceptions dans les gestionnaires d'événements

Lors de la création d'un gestionnaire d'événements pour les événements de dialogue, il est recommandé de gérer les erreurs à l'intérieur du sous-programme lui-même. Par exemple, supposons que le gestionnaire d'événements ci-dessous est appelé lorsque le bouton de la souris est enfoncé dans la fenêtre de dialogue.

        Sub OnMouseButtonPressed(ByRef oEvent As Object)
        On Local Error GoTo Catch
            Dim oDialog As Object
            oDialog = CreateScriptService("DialogEvent", oEvent)
            ' Traiter l'événement
            Exit Sub
        Catch:
            MsgBox SF_Exception.Description
            SF_Exception.Clear
        End Sub

Appelez SF_Exception.Clear si vous ne voulez pas que l'erreur se propage après la fin de l'exécution du dialogue.

En Python, utilisez les blocs natifs try/except pour la gestion des exceptions, comme indiqué ci-dessous :

        def on_mouse_button_pressed(event=None):
            try:
                dlg = CreateScriptService("DialogEvent", event)
                # Traiter l'événement
            except Exception as e:
                # L'objet "bas" est une instance du service Basic
                bas.MsgBox(str(e))

## Propriétés

Nom | Lecture seule | Type | Description
--- | --- | --- | ---
OKBUTTON | Oui | Integer | Value=1. Un bouton OK a été pressé.
CANCELBUTTON | Oui | Integer | Value=0. Un bouton Annuler a été pressé.
Caption | Non | String | Spécifier le titre de la boîte de dialogue.
Height | Non | Long | Spécifier la hauteur de la boîte de dialogue.
Modal | Oui | Boolean | Spécifie si la boîte de dialogue est actuellement en cours d'exécution en mode modal.
Name | Oui | String | Le nom de la boîte de dialogue
Page | Non | Integer | Une boîte de dialogue peut comporter plusieurs pages que l'utilisateur peut parcourir pas à pas. La propriété Page de l'objet Dialog définit quelle page de la boîte de dialogue est active.
Visible | Non | Boolean | Spécifier si la boîte de dialogue est visible sur le bureau. Par défaut, elle n'est pas visible tant que la méthode Execute() n'est pas exécutée et visible ensuite.
XDialogModel | Oui | UNO object | L'objet UNO représentant le modèle de boîte de dialogue. Reportez-vous à XControlModel et UnoControlDialogModel dans la documentation de l'interface de programmation d'application (API) pour des informations détaillées.
XDialogView | Oui | UNO object | L'objet UNO représentant la vue de la boîte de dialogue. Reportez-vous à XControl et UnoControlDialog dans la documentation de l'interface de programmation d'application (API) pour des informations détaillées.
Width | Non | Long | Spécifier la largeur de la boîte de dialogue.

## Propriétés de l'événement

Renvoie une chaîne URI avec la référence au script déclenché par l'événement. Lisez sa spécification dans la spécification de l'URI du framework de script.

Nom | Lecture seule | Description de l'IDE Basic
--- | --- | ---
OnFocusGained | Oui | À la réception du focus
OnFocusLost | Oui | À la perte du focus
OnKeyPressed | Oui | Touche enfoncée
OnKeyReleased | Oui | Touche relâchée
OnMouseDragged | Oui | Déplacement de la souris lors de l'appui sur une touche
OnMouseEntered | Oui | Souris à l'intérieur
OnMouseExited | Oui | Souris à l'extérieur
OnMouseMoved | Oui | Souris déplacée
OnMousePressed | Oui | Bouton de la souris enfoncé
OnMouseReleased | Oui | Bouton de la souris relâché

List of Methods in the Dialog Service
Activate Center Controls | EndExecute Execute GetTextsFromL10N | Resize SetPageManager Terminate

## Activate

Définir le focus sur l'instance Dialog active. Renvoie True si la mise au point a réussi.

Cette méthode est appelée à partir d'un événement de boîte de dialogue ou de contrôle, ou lorsqu'une boîte de dialogue est affichée en mode non modal.

### Syntaxe :

svc.Activate(): bool

### Exemple :

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

Les exemples Python et LibreOfficeDev Basic supposent tous deux que la boîte de dialogue est stockée dans la bibliothèque Standard du document actif.

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

## Center

Centre l'instance de dialogue actuelle au milieu d'une fenêtre parent. Sans arguments, la méthode centre la boîte de dialogue au milieu de la fenêtre courante.

Renvoie True en cas de succès.

### Syntaxe :

svc.Center(opt Parent: obj): bool

### Paramètres :

Parent : un objet facultatif qui peut être soit …

- un objet de dialogue ScriptForge

- un objet de document ScriptForge (Calc, Base, ...)

### Exemple :

##### En Basic :

         Sub TriggerEvent(oEvent As Object)
             Dim oDialog1 As Object, oDialog2 As Object, lExec As Long
             Set oDialog1 = CreateScriptService("DialogEvent", oEvent) ' La boîte de dialogue à l'origine de l'événement
             Set oDialog2 = CreateScriptService("Dialog", ...) ' Ouvrir une seconde boîte de dialogue
             oDialog2.Center(oDialog1)
             lExec = oDialog2.Execute()
             Select Case lExec
                 ...
         End Sub

##### En Python

         def triggerEvent(event: uno):
           dlg1 = CreateScriptService('DialogEvent.Dialog', event)  # Le dialogue à l'origine de l'événement
           dlg2 = CreateScriptService('Dialog', ...)  # Ouvrir une deuxième boîte de dialogue
           dlg2.Center(dlg1)
           rc = dlg2.Execute()
           if rc is False:
             # ...

## Controls

Renvoyer soit :

- la liste des contrôles contenus dans la boîte de dialogue

- une instance de classe DialogControl basée sur son nom

### Syntaxe :

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

svc.Controls(controlname: str): svc

### Paramètres :

ControlName : un nom de contrôle valide sous forme de chaîne sensible à la casse. S'il est absent, la liste des noms de contrôle est renvoyée sous la forme d'une matrice de base zéro.

### Exemple :

          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

Termine l'affichage d'une boîte de dialogue modale et renvoie l'argument comme valeur de retour pour l'action en cours d'exécution Execute().

EndExecute() est généralement contenu dans le traitement d'une macro déclenchée par une boîte de dialogue ou un événement de contrôle.

### Syntaxe :

svc.EndExecute(returnvalue: int)

### Paramètres :

returnvalue : la valeur transmise à la méthode Execute() en cours d'exécution.

### Exemple :

En utilisant LibreOfficeDev 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

En utilisant Python :

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

Les mentions ci-dessus com.sun.star.lang.EventObject sont facultatives. Ces annotations permettent d'identifier l'interface de programmation d'application (API) de LibreOfficeDev.

## Execute

Afficher la boîte de dialogue et, lorsqu'elle est modale, attendre sa fermeture par l'utilisateur. La valeur renvoyée est soit :

- 0 : bouton appuyé Cancel

- 1 : bouton appuyé OK

- Sinon, la boîte de dialogue s'est arrêtée avec une instruction EndExecute() émise par une boîte de dialogue ou un événement de contrôle

Pour les boîtes de dialogue non modales, la méthode renvoie toujours 0 et l'exécution de la macro se poursuit.

### Syntaxe :

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

### Paramètres :

modal : False en cas de dialogue non modal. Par défaut = True.

### Exemple :

Dans cet exemple Basic, la boîte de dialogue myDialog est stockée dans la bibliothèque Standard du document actuel.

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

Ce code Python affiche la boîte de dialogue modale DlgConvert de la bibliothèque Basic partagée Euro.

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

## GetTextsFromL10N

Remplace toutes les chaînes de texte fixes d'une boîte de dialogue par leurs versions traduites basées sur une instance de service L10N. Cette méthode traduit les chaînes suivantes :

- 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.

La méthode renvoie True en cas de succès.

Pour créer une liste de chaînes traduisibles dans une boîte de dialogue, utilisez la méthode AddTextsFromDialog du service L10N.

### Syntaxe :

svc.GetTextsFromL10N(l10n: svc): bool

### Paramètres :

l10n : une instance de service L10N à partir de laquelle les chaînes traduites seront récupérées.

### Exemple :

L'exemple suivant charge les chaînes traduites et les applique à la boîte de dialogue "MyDialog".

##### En Basic :

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

##### En Python

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

Lisez la page d'aide du service L10N pour en savoir plus sur la gestion des fichiers PO et POT.

## Resize

Déplace le coin supérieur gauche d'une boîte de dialogue vers de nouvelles coordonnées et/ou modifie ses dimensions. Toutes les distances sont exprimées en 1/100 mm. Sans arguments, la méthode réinitialise les dimensions initiales. Renvoie True si le redimensionnement a réussi.

### Syntaxe :

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

### Paramètres :

Left : la distance horizontale depuis le coin supérieur gauche

Top : la distance verticale à partir du coin supérieur gauche

Width : la largeur du rectangle contenant la boîte de dialogue

Height : la hauteur du rectangle contenant la boîte de dialogue

Les arguments négatifs ou manquants restent inchangés

### Exemple :

##### En Basic :

         oDialog.Resize(1000, 2000, Height := 6000) ' La largeur n'est pas modifiée

##### En Python

Avec Python :

         oDialog.Resize(1000, 2000, Height = 6000)  # La largeur n'est pas modifiée

## SetPageManager

Définit les contrôles d'une boîte de dialogue responsables du changement de page, ce qui facilite la gestion de la propriété Page d'une boîte de dialogue et de ses contrôles.

Les boîtes de dialogue peuvent avoir plusieurs pages et la page actuellement visible est définie par la propriété de dialogue Page. Si la propriété Page reste inchangée, la page visible par défaut est égale à 0 (zéro), ce qui signifie qu'aucune page particulière n'est définie et que tous les contrôles visibles sont affichés quelle que soit la valeur définie dans leur propre propriété de la Page.

Lorsque la propriété Page d'une boîte de dialogue est remplacée par une autre valeur telle que 1, 2, 3, etc., seuls les contrôles dont la propriété Page correspondent à la page de boîte de dialogue actuelle seront affichés.

En utilisant la méthode SetPageManager il est possible de définir quatre types de gestionnaires de pages :

- List box or combo box : dans ce cas, chaque entrée de la liste ou de la zone combinée correspond à une page. Le premier élément fait référence à la page 1, le second à la page 2 et ainsi de suite.

- Groupe of radio buttons : définit un groupe de boutons radio qui contrôlera quelle page est 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: définit les boutons de la boîte de dialogue qui seront utilisés pour naviguer vers la page Précédent/Suivant de la boîte de dialogue.

Il est possible d'utiliser plusieurs mécanismes de gestion de pages en même temps.

Cette méthode est censée être appelée une seule fois avant d'appeler la méthode Execute. Les appels suivants sont ignorés.

Si elle réussit, cette méthode renvoie True.

### Syntaxe :

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

### Paramètres :

pilotcontrols : une liste séparée par des virgules de noms de contrôle ListBox, ComboBox ou RadioButton utilisés comme gestionnaires de page. Pour les contrôles RadioButton, spécifiez le nom du premier contrôle du groupe à utiliser.

tabcontrols : une liste de noms de boutons séparés par des virgules qui seront utilisés comme gestionnaires de page. L'ordre dans lequel ils sont spécifiés dans cet argument correspond au numéro de page auquel ils sont associés.

wizardcontrols : une liste séparée par des virgules avec les noms de deux boutons qui seront utilisés comme boutons Précédent/Suivant.

lastpage : le numéro de la dernière page disponible. Il est recommandé de spécifier cette valeur lors de l'utilisation du gestionnaire de pages Précédent/Suivant.

### Exemple :

Prenons une boîte de dialogue de trois pages. La boîte de dialogue a un contrôle ListBox nommé "aPageList" qui sera utilisé pour contrôler la page visible. De plus, il y a deux boutons nommés "btnPrevious" et "btnNext" qui seront utilisés comme boutons Précédent/Suivant dans la boîte de dialogue.

##### En Basic :

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

##### En Python

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

## Terminate

Arrêter le service Dialog pour l'instance actuelle. Renvoie True si l'arrêt a réussi.

### Syntaxe :

svc.Terminate(): bool

### Exemple :

Les exemples Basic et Python ci-dessous, ouvrent les boîtes de dialogue non modales DlgConsole et dlgTrace. Elles sont respectivement stockées dans les bibliothèques partagées ScriptForge et Access2Base. Les boutons de fermeture de boîte de dialogue sont désactivés et une terminaison explicite est effectuée à la fin d'un processus en cours d'exécution.

Dans cet exemple, un bouton dans DlgConsole remplace la fermeture de fenêtre inhibée :

##### En Basic :

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

En Python :

##### En Python

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

Toutes les routines ou identifiants de base ScriptForge qui sont préfixés par un caractère de soulignement "_" sont réservés à un usage interne. Ils ne sont pas destinés à être utilisés dans des macros de base ou des scripts Python.

Rubriques connexes

SFDialogs. Service DialogControl

ScriptForge.UI service