SFDialogs. Service Dialog

Le service Dialog contribue à la gestion des boîtes de dialogue créées avec l'Dialog Editor Basic ou des boîtes de dialogue créées à la volée . Chaque instance de la classe actuelle représente une boîte de dialogue unique 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 LibreOffice 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 supplémentaires 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.

Le service de dialogue propose des méthodes qui créent de nouveaux contrôles de manière dynamique dans une boîte de dialogue existante prédéfinie avec l'éditeur de dialogue. Une boîte de dialogue est initialisée avec des contrôles dans l'éditeur de boîtes de dialogue et de nouveaux contrôles peuvent être ajoutés au moment de l'exécution avant ou après l'instruction Execute() de la boîte de dialogue.

Le service Dialog peut également être invoqué - via la méthode CreateScriptService - lors de la création de boîtes de dialogue à la volée. Il nécessite deux arguments de position supplémentaires après le nom du service ad hoc « NewDialog » :

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

Place : Emplacement de la fenêtre de la boîte de dialogue étant soit :

• une matrice Basic ou un tuple Python avec 4 éléments : (X, Y, largeur, hauteur)

• un objet com.sun.star.awt.Rectangle [X, Y, Width, Height]

Tous les éléments sont exprimés en unités Map AppFont.

    Sub newDialog()
        Dim oDlg As Object
       oDlg = CreateScriptService("NewDialog", "myDialog1", Array(100,200, 40, 110))
       ' ...
    End Sub
  

Ou en utilisant Python :

    def newDialog():
       dlg = CreateScriptService('NewDialog', 'myDialog1', (100,200, 40, 110))
       #... Traiter les contrôles et faire ce qui est nécessaire
  

Toutes les propriétés et méthodes applicables aux boîtes de dialogue prédéfinies sont disponibles pour ces nouvelles boîtes de dialogue. En particulier la série de méthodes CreateXXX() pour l'ajout de nouveaux contrôles de dialogue.

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

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

Les propriétés On… renvoient une chaîne URI avec la référence au script déclenché par l'événement. Les propriétés On… peuvent être définies par programme.
Lisez sa spécification dans le scripting frameworkURI.

L'attribution d'événements via l'EDI Basic et l'attribution d'événements via des macros s'excluent mutuellement.

La dimension d'une boîte de dialogue s'effectue à l'aide des unités Map AppFont. Un modèle de boîte de dialogue ou de contrôle utilise également des unités AppFont. Alors que leurs affichages utilisent des pixels.

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.

svc.Activate(): bool

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

Les exemples Python et LibreOffice 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.

svc.Center(opt Parent: obj): bool

Parent : un objet facultatif qui peut être soit …

• un objet de dialogue ScriptForge

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

     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
  

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

CloneControl

Dupliquez un contrôle existant de n’importe quel type dans la boîte de dialogue réelle. Le contrôle dupliqué reste inchangé et peut être déplacé.

svc.CloneControl(SourceName: str, ControlName: str, Left: num, Top: num): svc

SourceName : Le nom du contrôle à dupliquer.

ControlName : un nom de contrôle valide sous forme de chaîne sensible à la casse. Celui-ci ne doit pas encore exister.

Left, Top : les coordonnées du nouveau contrôle exprimées en unités Map AppFont.

      Set myButton2 = oDlg.CloneControl("Button1", "Button2", 30, 30)
   

     dlg = dlg.CloneControl('Button1', 'Button2', 30, 30)
   

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

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

svc.Controls(controlname: str): svc

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.

      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')
   

CreateButton

Créez un nouveau contrôle de type Button dans la boîte de dialogue actuelle.

svc.CreateButton(ControlName: str, Place: any, Toggle: bool = False, Push: str = ""): svc

ControlName : le nom du nouveau contrôle. Celui-ci ne doit pas encore exister.

Place : soit…

• une matrice Basic ou un tuple Python avec 4 éléments : (X, Y, largeur, hauteur)

• un objet com.sun.star.awt.Rectangle [X, Y, Width, Height]

Tous les éléments sont exprimés en unités Map AppFont.

Toggle : lorsque True un bouton Toggle est créé. Par défaut = False

Push: "OK", "CANCEL" ou "" (par défaut)

Une instance du service SFDialogs.DialogControl ou Rien.

     Set myButton = oDlg.CreateButton("Button1", Array(20, 20, 60, 15))
   

     myButton = dlg.CreateButton('Button1', (20, 20, 60, 15))
   

CreateCheckBox

Créez un nouveau contrôle de type CheckBox dans la boîte de dialogue actuelle.

