wizards/source/scriptforge/SF_UI.xba | 304 ++++++++++++++++++++++ wizards/source/scriptforge/python/scriptforge.py | 12 wizards/source/scriptforge/python/scriptforge.pyi | 36 ++ 3 files changed, 350 insertions(+), 2 deletions(-)
New commits: commit 6f5a59a79b59d20af23f2c0ad6d9b47b2f30a31a Author: Jean-Pierre Ledure <[email protected]> AuthorDate: Wed Feb 11 17:41:23 2026 +0100 Commit: Jean-Pierre Ledure <[email protected]> CommitDate: Thu Feb 12 10:01:37 2026 +0100 ScriptForge (UI) new EnterValue() method The ui.EnterValue(...) method displays a typed input box to the user and returns the entered value as a scalar of the requested type, or Empty/None when the user cancels the box. => A single statement to interact with the user through a complex dialog box e.g. a listbox field of allowed values. The box is centered on the active window. The arguments (all are optional) : prompt: the message appearing above the input field Escape chars ( ) are interpreted correctly valuetype: determines the type of the input field and of the returned value, either STRING, PASSWORD -> str BOOL, INTEGER, FLOAT -> bool, int, float DATE, TIME, DATETIME -> datetime COMBO, LIST, RADIO -> str default: the initial value title: the header of the dialog choices: the list of valid values (COMBO, LIST and RADIO only) format: the format of numeric and date values Example (Python): destination = ui.EnterValue(("What is your next destination ?", "LIST", choices = ("Belgium", "Brazil", "France", "Mexico"), default = "France", title = "This text is in the titlebar") The box is sized based on the arguments. The function is available both in Basic and Python user scripts. The user documentation should be adapted accordingly. Change-Id: I7c3f02f597ba5990c5f5a8548fb4f07699cda358 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/199194 Reviewed-by: Jean-Pierre Ledure <[email protected]> Tested-by: Jenkins diff --git a/wizards/source/scriptforge/SF_UI.xba b/wizards/source/scriptforge/SF_UI.xba index 656cc9553551..3ff5c5b56b39 100644 --- a/wizards/source/scriptforge/SF_UI.xba +++ b/wizards/source/scriptforge/SF_UI.xba @@ -490,6 +490,309 @@ Catch: GoTo Finally End Function ' ScriptForge.SF_UI.Documents +REM ----------------------------------------------------------------------------- +Public Function EnterValue(Optional ByRef Prompt As Variant _ + , Optional ByVal ValueType As Variant _ + , Optional ByVal Default As Variant _ + , Optional ByVal Title As Variant _ + , Optional ByRef Choices As Variant _ + , Optional ByVal Format As Variant _ + ) As Variant +''' Displays a typed input box and returns the value entered by the user +''' Args: Irrelevant arguments are ignored +''' Prompt: the message appearing above the input field. Default = the zero-length string +''' Use of and escape characters is allowed. +''' ValueType: one of next values: +''' BOOL: to display a checkbox +''' STRING: (default) the dialog will look like an InputBox +''' PASSWORD: idem STRING but the input string is not readable +''' LIST, COMBO, RADIO: to display a list- of alternative potential choices +''' INTEGER, FLOAT: to get a numeric value +''' DATE, TIME, DATETIME: to let the user choose a date, an hour or both +''' Default: the value displayed at box appearance and having the expected type. +''' Title: the text appearing at the top of the box +''' Choices: the list of possible values (LIST, COMBO and RADIO only), as an array/tuple +''' Format: the format in which to display dates, times or numeric values +''' Depends on the platform.FormatLocale +''' Returns: +''' A scalar of the given type, as entered by the user. +''' Returns Empty when the user cancelled the input box. +''' Examples: +''' bool = ui.EnterValue("Do you prefer to leave ?", "BOOL", True) +''' destination = ui.EnterValue("What is your next destination ?", "LIST", _ +''' Choices := Array("Belgium, "Brazil", "France", "Mexico"), _ +''' Default := "France", _ +''' Title := "This is in the titlebar") + +Dim vEnterValue As Variant ' Return value +Dim oDialog As Object ' A SFDialogs.SF_Dialog class instance +Dim oControl As Object ' A SFDialogs.SF_DialogControl class instance +Dim oTime As Object ' An alternative SFDialogs.SF_DialogControl class instance to represent a TimeField +Dim oButton As Object ' A button SFDialogs.SF_DialogControl class instance +Dim iExecute As Integer ' dialog.Execute() return value + +Dim vPrompt As Variant ' Array of prompt rows +Dim sPrompt As String ' A single prompt row +Dim lPromptHeight As Long ' Height of prompt (all lengths in MAP APPFONT units) +Dim lPromptWidth As Long ' Width of prompt + +Dim lControlY As Long ' Vertical ordinate of control +Dim lControlHeight As Long ' Height of control +Dim lControlWidth As Long ' Width of control +Dim sItem As String ' A single item in Default() +Dim lItemLength As Long ' Length of an item in Default() + +Dim lDialogWidth As Long ' Width of dialog +Dim lDialogHeight As Long ' Height of dialog + +Dim oStr As Object : Set oStr = CreateScriptService("String") +Dim i As Long + +Const LEFTMARGIN = 10 _ + , TOPMARGIN = 10 _ + , RIGHTMARGIN = 10 _ + , BOTTOMMARGIN = 10 +Const INTERVAL = 3 +' One Map AppFont unit is equal to one eighth of the average character (Systemfont) height and one quarter of the average character width. +Const TEXTHEIGHT = 8, TEXTWIDTH = 4, TEXTOFFSET = 2, MAXTEXTLENGTH = 70 +Const NUMERICWIDTH = 150, CHECKBOXWIDTH = 8, DATEWIDTH = 50, TIMEWIDTH = 50 +Const TABSIZE = 4 +Const LISTWIDTH = 20, MAXLISTCOUNT = 8 +Const GROUPBOXMARGIN = 2 +Const BUTTONWIDTH = 40, BUTTONHEIGHT = 10 + +Const cstThisSub = "UI.EnterValue" +Const cstSubArgs = "Prompt, ValueType=""BOOL""|""STRING""|""LIST""|""COMBO""|""RADIO""" _ + & "|""INTEGER""|""FLOAT""|""PASSWORD""|""DATE""|""TIME""|""DATETIME""" _ + & ", [Default], [Title], [Choices], [Format]" + + If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch + vEnterValue = Empty + +Check: + If IsMissing(Prompt) Or IsEmpty(Prompt) Then Prompt = "" + If IsMissing(ValueType) Or IsEmpty(ValueType) Then ValueType = "STRING" + If IsMissing(Default) Or IsEmpty(Default) Then Default = "" + If IsMissing(Choices) Or IsEmpty(Choices) Then Choices = Array() + If IsMissing(Title) Or IsEmpty(Title) Then Title = "" + If IsMissing(Format) Or IsEmpty(Format) Then Format = "" + If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then + If Not SF_Utils._Validate(Prompt, "Prompt", V_STRING) Then GoTo Finally + If Not SF_Utils._Validate(ValueType, "ValueType", V_STRING, _ + Split("BOOL,STRING,LIST,COMBO,RADIO,INTEGER,FLOAT,PASSWORD,DATE,TIME,DATETIME,", ",") _ + ) Then GoTo Finally + If Len(ValueType) = 0 Then ValueType = "STRING" + If Not SF_Utils._Validate(Default, "Default", Array(V_STRING, V_NUMERIC, V_DATE, V_BOOLEAN)) Then GoTo Finally + If Not SF_Utils._ValidateArray(Choices, "Choices", 1, V_STRING, True) Then GoTo Finally + If Not SF_Utils._Validate(Title, "Title", V_STRING) Then GoTo Finally + If Not SF_Utils._Validate(Format, "Format", V_STRING) Then GoTo Finally + End If + +Try: + lDialogWidth = 0 + lDialogHeight = 0 + + ' Compute prompt size + vPrompt = oStr.Wrap(Prompt, MAXTEXTLENGTH, TabSize := TABSIZE) + lPromptWidth = 0 + For Each sPrompt in vPrompt + If lPromptWidth < Len(sPrompt) Then lPromptWidth = Len(sPrompt) + Next sPrompt + lPromptWidth = lPromptWidth * TEXTWIDTH + If lPromptWidth > lDialogWidth Then lDialogWidth = lPromptWidth + lPromptHeight = ((UBound(vPrompt) + 1) * (TEXTHEIGHT + TEXTOFFSET)) - TEXTOFFSET + + ' Compute dialog control size + lControlHeight = TEXTHEIGHT + Select Case UCase(ValueType) + Case "STRING", "PASSWORD" + lControlWidth = TEXTWIDTH * MAXTEXTLENGTH + Case "BOOL" + lControlHeight = lPromptHeight + Case "INTEGER", "FLOAT" + lControlWidth = NUMERICWIDTH + Case "DATE" + lControlWidth = DATEWIDTH + Case "TIME" + lControlWidth = TIMEWIDTH + Case "DATETIME" + lControlWidth = DATEWIDTH + TEXTOFFSET + TIMEWIDTH + Case "COMBO", "LIST", "RADIO" + lControlWidth = LISTWIDTH + lItemLength = 0 + For Each sItem in Choices() + If Len(sItem) > lItemLength Then lItemLength = Len(sItem) + Next sItem + lControlWidth = lControlWidth + lItemLength * TEXTWIDTH + If UCase(ValueType) = "LIST" Then + lControlHeight = ((TEXTHEIGHT + TEXTOFFSET) _ + * Iif(UBound(Choices) > MAXLISTCOUNT - 1, MAXLISTCOUNT, UBound(Choices) + 1)) _ + - TEXTOFFSET + ElseIf UCase(ValueType) = "RADIO" Then + lControlHeight = (TEXTHEIGHT + TEXTOFFSET) * (UBound(Choices) + 1) - TEXTOFFSET + End If + End Select + If lControlWidth > lDialogWidth Then lDialogWidth = lControlWidth + + ' Setup of dialog + lDialogHeight = TOPMARGIN + Iif(UCase(ValueType) = "BOOL", 0, lPromptHeight + INTERVAL) + lControlHeight + Set oDialog = CreateScriptService("SFDialogs.NewDialog", "EnterValue" _ + , Array(0, 0, LEFTMARGIN + lDialogWidth + RIGHTMARGIN, TOPMARGIN + lDialogHeight + BUTTONHEIGHT + BOTTOMMARGIN) _ + ) + With oDialog + If Len(Title) > 0 Then .Caption = Title + Select Case UCase(ValueType) + Case "BOOL" + ' Prompt is set at input control level + Case Else + Set oControl = .CreateFixedText("Prompt" _ + , Place := Array(LEFTMARGIN, TOPMARGIN, lPromptWidth, lPromptHeight) _ + , MultiLine := ( UBound(vPrompt) > 0 ) _ + ) + oControl.Caption = Join(vPrompt, "") + End Select + End With + + ' Setup of enabled control(s) + lControlY = TOPMARGIN + lPromptHeight + INTERVAL + Select Case UCase(ValueType) + Case "STRING", "PASSWORD" + Set oControl = oDialog.CreateTextField("InputField" _ + , Place := Array(LEFTMARGIN, lControlY, lControlWidth, TEXTHEIGHT) _ + , MultiLine := False _ + , PasswordCharacter := Iif(UCase(ValueType) = "PASSWORD", "*", "")) + If VarType(Default) = V_STRING Then oControl.Value = Default + Case "INTEGER", "FLOAT" + Set oControl = oDialog.CreateFormattedField("InputField" _ + , Place := Array(LEFTMARGIN, lControlY, lControlWidth, TEXTHEIGHT) _ + , SpinButton := ( UCase(ValueType) = "INTEGER" )) + If Len(Format) > 0 Then oControl.Format = Format + If SF_Utils._VarTypeExt(Default) = V_NUMERIC Then oControl.Value = Default + Case "BOOL" + Set oControl = oDialog.CreateCheckBox("InputField" _ + , Place := Array(LEFTMARGIN, TOPMARGIN, lPROMPTWidth + CHECKBOXWIDTH, lPromptHeight) _ + , MultiLine := ( UBound(vPrompt) > 0 ) _ + ) + oControl.Caption = Join(vPrompt, "") + oControl.TripleState = False + If VarType(Default) = V_BOOLEAN Then oControl.Value = Default + Case "DATE" + Set oControl = oDialog.CreateDateField("InputField" _ + , Place := Array(LEFTMARGIN, lControlY, lControlWidth, TEXTHEIGHT) _ + , DropDown := True _ + ) + If VarType(Default) = V_DATE Then oControl.Value = Default + Case "TIME" + Set oControl = oDialog.CreateTimeField("InputField" _ + , Place := Array(LEFTMARGIN, lControlY, lControlWidth, TEXTHEIGHT) _ + ) + oControl.Format = "24h long" ' Include seconds + If VarType(Default) = V_DATE Then oControl.Value = Default + Case "DATETIME" + Set oControl = oDialog.CreateDateField("InputField" _ + , Place := Array(LEFTMARGIN, lControlY, DATEWIDTH, TEXTHEIGHT) _ + , DropDown := True _ + ) + If VarType(Default) = V_DATE Then oControl.Value = DateSerial(Year(Default), Month(Default), Day(Default)) + Set oTime = oDialog.CreateTimeField("TimeField" _ + , Place := Array(LEFTMARGIN + DATEWIDTH + TEXTOFFSET, lControlY, TIMEWIDTH, TEXTHEIGHT) _ + ) + oTime.Format = "24h long" ' Include seconds + If VarType(Default) = V_DATE Then oTime.Value = TimeSerial(Hour(Default), Minute(Default), Second(Default)) + Case "COMBO" + Set oControl = oDialog.CreateComboBox("InputField" _ + , Place := Array(LEFTMARGIN, lControlY, lControlWidth, TEXTHEIGHT) _ + , DropDown := True _ + , LineCount := Iif(UBound(Choices) > MAXLISTCOUNT - 1, MAXLISTCOUNT, UBound(Choices) + 1) _ + ) + oControl.RowSource = Choices + If Len(Default) > 0 Then + oControl.Value = Default + ElseIf UBound(Choices) >= 0 Then + oControl.Value = Choices(0) + End If + Case "LIST" + Set oControl = oDialog.CreateListBox("InputField" _ + , Place := Array(LEFTMARGIN, lControlY, lControlWidth, lControlHeight) _ + , DropDown := False _ + , LineCount := Iif(UBound(Choices) > MAXLISTCOUNT - 1, MAXLISTCOUNT, UBound(Choices) + 1) _ + , MultiSelect := False _ + ) + oControl.RowSource = Choices + If Len(Default) > 0 Then + oControl.Value = Default + ElseIf UBound(Choices) >= 0 Then + oControl.Value = Choices(0) + End If + Case "RADIO" + For i = 0 To UBound(Choices) + Set oControl = oDialog.CreateRadioButton("InputField" & Right("0" & i, 2) _ + , Place := Array(LEFTMARGIN, lControlY + i * (TEXTHEIGHT + TEXTOFFSET), lControlWidth, TEXTHEIGHT) _ + , MultiLine := False _ + ) + oControl.Caption = Choices(i) + If Len(Default) > 0 Then oControl.Value = ( Default = Choices(i) ) Else oControl.Value = ( i = 0 ) + Next i + oDialog.CreateGroupBox("GroupBox" _ + , Place := Array(LEFTMARGIN - GROUPBOXMARGIN, lControlY - GROUPBOXMARGIN _ + , lControlWidth + (2 * GROUPBOXMARGIN), oControl.Y + TEXTHEIGHT + (2 * GROUPBOXMARGIN) - lControlY) _ + ) + Case Else + End Select + + ' Define the Cancel and OK buttons + With oDialog + Set oButton = .CreateButton("CancelButton" _ + , Place := Array(.Width - RIGHTMARGIN - BUTTONWIDTH, .Height - BOTTOMMARGIN - BUTTONHEIGHT _ + , BUTTONWIDTH, BUTTONHEIGHT) _ + , Push := "CANCEL" _ + ) + Set oButton = .CreateButton("OKButton" _ + , Place := Array(oButton.X - BUTTONWIDTH - INTERVAL, oButton.Y, BUTTONWIDTH, BUTTONHEIGHT) _ + , Push := "OK" _ + ) + oButton.Default = True + End With + + ' Run the dialog + oControl.SetFocus() + oDialog.Center() + iExecute = oDialog.Execute(Modal := True) + If iExecute = oDialog.OKBUTTON Then + Select Case UCase(ValueType) + Case "STRING", "PASSWORD", "DATE", "TIME", "COMBO", "LIST" + vEnterValue = oControl.Value + Case "INTEGER" + vEnterValue = CLng(oControl.Value) + Case "FLOAT" + vEnterValue = CDbl(oControl.Value) + Case "BOOL" + vEnterValue = CBool(oControl.Value) + Case "DATETIME" + vEnterValue = CDate(oControl.Value + oTime.Value) + Case "RADIO" + For i = 0 To UBound(Choices) + Set oControl = oDialog.Controls("InputField" & Right("0" & i, 2)) + If oControl.Value = True Then + vEnterValue = Choices(i) + Exit For + End If + Next i + Case Else + End Select + End If + + oControl.Dispose() + oDialog.Terminate() + +Finally: + EnterValue = vEnterValue + SF_Utils._ExitFunction(cstThisSub) + Exit Function +Catch: + GoTo Finally +End Function ' ScriptForge.SF_UI.EnterValue + REM ----------------------------------------------------------------------------- Public Function GetDocument(Optional ByVal WindowName As Variant) As Variant ''' Returns a SFDocuments.Document object referring to the active window or the given window @@ -694,6 +997,7 @@ Public Function Methods() As Variant , "CreateBaseDocument" _ , "CreateDocument" _ , "Documents" _ + , "EnterValue" _ , "GetDocument" _ , "Maximize" _ , "Minimize" _ diff --git a/wizards/source/scriptforge/python/scriptforge.py b/wizards/source/scriptforge/python/scriptforge.py index 679ffa86704e..606361bcb914 100644 --- a/wizards/source/scriptforge/python/scriptforge.py +++ b/wizards/source/scriptforge/python/scriptforge.py @@ -762,11 +762,14 @@ class SFScriptForge: if 1900 <= unodate.Year <= datetime.MAXYEAR: date = datetime.datetime(unodate.Year, unodate.Month, unodate.Day, unodate.Hours, unodate.Minutes, unodate.Seconds, int(unodate.NanoSeconds / 1000)) + elif unodate.Year == 1899: # The date has not been set + date = datetime.time(unodate.Hours, unodate.Minutes, unodate.Seconds, + int(unodate.NanoSeconds / 1000)) elif 'com.sun.star.util.Date' in datetype: if 1900 <= unodate.Year <= datetime.MAXYEAR: date = datetime.datetime(unodate.Year, unodate.Month, unodate.Day) elif 'com.sun.star.util.Time' in datetype: - date = datetime.datetime(unodate.Hours, unodate.Minutes, unodate.Seconds, + date = datetime.time(unodate.Hours, unodate.Minutes, unodate.Seconds, int(unodate.NanoSeconds / 1000)) else: return unodate # Not recognized as a UNO date structure @@ -1812,6 +1815,13 @@ class SFScriptForge: def Documents(self): return self.ExecMethod(self.vbMethod + self.flgArrayRet, 'Documents') + def EnterValue(self, prompt = '', valuetype = 'STRING', default = '', title = '', choices = (), format = ''): + if isinstance(default, (datetime.datetime, datetime.time)): + default = SFScriptForge.SF_Basic.CDateToUnoDateTime(default) + flag = self.flgDateArg + self.flgDateRet if valuetype.upper() in ('DATE', 'TIME', 'DATETIME') else 0 + return self.ExecMethod(self.vbMethod + flag, 'EnterValue', prompt, valuetype, default, title, + choices, format) + def GetDocument(self, windowname = ''): return self.ExecMethod(self.vbMethod, 'GetDocument', windowname) diff --git a/wizards/source/scriptforge/python/scriptforge.pyi b/wizards/source/scriptforge/python/scriptforge.pyi index e5cadedc8677..ab3c504259e5 100644 --- a/wizards/source/scriptforge/python/scriptforge.pyi +++ b/wizards/source/scriptforge/python/scriptforge.pyi @@ -2564,6 +2564,41 @@ class SFScriptForge: """ ... + def EnterValue(self, + prompt: str = ..., + valuetype: Literal['', 'STRING', 'PASSWORD', 'BOOL', 'INTEGER', 'FLOAT', + 'DATE', 'TIME', 'DATETIME', 'COMBO', 'LIST', 'RADIO'] = ..., + default: str | bool | int | float | datetime.datetime = ..., + title: str = ..., + choices: tuple[str, ...] = ..., + format: str = ..., + ) -> str | bool | int | float | datetime.datetime: + r""" + Displays a typed input box and returns the value entered by the user. + Args + ``prompt``: the message appearing above the input field. Defaults to the zero-length string. + The use of \n and \t escape characters is allowed. + + ``valuetype``: determines the type of the expected value, either string, boolean, integer, + float or date. It also determines the type of dialog control to display to the user. E.g. a + checkbox for a boolean or a date field for a date. When 'PASSWORD', the entered characters are + echoed as '*'. + + ``default``: the value displayed at box appearance. It must have the expected type. + + ``title``: the text appearing at the top of the box. + + ``choices``: the list of possible values (for ``valuetype`` = LIST, COMBO and RADIO only), + as a tuple of strings. + + ``format``: the format in which to display and enter dates, times or numeric values. + It is relative to the ``platform.FormatLocale`` property. + Returns + A scalar of the given type, as entered by the user. + ``None`` when the user cancelled the dialog. + """ + ... + def GetDocument( self, windowname: str | XComponent | XOfficeDatabaseDocument = ... @@ -2576,7 +2611,6 @@ class SFScriptForge: or ``XOfficeDatabaseDocument``. Returns A ``Document`` object or one of its subclasses. - """ ...