svc.CreateCheckBox(ControlName: str, Place: any, Multiline: bool = False): svc

MultiLine : lorsque True (par défaut = False), la légende peut être affichée sur plusieurs lignes.

     Set myCheckBox = oDlg.CreateCheckBox("CheckBox1", Array(20, 20, 60, 15), MultiLine := True)
   

     myCheckBox = dlg.CreateCheckBox('CheckBox1', (20, 20, 60, 15), MultiLine = True)
   

CreateComboBox

Créez un nouveau contrôle de type ComboBox dans la boîte de dialogue actuelle.

svc.CreateComboBox(ControlName: str, Place: any, Border: str = "3D", DropDown: bool = True, LineCount: num = 5): svc

Border: "3D" (par défaut) ou "FLAT" ou "NONE"

DropDown : lorsque True (par défaut), un bouton déroulant s'affiche

LineCount : spécifie le nombre maximum de lignes affiché dans la liste déroulante (par défaut = 5)

     Set myComboBox = oDlg.CreateComboBox("ComboBox1", Array(20, 20, 60, 15), Dropdown := True)
   

     myComboBox = dlg.CreateComboBox('ComboBox1', (20, 20, 60, 15), Dropdown = True)
   

CreateCurrencyField

Créez un nouveau contrôle de type CurrencyField dans la boîte de dialogue actuelle.

svc.CreateCurrencyField(ControlName: str, Place: any, Border ="3D", SpinButton: bool = False, MinValue: num = -1000000, MaxValue: num = +1000000, Increment: num = 1, Accuracy: num = 2): svc

Border: "3D" (par défaut) ou "FLAT" ou "NONE"

SpinButton : lorsque True (par défaut = False), un bouton de rotation est présent

MinValue : la plus petite valeur pouvant être saisie dans le contrôle. Par défaut = -1 000 000

MaxValue : la plus grande valeur pouvant être saisie dans le contrôle. Par défaut = +1 000 000

Incrément : l'étape à laquelle le bouton de rotation est pressé. Par défaut = 1

Accuracy : spécifie la précision décimale. Par défaut = 2 chiffres décimaux

     Set myCurrencyField = oDlg.CreateCurrencyField("CurrencyField1", Array(20, 20, 60, 15), SpinButton := True)
   

     myCurrencyField = dlg.CreateCurrencyField('CurrencyField1', (20, 20, 60, 15), SpinButton = True)
   

CreateDateField

Créez un nouveau contrôle de type DateField dans la boîte de dialogue actuelle.

svc.CreateDateField(ControlName: str, Place: any, Border: str = "3D", DropDown: bool = False, opt MinDate: datetime, opt MaxDate: datetime): svc

Border: "3D" (par défaut) ou "FLAT" ou "NONE"

DropDown : lorsque True (par défaut = False), un bouton déroulant s'affiche

MinDate : la plus petite date pouvant être saisie dans le champ. Par défaut = 1900-01-01

MaxDate : la plus grande date pouvant être saisie dans le champ. Par défaut = 2200-12-31

     Set myDateField = oDlg.CreateDateField("DateField1", Array(20, 20, 60, 15), Dropdown := True)
   

     myDateField = dlg.CreateDateField('DateField1', (20, 20, 60, 15), Dropdown = True)
   

CreateFileControl

Créez un nouveau contrôle de type FileControl dans la boîte de dialogue actuelle.

svc.CreateFileControl(ControlName: str, Place: any, Border: str = "3D"): svc

Border: "3D" (par défaut) ou "FLAT" ou "NONE"

     Set myFileControl = oDlg.CreateFileControl("FileControl1", Array(20, 20, 60, 15))
   

     myFileControl = dlg.CreateFileControl('FileControl1', (20, 20, 60, 15))
   

CreateFixedLine

Créez un nouveau contrôle de type FixedLine dans la boîte de dialogue actuelle.

svc.CreateFixedLine(ControlName: str, Place: any, Orientation: str): svc

Orientation: "H[orizontal]" ou "V[ertical]".

     Set myFixedLine = oDlg.CreateFixedLine("FixedLine1", Array(20, 20, 60, 15), Orientation := "vertical")
   

     myFixedLine = dlg.CreateFixedLine('FixedLine1', (20, 20, 60, 15), Orientation = 'vertical')
   

CreateFixedText

Créez un nouveau contrôle de type FixedText dans la boîte de dialogue actuelle.

svc.CreateFixedText(ControlName: str, Place: any, Border: str = "3D", MultiLine: bool = False, Align: str = "LEFT", VerticalAlign: str = "TOP"): svc

Border: "NONE" (par défaut) ou "FLAT" ou "3D"

Multiline : lorsque True (par défaut = False), la légende peut être affichée sur plusieurs lignes.

Align : alignement horizontal, "LEFT" (par défaut) ou "CENTER" ou "RIGHT"

VerticalAlign: alignement vertical, "TOP" (par défaut) ou "MIDDLE" ou "BOTTOM"

     Set myFixedText = oDlg.CreateFixedText("FixedText1", Array(20, 20, 60, 15), MultiLine := True)
   

     myFixedText = dlg.CreateFixedText('FixedText1', (20, 20, 60, 15), MultiLine = True)
   

CreateFormattedField

Créez un nouveau contrôle de type FormattedField dans la boîte de dialogue actuelle.

svc.CreateFormattedField(ControlName: str, Place: any, Border: str = "3D", SpinButton: bool = False, MinValue: num = -1000000, MaxValue: num = +1000000): svc

Border: "3D" (par défaut) ou "FLAT" ou "NONE"

SpinButton : lorsque True (par défaut = False), un bouton de rotation est présent

MinValue : la plus petite valeur pouvant être saisie dans le contrôle. Par défaut = -1 000 000

MaxValue : la plus grande valeur pouvant être saisie dans le contrôle. Par défaut = +1 000 000

     Set myFormattedField = oDlg.CreateFormattedField("FormattedField1", Array(20, 20, 60, 15), SpinButton := True)
   

     myFormattedField = dlg.CreateFormattedField('FormattedField1', (20, 20, 60, 15), SpinButton = True)
   

CreateGroupBox

Créez un nouveau contrôle de type GroupBox dans la boîte de dialogue actuelle.

svc.CreateGroupBox(ControlName: str, Place: any): svc

     Set myGroupBox = oDlg.CreateGroupBox("GroupBox1", Array(20, 20, 60, 15))
   

     myGroupBox = dlg.CreateGroupBox('GroupBox1', (20, 20, 60, 15))
   

CreateHyperlink

Créez un nouveau contrôle de type Hyperlink dans la boîte de dialogue actuelle.

svc.CreateHyperlink(ControlName: str, Place: any, Border: str = "NONE", MultiLine: bool = False, Align: str = "LEFT", VerticalAlign: str = "TOP"): svc

Border: "NONE" (par défaut) ou "FLAT" ou "3D"

Multiline : lorsque True (par défaut = False), la légende peut être affichée sur plusieurs lignes.

Align : alignement horizontal, "LEFT" (par défaut) ou "CENTER" ou "RIGHT"

VerticalAlign: alignement vertical, "TOP" (par défaut) ou "MIDDLE" ou "BOTTOM"

     Set myHyperlink = oDlg.CreateHyperlink("Hyperlink1", Array(20, 20, 60, 15), MultiLine := True)
   

     myHyperlink = dlg.CreateHyperlink('Hyperlink1', (20, 20, 60, 15), MultiLine = True)
   

CreateImageControl

Créez un nouveau contrôle de type ImageControl dans la boîte de dialogue actuelle.

svc.CreateImageControl(ControlName: str, Place: any, Border: str = "3D", Scale: str = "FITTOSIZE"): svc

Border: "3D" (par défaut) ou "FLAT" ou "NONE"

Scale: une des valeurs suivantes : "FITTOSIZE" (par défaut), "KEEPRATIO" ou "NO"

     Set myImageControl = oDlg.CreateImageControl("ImageControl1", Array(20, 20, 60, 15))
   

       myImageControl = dlg.CreateImageControl('ImageControl1", (20, 20, 60, 15))
   

CreateListBox

Créez un nouveau contrôle de type ListBox dans la boîte de dialogue actuelle.

svc.CreateListBox(ControlName: str, Place: any, Border: str = "3D", DropDown: bool = True, LineCount: num = 5, MultiSelect: bool = False): svc

Border: "3D" (par défaut) ou "FLAT" ou "NONE"

DropDown : lorsque True (par défaut), un bouton déroulant s'affiche

LineCount : spécifie le nombre maximum de lignes affiché dans la liste déroulante (par défaut = 5)

MultiSelect : lorsque True, plus d'une entrée peut être sélectionnée. Par défaut = False

     Set myListBox = oDlg.CreateListBox("ListBox1", Array(20, 20, 60, 15), Dropdown := True, MultiSelect := True)
   

     myListBox = dlg.CreateListBox('ListBox1', (20, 20, 60, 15), Dropdown = True, MultiSelect = True)
   

CreateNumericField

Créez un nouveau contrôle de type NumericField dans la boîte de dialogue actuelle.

svc.CreateNumericField(ControlName: str, Place: any, Border: str = "3D", SpinButton: bool = False, MinValue: num = -1000000, MaxValue: num = 1000000, Increment: num = 1, Accuracy: num = 2): svc

Border: "3D" (par défaut) ou "FLAT" ou "NONE"

SpinButton : lorsque True (par défaut = False), un bouton de rotation est présent

MinValue : la plus petite valeur pouvant être saisie dans le contrôle. Par défaut = -1 000 000

MaxValue : la plus grande valeur pouvant être saisie dans le contrôle. Par défaut = +1 000 000

Incrément : l'étape à laquelle le bouton de rotation est pressé. Par défaut = 1

Accuracy : spécifie la précision décimale. Par défaut = 2 chiffres décimaux

     Set myNumericField = oDlg.CreateNumericField("NumericField1", Array(20, 20, 60, 15), SpinButton := True)
   

     myNumericField = dlg.CreateNumericField('NumericField1', (20, 20, 60, 15), SpinButton = True)
   

CreatePatternField

Créez un nouveau contrôle de type PatternField dans la boîte de dialogue actuelle.

svc.CreatePatternField(ControlName: str, Place: any, Border: str = "3D", EditMask: str, opt LiteralMax: str): svc

Border: "3D" (par défaut) ou "FLAT" ou "NONE"

EditMask : un code de caractère qui détermine ce que l'utilisateur peut saisir
Reportez-vous à Pattern_Field dans le wiki pour plus d'informations.

LiteralMask : contient les valeurs initiales affichées dans le champ de motif

     Set myPatternField = oDlg.CreatePatternField("PatternField1", Array(20, 20, 60, 15), EditMask := "NNLNNLLLLL", LiteralMask := "__.__.2002")
   

     myPatternField = dlg.CreatePatternField('PatternField1', (20, 20, 60, 15), EditMask = 'NNLNNLLLLL', LiteralMask = '__.__.2002')
   

CreateProgressBar

Créez un nouveau contrôle de type ProgressBar dans la boîte de dialogue actuelle.

svc.CreateProgressBar(ControlName: str, opt Place: any, Border: str = "3D", MinValue: num = 0, MaxValue: num = 100): svc

Border: "3D" (par défaut) ou "FLAT" ou "NONE"

MinValue : la plus petite valeur pouvant être saisie dans le contrôle. Par défaut = 0

MaxValue : la plus grande valeur pouvant être saisie dans le contrôle. Par défaut = 100

     Set myProgressBar = oDlg.CreateProgressBar("ProgressBar1", Array(20, 20, 60, 15), MaxValue := 1000)
   

     myProgressBar = dlg.CreateProgressBar('ProgressBar1', (20, 20, 60, 15), MaxValue = 1000)
   

CreateRadioButton

Créez un nouveau contrôle de type RadioButton dans la boîte de dialogue actuelle.

svc.CreateRadioButton(ControlName: str, Place: any, MultiLine: bool = False): svc

Multiline : lorsque True (par défaut = False), la légende peut être affichée sur plusieurs lignes.

     Set myRadioButton = oDlg.CreateRadioButton("RadioButton1", Array(20, 20, 60, 15), MultiLine := True)
   

     myRadioButton = dlg.CreateRadioButton('RadioButton1', (20, 20, 60, 15), MultiLine = True)
   

CreateScrollBar

Créez un nouveau contrôle de type ScrollBar dans la boîte de dialogue actuelle.

svc.CreateScrollBar(ControlName: str, Place, Orientation: str, Border: str = "3D", MinValue: num = 0, MaxValue: num = 100): svc

Orientation: "H[orizontal]" ou "V[ertical]".

Border: "3D" (par défaut) ou "FLAT" ou "NONE"

MinValue : la plus petite valeur pouvant être saisie dans le contrôle. Par défaut = 0

MaxValue : la plus grande valeur pouvant être saisie dans le contrôle. Par défaut = 100

     Set myScrollBar = oDlg.CreateScrollBar("ScrollBar1", Array(20, 20, 60, 15), MaxValue := 1000)
   

     myScrollBar = dialog.CreateScrollBar('ScrollBar1', (20, 20, 60, 15), MaxValue = 1000)
   

CreateTableControl

Créez un nouveau contrôle de type TableControl dans la boîte de dialogue actuelle.

svc.CreateTableControl(ControlName: str, Place: any, Border: str = "3D", RowHeaders: bool = True, ColumnHeaders: bool = True, ScrollBars: str = "N", GridLines: bool = False): svc

Border: "3D" (par défaut) ou "FLAT" ou "NONE"

RowHeaders : lorsque True (par défaut), les en-têtes de ligne sont affichés

ColumnHeaders : lorsque True (par défaut), les en-têtes de colonnes sont affichés

ScrollBars: H[orizontal] ou V[ertical] ou B[oth] ou N[one] (par défaut). Les barres de défilement apparaissent dynamiquement lorsqu'elles sont nécessaires.

GridLines : lorsque True (par défaut = False), des lignes horizontales et verticales sont dessinées entre les cellules de la grille

     Set myTableControl = oDlg.CreateTableControl("TableControl1", Array(20, 20, 60, 15), ScrollBars := "B")
   

     myTableControl = dlg.CreateTableControl('TableControl1', (20, 20, 60, 15), ScrollBars = 'B')
   

CreateTextField

Créez un nouveau contrôle de type TextField dans la boîte de dialogue actuelle.

svc.CreateTextField(ControlName: str, Place: any, Border: str = "3D", MultiLine: bool = False, MaximumLength: num = 0, PasswordCharacter: str = ""): svc

Border: "3D" (par défaut) ou "FLAT" ou "NONE"

Multiline : lorsque True (par défaut = False), la légende peut être affichée sur plusieurs lignes.

MaximumLength : le nombre maximum de caractères (par défaut = 0 signifiant illimité)

PasswordCharacter : un seul caractère spécifiant l'écho d'un champ de texte de mot de passe (par défaut = "")

Set myTextField = oDlg.CreateTextField("TextField1", Array(20, 20, 120, 50), MultiLine := True)
   

     myTextField = dlg.CreateTextField('TextField1', (20, 20, 120, 50), MultiLine = True)
   

CreateTimeField

Créez un nouveau contrôle de type TimeField dans la boîte de dialogue actuelle.

svc.CreateTimeField(ControlName: str, Place: any, Border: str = "3D", MinTime: num = 0, MaxTime: num = 24): svc

Border: "3D" (par défaut) ou "FLAT" ou "NONE"

MinTime : la plus petite valeur d'heure pouvant être saisie dans le contrôle. Par défaut = 0

MaxTime : la plus grande valeur d'heure pouvant être saisie dans le contrôle. Par défaut = 24h

     Set myTimeField = oDlg.CreateTimeField("TimeField1", Array(20, 20, 60, 15))
   

     myTimeField = dlog.CreateTimeField('TimeField1', (20, 20, 60, 15))
   

CreateTreeControl

Créez un nouveau contrôle de type TreeControl dans la boîte de dialogue actuelle.

svc.CreateTreeControl(ControlName: str, Place: any, Border = "3D"): svc

Border: "3D" (par défaut) ou "FLAT" ou "NONE"

     Set myTreeControl = oDlg.CreateTreeControl("TreeControl1", Array(20, 20, 60, 15))
   

     myTreeControl = dlg.CreateTreeControl('TreeControl1', (20, 20, 60, 15))
   

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.

svc.EndExecute(returnvalue: int)

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

      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
   

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

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.

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

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

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 :

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.

svc.GetTextsFromL10N(l10n: svc): bool

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

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

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

     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.

OrderTabs

Définissez l’index de tabulation d’une série de contrôles. La séquence de contrôles est donnée sous forme d’une matrice de noms de contrôle du premier au dernier.

Les contrôles avec un index >= 1 ne sont pas accessibles avec la touche TAB si :
- ils sont omis de la liste donnée
- leur type est FixedLine, GroupBox ou ProgressBar
- ils sont désactivés

svc.TabsList(TabsList: num, Start: num = 1, Increment: num = 1): bool

TabsList : une matrice de noms de contrôles valides dans l'ordre de tabulation

Start : l'index de tabulation à affecter au 1er contrôle de la liste. Par défaut = 1

Increment : la différence entre 2 index de tabulation successifs. Par défaut = 1

True en cas de succès.

     oDlg.OrderTabs(Array("myListBox", "myTextField", "myNumericField"), Start := 10)
   

     dlg.OrderTabs(('myListBox', 'myTextField', 'myNumericField'), Start = 10)
   

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 unités AppFont. Sans arguments, la méthode réinitialise les dimensions initiales. Renvoie True si le redimensionnement a réussi.

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

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 manquants restent inchangés

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

     dlg.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 : définit un ensemble de boutons, chacun correspondant à une page de boîte de dialogue. Cela peut être utilisé pour émuler une interface à onglets en plaçant des boutons côte à côte dans la boîte de dialogue.

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

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

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.

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.

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

    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.

svc.Terminate(): bool

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 :

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

     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.