Repository.mk | 1
desktop/CppunitTest_desktop_lib.mk | 1
scp2/source/ooo/directory_ooo.scp | 5
wizards/Module_wizards.mk | 1
wizards/Package_sfwidgets.mk | 30
wizards/source/configshare/dialog.xlc | 1
wizards/source/configshare/script.xlc | 1
wizards/source/scriptforge/SF_Services.xba | 1
wizards/source/scriptforge/python/scriptforge.py | 48 +
wizards/source/sfwidgets/SF_PopupMenu.xba | 755 +++++++++++++++++++++++
wizards/source/sfwidgets/SF_Register.xba | 127 +++
wizards/source/sfwidgets/__License.xba | 26
wizards/source/sfwidgets/dialog.xlb | 3
wizards/source/sfwidgets/script.xlb | 7
14 files changed, 1007 insertions(+)
New commits:
commit 78db0dcfb6f5a8d5baa2daae7e17733d4c7c0a0c
Author: Jean-Pierre Ledure <j...@ledure.be>
AuthorDate: Fri Oct 15 13:53:05 2021 +0200
Commit: Jean-Pierre Ledure <j...@ledure.be>
CommitDate: Fri Oct 15 16:39:48 2021 +0200
ScriptForge - new SFWidgets library, new PopupMenu service
The SFWidgets library is intended to host the Toolbar,
ToolbarControl (both future) and PopupMenu services.
A popup menu is usually triggered by a mouse action
(typically a right-click) on a dialog, a form, or one of their controls.
In these cases the menu will be displayed below the clicked area.
When triggered by other events, including in the normal flow
of a user script, the script should provide the coordinates
of the topleft edge of the menu versus the actual component.
The menu is described from top to bottom with next methods:
AddItem()
AddCheckBox()
AddRadioButton()
Example:
.AddCheckBox("View>Toolbars>Dialog")
.AddCheckBox("View>Toolbars>Find", Status := True)
.AddCheckBox("View>Status Bar", Status := True)
.AddItem("View>Full Screen", Name := "FULLSCREEN")
The SubmenuCharacter (Default = ">") is modifiable.
Each menu item receives a numeric and a string identifier.
The execute() method returns the item selected by the user.
The service is available both from Basic and Python user scripts.
The commit includes the review of build files to include
the new library and the new modules.
Change-Id: I2940be25313cc8fff7b337766edd348b04a20584
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/123654
Tested-by: Jean-Pierre Ledure <j...@ledure.be>
Tested-by: Jenkins
Reviewed-by: Jean-Pierre Ledure <j...@ledure.be>
diff --git a/Repository.mk b/Repository.mk
index 541d06377fb6..f2cebecb278d 100644
--- a/Repository.mk
+++ b/Repository.mk
@@ -939,6 +939,7 @@ $(eval $(call gb_Helper_register_packages_for_install,ooo,\
wizards_basicsrvsfdatabases \
wizards_basicsrvsfdialogs \
wizards_basicsrvsfdocuments \
+ wizards_basicsrvsfwidgets \
wizards_basicsrvstandard \
wizards_basicsrvtemplate \
wizards_basicsrvtools \
diff --git a/desktop/CppunitTest_desktop_lib.mk
b/desktop/CppunitTest_desktop_lib.mk
index 4e5ff292102b..61d5cb1f31c5 100644
--- a/desktop/CppunitTest_desktop_lib.mk
+++ b/desktop/CppunitTest_desktop_lib.mk
@@ -75,6 +75,7 @@ $(eval $(call gb_CppunitTest_use_packages,desktop_lib, \
wizards_basicsrvsfdatabases \
wizards_basicsrvsfdialogs \
wizards_basicsrvsfdocuments \
+ wizards_basicsrvsfwidgets \
wizards_basicsrvtemplate \
wizards_basicsrvtools \
))
diff --git a/scp2/source/ooo/directory_ooo.scp
b/scp2/source/ooo/directory_ooo.scp
index 1b8243e74979..66c895575a7f 100644
--- a/scp2/source/ooo/directory_ooo.scp
+++ b/scp2/source/ooo/directory_ooo.scp
@@ -285,6 +285,11 @@ Directory gid_Dir_Basic_SFDocuments
DosName = "SFDocuments";
End
+Directory gid_Dir_Basic_SFWidgets
+ ParentID = gid_Dir_Basic;
+ DosName = "SFWidgets";
+End
+
Directory gid_Dir_Basic_Importwiz
ParentID = gid_Dir_Basic;
DosName = "ImportWizard";
diff --git a/wizards/Module_wizards.mk b/wizards/Module_wizards.mk
index 003a60b9d0fe..14757e57bb10 100644
--- a/wizards/Module_wizards.mk
+++ b/wizards/Module_wizards.mk
@@ -33,6 +33,7 @@ $(eval $(call gb_Module_add_targets,wizards,\
Package_sfdatabases \
Package_sfdialogs \
Package_sfdocuments \
+ Package_sfwidgets \
Package_standard \
Package_template \
Package_tools \
diff --git a/wizards/Package_sfwidgets.mk b/wizards/Package_sfwidgets.mk
new file mode 100644
index 000000000000..f89b83e58d5b
--- /dev/null
+++ b/wizards/Package_sfwidgets.mk
@@ -0,0 +1,30 @@
+# -*- Mode: makefile-gmake; tab-width: 4; indent-tabs-mode: t -*-
+#
+# This file is part of the LibreOffice project.
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+#
+# This file incorporates work covered by the following license notice:
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed
+# with this work for additional information regarding copyright
+# ownership. The ASF licenses this file to you under the Apache
+# License, Version 2.0 (the "License"); you may not use this file
+# except in compliance with the License. You may obtain a copy of
+# the License at http://www.apache.org/licenses/LICENSE-2.0 .
+#
+
+$(eval $(call
gb_Package_Package,wizards_basicsrvsfwidgets,$(SRCDIR)/wizards/source/sfwidgets))
+
+$(eval $(call
gb_Package_add_files,wizards_basicsrvsfwidgets,$(LIBO_SHARE_FOLDER)/basic/SFWidgets,\
+ SF_PopupMenu.xba \
+ SF_Register.xba \
+ __License.xba \
+ dialog.xlb \
+ script.xlb \
+))
+
+# vim: set noet sw=4 ts=4:
diff --git a/wizards/source/configshare/dialog.xlc
b/wizards/source/configshare/dialog.xlc
index 4e3a29ae3398..8db62f073800 100644
--- a/wizards/source/configshare/dialog.xlc
+++ b/wizards/source/configshare/dialog.xlc
@@ -14,4 +14,5 @@
<library:library library:name="SFDatabases"
xlink:href="$(INST)/@LIBO_SHARE_FOLDER@/basic/SFDatabases/dialog.xlb/"
xlink:type="simple" library:link="true" library:readonly="false"/>
<library:library library:name="SFDialogs"
xlink:href="$(INST)/@LIBO_SHARE_FOLDER@/basic/SFDialogs/dialog.xlb/"
xlink:type="simple" library:link="true" library:readonly="false"/>
<library:library library:name="SFDocuments"
xlink:href="$(INST)/@LIBO_SHARE_FOLDER@/basic/SFDocuments/dialog.xlb/"
xlink:type="simple" library:link="true" library:readonly="false"/>
+ <library:library library:name="SFWidgets"
xlink:href="$(INST)/@LIBO_SHARE_FOLDER@/basic/SFWidgets/dialog.xlb/"
xlink:type="simple" library:link="true" library:readonly="false"/>
</library:libraries>
diff --git a/wizards/source/configshare/script.xlc
b/wizards/source/configshare/script.xlc
index 06a4cc20145e..d1de5ea4f948 100644
--- a/wizards/source/configshare/script.xlc
+++ b/wizards/source/configshare/script.xlc
@@ -14,4 +14,5 @@
<library:library library:name="SFDatabases"
xlink:href="$(INST)/@LIBO_SHARE_FOLDER@/basic/SFDatabases/script.xlb/"
xlink:type="simple" library:link="true" library:readonly="false"/>
<library:library library:name="SFDialogs"
xlink:href="$(INST)/@LIBO_SHARE_FOLDER@/basic/SFDialogs/script.xlb/"
xlink:type="simple" library:link="true" library:readonly="false"/>
<library:library library:name="SFDocuments"
xlink:href="$(INST)/@LIBO_SHARE_FOLDER@/basic/SFDocuments/script.xlb/"
xlink:type="simple" library:link="true" library:readonly="false"/>
+ <library:library library:name="SFWidgets"
xlink:href="$(INST)/@LIBO_SHARE_FOLDER@/basic/SFWidgets/script.xlb/"
xlink:type="simple" library:link="true" library:readonly="false"/>
</library:libraries>
diff --git a/wizards/source/scriptforge/SF_Services.xba
b/wizards/source/scriptforge/SF_Services.xba
index 9533a4741b23..a5f360fa386e 100644
--- a/wizards/source/scriptforge/SF_Services.xba
+++ b/wizards/source/scriptforge/SF_Services.xba
@@ -130,6 +130,7 @@ Try:
sLibrary = "SFDocuments"
Case "dialog", "dialogevent"
: sLibrary = "SFDialogs"
Case "database"
: sLibrary = "SFDatabases"
+ Case "popupmenu"
: sLibrary = "SFWidgets"
Case Else
End Select
Else
diff --git a/wizards/source/scriptforge/python/scriptforge.py
b/wizards/source/scriptforge/python/scriptforge.py
index 29825e4ccece..7dd9c62a6da7 100644
--- a/wizards/source/scriptforge/python/scriptforge.py
+++ b/wizards/source/scriptforge/python/scriptforge.py
@@ -2181,6 +2181,54 @@ class SFDocuments:
printevenpages, printoddpages, printimages)
+#
#####################################################################################################################
+# SFWidgets CLASS (alias of SFWidgets Basic library)
###
+#
#####################################################################################################################
+class SFWidgets:
+ """
+ The SFWidgets class manages toolbars and popup menus
+ """
+ pass
+
+ # #########################################################################
+ # SF_PopupMenu CLASS
+ # #########################################################################
+ class SF_PopupMenu(SFServices):
+ """
+ Display a popup menu anywhere and any time.
+ A popup menu is usually triggered by a mouse action (typically a
right-click) on a dialog, a form
+ or one of their controls. In this case the menu will be displayed
below the clicked area.
+ When triggered by other events, including in the normal flow of a
user script, the script should
+ provide the coordinates of the topleft edge of the menu versus the
actual component.
+ The menu is described from top to bottom. Each menu item receives
a numeric and a string identifier.
+ The execute() method returns the item selected by the user.
+ """
+ # Mandatory class properties for service registration
+ serviceimplementation = 'basic'
+ servicename = 'SFWidgets.PopupMenu'
+ servicesynonyms = ('popupmenu', 'sfwidgets.popupmenu')
+ serviceproperties = dict(ShortcutCharacter = False, SubmenuCharacter =
False)
+
+ @classmethod
+ def ReviewServiceArgs(cls, event = None, x = 0, y = 0, submenuchar =
''):
+ """
+ Transform positional and keyword arguments into positional only
+ """
+ return event, x, y, submenuchar
+
+ def AddCheckBox(self, menuitem, name = '', status = False, icon = '',
tooltip = ''):
+ return self.ExecMethod(self.vbMethod, 'AddCheckBox', menuitem,
name, status, icon, tooltip)
+
+ def AddItem(self, menuitem, name = '', icon = '', tooltip = ''):
+ return self.ExecMethod(self.vbMethod, 'AddItem', menuitem, name,
icon, tooltip)
+
+ def AddRadioButton(self, menuitem, name = '', status = False, icon =
'', tooltip = ''):
+ return self.ExecMethod(self.vbMethod, 'AddRadioButton', menuitem,
name, status, icon, tooltip)
+
+ def Execute(self, returnid = True):
+ return self.ExecMethod(self.vbMethod, 'Execute', returnid)
+
+
#
##############################################False##################################################################
# CreateScriptService()
###
#
#####################################################################################################################
diff --git a/wizards/source/sfwidgets/SF_PopupMenu.xba
b/wizards/source/sfwidgets/SF_PopupMenu.xba
new file mode 100644
index 000000000000..320ac4a22ab2
--- /dev/null
+++ b/wizards/source/sfwidgets/SF_PopupMenu.xba
@@ -0,0 +1,755 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE script:module PUBLIC "-//OpenOffice.org//DTD OfficeDocument 1.0//EN"
"module.dtd">
+<script:module xmlns:script="http://openoffice.org/2000/script";
script:name="SF_PopupMenu" script:language="StarBasic"
script:moduleType="normal">REM
=======================================================================================================================
+REM === The ScriptForge library and its associated
libraries are part of the LibreOffice project. ===
+REM === The SFWidgets library
is one of the associated libraries.
===
+REM === Full documentation is available
on https://help.libreoffice.org/
===
+REM
=======================================================================================================================
+
+Option Compatible
+Option ClassModule
+
+Option Explicit
+
+'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+''' SF_PopupMenu
+''' ============
+''' Display a popup menu anywhere and any time
+'''
+''' A popup menu is usually triggered by a mouse
action (typically a right-click) on a dialog, a form
+''' or one of their controls. In this case the menu
will be displayed below the clicked area.
+''' When triggered by other events, including in
the normal flow of a user script, the script should
+''' provide the coordinates of the topleft edge of
the menu versus the actual component.
+'''
+''' The menu is described from top to bottom. Each
menu item receives a numeric and a string identifier.
+''' The execute() method returns the item selected
by the user.
+'''
+''' Menu items are either:
+''' - usual items
+''' - checkboxes
+''' - radio buttons
+''' - a menu separator
+''' Menu items can be decorated with icons and
tooltips.
+'''
+''' Definitions:
+''' SubmenuCharacter: the character or the
character string that identifies how menus are cascading
+''' Default = ">"
+''' Can be set when invocating the
PopupMenu service
+''' ShortcutCharacter: the underline access
key character
+''' Default = "~"
+'''
+''' Service invocation:
+''' Sub OpenMenu(Optional poMouseEvent As
Object)
+''' Dim myMenu As Object
+''' Set myMenu =
CreateScriptService("SFWidgets.PopupMenu", poMouseEvent, , ,
">>") ' Usual case
+''' ' or
+''' Set myMenu =
CreateScriptService("SFWidgets.PopupMenu", , X, Y, " | ")
' Use X and Y coordinates to place the menu
+'''
+''' Example 1: simulate an extract of the View menu
in the menubar of the Basic IDE
+''' Sub OpenMenu(Optional poMouseEvent As
Object)
+''' Dim myMenu As Object, vChoice As Variant
+''' Set myMenu =
CreateScriptService("SFWidgets.PopupMenu", poMouseEvent)
+''' With myMenu
+'''
.AddCheckBox("View>Toolbars>Dialog")
+'''
.AddCheckBox("View>Toolbars>Find", STatus := True)
+'''
.AddCheckBox("View>Status Bar", STatus := True)
+'''
.AddItem("View>Full Screen", Name := "FULLSCREEN")
+''' vChoice =
.Execute(False) ' When 1st checkbox is clicked, return
"Dialog"
+'''
' When last item is clicked, return
"FULLSCREEN"
+''' .Dispose()
+''' End With
+'''
+''' Example 2: jump to another sheet of a Calc
document
+''' ' Link next Sub to the
"Mouse button released" event of a form control of a Calc sheet
+''' Sub JumpToSheet(Optional poEvent As
Object)
+''' Dim myMenu As Object, sChoice As
String, myDoc As Object, vSheets As Variant, sSheet As String
+''' Set myMenu =
CreateScriptService("SFWidgets.PopupMenu", poEvent)
+''' Set myDoc =
CreateScriptService("Calc", ThisComponent)
+''' vSheets = myDoc.Sheets
+''' For Each sSheet In vSheets
+''' myMenu.AddItem(sSheet)
+''' Next sSheet
+''' sChoice = myMenu.Execute(False)
' Return sheet name, not sheet index
+''' If sChoice <>
"" Then myDoc.Activate(sChoice)
+''' myDoc.Dispose()
+''' myMenu.Dispose()
+''' End Sub
+
+'''
+''' Detailed user documentation:
+'''
https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_popupmenu.html?DbPAR=BASIC
+'''
+'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+
+REM ==================================================================
EXCEPTIONS
+
+REM ============================================================= PRIVATE
MEMBERS
+
+Private [Me] As Object
+Private ObjectType As String ' Must be
POPUPMENU
+Private ServiceName As String
+
+
+' Menu descriptors
+Private MenuTree As Variant '
Dictionary treename - XPopupMenu pair
+Private MenuIdentification As Variant ' Dictionary item
ID - item name
+Private SubmenuChar As String '
Delimiter in menu trees
+Private MenuRoot As Object '
stardiv.vcl.PopupMenu or com.sun.star.awt.XPopupMenu
+Private LastItem As Integer ' Every
item has its entry number. This is the last one
+Private Rectangle As Object '
com.sun.star.awt.Rectangle
+Private PeerWindow As Object '
com.sun.star.awt.XWindowPeer
+
+REM ============================================================ MODULE
CONSTANTS
+
+Private Const _UnderlineAccessKeyChar = "~"
+Private Const _DefaultSubmenuChar = ">"
+Private Const _SeparatorChar = "---"
+Private Const _IconsDirectory =
"private:graphicrepository/" ' Refers to <install
folder>/share/config/images_*.zip.
+Private Const cstNormal = "N"
+Private Const cstCheck = "C"
+Private Const cstRadio = "R"
+
+REM ======================================================
CONSTRUCTOR/DESTRUCTOR
+
+REM
-----------------------------------------------------------------------------
+Private Sub Class_Initialize()
+ Set [Me] = Nothing
+ ObjectType = "POPUPMENU"
+ ServiceName = "SFWidgets.PopupMenu"
+ Set MenuTree = Nothing
+ Set MenuIdentification = Nothing
+ SubmenuChar = _DefaultSubmenuChar
+ Set MenuRoot = Nothing
+ LastItem = 0
+ Set Rectangle = Nothing
+End Sub ' SFWidgets.SF_PopupMenu Constructor
+
+REM
-----------------------------------------------------------------------------
+Private Sub Class_Terminate()
+ Call Class_Initialize()
+End Sub ' SFWidgets.SF_PopupMenu Destructor
+
+REM
-----------------------------------------------------------------------------
+Public Function Dispose() As Variant
+ If Not IsNull(MenuTree) Then Set MenuTree = MenuTree.Dispose()
+ If Not IsNull(MenuIdentification) Then Set MenuIdentification =
MenuIdentification.Dispose()
+ Call Class_Terminate()
+ Set Dispose = Nothing
+End Function ' SFWidgets.SF_PopupMenu Explicit Destructor
+
+REM ==================================================================
PROPERTIES
+
+REM
-----------------------------------------------------------------------------
+Property Get ShortcutCharacter() As Variant
+''' The ShortcutCharacter property specifies character
preceding the underline access key
+ ShortcutCharacter = _PropertyGet("ShortcutCharacter")
+End Property ' SFWidgets.SF_PopupMenu.ShortcutCharacter (get)
+
+REM
-----------------------------------------------------------------------------
+Property Get SubmenuCharacter() As Variant
+''' The SubmenuCharacter property specifies the character
string indicating
+''' a sub-menu in a popup menu item
+ SubmenuCharacter = _PropertyGet("SubmenuCharacter")
+End Property ' SFWidgets.SF_PopupMenu.SubmenuCharacter (get)
+
+REM =====================================================================
METHODS
+
+REM
-----------------------------------------------------------------------------
+Public Function AddCheckBox(Optional ByVal MenuItem As Variant _
+ , Optional
ByVal Name As Variant _
+ , Optional
ByVal Status As Variant _
+ , Optional
ByVal Icon As Variant _
+ , Optional
ByVal Tooltip As Variant _
+ ) As Integer
+''' Insert in the popup menu a new entry
+''' Args:
+''' MenuItem: The text to be displayed in the menu
entry.
+''' It determines also the hierarchy of the
popup menu
+''' It is made up of all the components
(separated by the "SubmenuCharacter") of the menu branch
+''' Example: A>B>C
means "C" is a new entry in submenu "A => B
=>"
+''' If the last component is equal to the
"SeparatorCharacter", a line separator is inserted
+''' Name: The name to be returned by the Execute()
method if this item is clicked
+''' Default = the last component of MenuItem
+''' Status: when True the item is selected. Default
= False
+''' Icon: The path name of the icon to be
displayed, without leading path separator
+''' The icons are stored in one of the
<install folder>/share/config/images_*.zip files
+''' The exact file depends on the
user options about the current icon set
+''' Use the (normal) slash "/" as
path separator
+''' Example: "cmd/sc_cut.png"
+''' Tooltip: The help text to be displayed as a
tooltip
+''' Returns:
+''' The numeric identification of the newly
inserted item
+''' Examples:
+''' Dim myMenu As Object, iId As Integer
+''' Set myMenu =
CreateScriptService("SFWidgets.PopupMenu", poEvent)
+''' iId = myMenu.AddCheckBox("Menu
top>Checkbox item", Status := True)
+
+Dim iId As Integer ' Return value
+
+Const cstThisSub = "SFWidgets.PopupMenu.AddCheckBox"
+Const cstSubArgs = "MenuItem, [Name = """"], [Status
= False], [Icon = """"], [Tooltip =
""""]"
+
+ If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
+ iId = 0
+
+Check:
+ If IsMissing(Name) Or IsEmpty(Name) Then Name = ""
+ If IsMissing(Status) Or IsEmpty(Status) Then Status = False
+ If IsMissing(Icon) Or IsEmpty(Icon) Then Icon = ""
+ If IsMissing(Tooltip) Or IsEmpty(Tooltip) Then Tooltip = ""
+ If ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
+ If Not ScriptForge.SF_Utils._Validate(MenuItem,
"MenuItem", V_STRING) Then GoTo Catch
+ If Not ScriptForge.SF_Utils._Validate(Name, "Name",
V_STRING) Then GoTo Catch
+ If Not ScriptForge.SF_Utils._Validate(Status,
"Status", ScriptForge.V_BOOLEAN) Then GoTo Catch
+ If Not ScriptForge.SF_Utils._Validate(Icon, "Icon",
V_STRING) Then GoTo Catch
+ If Not ScriptForge.SF_Utils._Validate(Tooltip,
"Tooltip", V_STRING) Then GoTo Catch
+ End If
+
+Try:
+ iId = _AddItem(MenuItem, Name, cstCheck, Status, Icon, Tooltip)
+
+Finally:
+ AddCheckBox = iId
+ ScriptForge.SF_Utils._ExitFunction(cstThisSub)
+ Exit Function
+Catch:
+ GoTo Finally
+End Function ' SFWidgets.SF_PopupMenu.AddCheckBox
+
+REM
-----------------------------------------------------------------------------
+Public Function AddItem(Optional ByVal MenuItem As Variant _
+ , Optional
ByVal Name As Variant _
+ , Optional
ByVal Icon As Variant _
+ , Optional
ByVal Tooltip As Variant _
+ ) As Integer
+''' Insert in the popup menu a new entry
+''' Args:
+''' MenuItem: The text to be displayed in the menu
entry.
+''' It determines also the hierarchy of the
popup menu
+''' It is made up of all the components
(separated by the "SubmenuCharacter") of the menu branch
+''' Example: A>B>C
means "C" is a new entry in submenu "A => B
=>"
+''' If the last component is equal to the
"SeparatorCharacter", a line separator is inserted
+''' Name: The name to be returned by the Execute()
method if this item is clicked
+''' Default = the last component of MenuItem
+''' Icon: The path name of the icon to be
displayed, without leading path separator
+''' The icons are stored in one of the
<install folder>/share/config/images_*.zip files
+''' The exact file depends on the
user options about the current icon set
+''' Use the (normal) slash "/" as
path separator
+''' Example: "cmd/sc_cut.png"
+''' Tooltip: The help text to be displayed as a
tooltip
+''' Returns:
+''' The numeric identification of the newly
inserted item
+''' Examples:
+''' Dim myMenu As Object, iId As Integer
+''' Set myMenu =
CreateScriptService("SFWidgets.PopupMenu", poEvent)
+''' iId = myMenu.AddItem("Menu
top>Normal item", Icon := "cmd.sc_cut.png")
+
+Dim iId As Integer ' Return value
+
+Const cstThisSub = "SFWidgets.PopupMenu.AddItem"
+Const cstSubArgs = "MenuItem, [Name = """"], [Icon =
""""], [Tooltip = """"]"
+
+ If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
+ iId = 0
+
+Check:
+ If IsMissing(Name) Or IsEmpty(Name) Then Name = ""
+ If IsMissing(Icon) Or IsEmpty(Icon) Then Icon = ""
+ If IsMissing(Tooltip) Or IsEmpty(Tooltip) Then Tooltip = ""
+ If ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
+ If Not ScriptForge.SF_Utils._Validate(MenuItem,
"MenuItem", V_STRING) Then GoTo Catch
+ If Not ScriptForge.SF_Utils._Validate(Name, "Name",
V_STRING) Then GoTo Catch
+ If Not ScriptForge.SF_Utils._Validate(Icon, "Icon",
V_STRING) Then GoTo Catch
+ If Not ScriptForge.SF_Utils._Validate(Tooltip,
"Tooltip", V_STRING) Then GoTo Catch
+ End If
+
+Try:
+ iId = _AddItem(MenuItem, Name, cstNormal, False, Icon, Tooltip)
+
+Finally:
+ AddItem = iId
+ ScriptForge.SF_Utils._ExitFunction(cstThisSub)
+ Exit Function
+Catch:
+ GoTo Finally
+End Function ' SFWidgets.SF_PopupMenu.AddItem
+
+REM
-----------------------------------------------------------------------------
+Public Function AddRadioButton(Optional ByVal MenuItem As Variant _
+ , Optional
ByVal Name As Variant _
+ , Optional
ByVal Status As Variant _
+ , Optional
ByVal Icon As Variant _
+ , Optional
ByVal Tooltip As Variant _
+ ) As Integer
+''' Insert in the popup menu a new entry as a radio button
+''' Args:
+''' MenuItem: The text to be displayed in the menu
entry.
+''' It determines also the
hieAddCheckBoxrarchy of the popup menu
+''' It is made up of all the components
(separated by the "SubmenuCharacter") of the menu branch
+''' Example: A>B>C
means "C" is a new entry in submenu "A => B
=>"
+''' If the last component is equal to the
"SeparatorCharacter", a line separator is inserted
+''' Name: The name to be returned by the Execute()
method if this item is clicked
+''' Default = the last component of MenuItem
+''' Status: when True the item is selected. Default
= False
+''' Icon: The path name of the icon to be
displayed, without leading path separator
+''' The icons are stored in one of the
<install folder>/share/config/images_*.zip files
+''' The exact file depends on the
user options about the current icon set
+''' Use the (normal) slash "/" as
path separator
+''' Example: "cmd/sc_cut.png"
+''' Tooltip: The help text to be displayed as a
tooltip
+''' Returns:
+''' The numeric identification of the newly
inserted item
+''' Examples:
+''' Dim myMenu As Object, iId As Integer
+''' Set myMenu =
CreateScriptService("SFWidgets.PopupMenu", poEvent)
+''' iId = myMenu.AddRadioButton("Menu
top>Radio item", Status := True)
+
+Dim iId As Integer ' Return value
+
+Const cstThisSub = "SFWidgets.PopupMenu.AddRadioButton"
+Const cstSubArgs = "MenuItem, [Name = """"], [Status
= False], [Icon = """"], [Tooltip =
""""]"
+
+ If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
+ iId = 0
+
+Check:
+ If IsMissing(Name) Or IsEmpty(Name) Then Name = ""
+ If IsMissing(Status) Or IsEmpty(Status) Then Status = False
+ If IsMissing(Icon) Or IsEmpty(Icon) Then Icon = ""
+ If IsMissing(Tooltip) Or IsEmpty(Tooltip) Then Tooltip = ""
+ If ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
+ If Not ScriptForge.SF_Utils._Validate(MenuItem,
"MenuItem", V_STRING) Then GoTo Catch
+ If Not ScriptForge.SF_Utils._Validate(Name, "Name",
V_STRING) Then GoTo Catch
+ If Not ScriptForge.SF_Utils._Validate(Status,
"Status", ScriptForge.V_BOOLEAN) Then GoTo Catch
+ If Not ScriptForge.SF_Utils._Validate(Icon, "Icon",
V_STRING) Then GoTo Catch
+ If Not ScriptForge.SF_Utils._Validate(Tooltip,
"Tooltip", V_STRING) Then GoTo Catch
+ End If
+
+Try:
+ iId = _AddItem(MenuItem, Name, cstRadio, Status, Icon, Tooltip)
+
+Finally:
+ AddRadioButton = iId
+ ScriptForge.SF_Utils._ExitFunction(cstThisSub)
+ Exit Function
+Catch:
+ GoTo Finally
+End Function ' SFWidgets.SF_PopupMenu.AddRadioButton
+
+REM
-----------------------------------------------------------------------------
+Public Function Execute(Optional ByVal ReturnId As Variant) As Variant
+''' Display the popup menu and return the menu item clicked
by the user
+''' Args:
+''' ReturnId: When True (default), return the
unique ID of the clicked item, otherwise return its name
+''' Returns:
+''' The numeric identification of clicked item or
its name
+''' The returned value is 0 or ""
(depending on ReturnId) when the menu is cancelled
+''' Examples:
+''' Sub OpenMenu(Optional poMouseEvent As Object)
+''' Dim myMenu As Object, vChoice As Variant
+''' Set myMenu =
CreateScriptService("SFWidgets.PopupMenu", poMouseEvent)
+''' With myMenu
+'''
.AddCheckBox("View>Toolbars>Dialog")
+'''
.AddCheckBox("View>Toolbars>Find", STatus := True)
+''' .AddCheckBox("View>Status
Bar", STatus := True)
+''' .AddItem("View>Full
Screen", Name := "FULLSCREEN")
+''' vChoice = .Execute(False) '
When 1st checkbox is clicked, return "Dialog"
+'''
' When last item is clicked, return "FULLSCREEN"
+''' End With
+
+Dim vMenuItem As Variant ' Return value
+
+Const cstThisSub = "SFWidgets.PopupMenu.Execute"
+Const cstSubArgs = "[ReturnId = True]"
+
+ If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
+ vMenuItem = 0
+
+Check:
+ If IsMissing(ReturnId) Or IsEmpty(ReturnId) Then ReturnId = True
+ If ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
+ If Not ScriptForge.SF_Utils._Validate(ReturnId,
"ReturnId", ScriptForge.V_BOOLEAN) Then GoTo Catch
+ End If
+ If Not ReturnId Then vMenuItem = ""
+
+Try:
+ vMenuItem = MenuRoot.Execute(PeerWindow, Rectangle,
com.sun.star.awt.PopupMenuDirection.EXECUTE_DEFAULT)
+ If Not ReturnId Then vMenuItem = MenuIdentification.Item(Str(vMenuItem))
+
+Finally:
+ Execute = vMenuItem
+ ScriptForge.SF_Utils._ExitFunction(cstThisSub)
+ Exit Function
+Catch:
+ GoTo Finally
+End Function ' SFWidgets.SF_PopupMenu.Execute
+
+REM
-----------------------------------------------------------------------------
+Public Function GetProperty(Optional ByVal PropertyName As Variant) As Variant
+''' Return the actual value of the given property
+''' Args:
+''' PropertyName: the name of the property as a
string
+''' Returns:
+''' The actual value of the property
+''' If the property does not exist, returns Null
+''' Exceptions:
+''' see the exceptions of the individual properties
+''' Examples:
+''' myModel.GetProperty("MyProperty")
+
+Const cstThisSub = "SFWidgets.PopupMenu.GetProperty"
+Const cstSubArgs = ""
+
+ If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
+ GetProperty = Null
+
+Check:
+ If ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
+ If Not ScriptForge.SF_Utils._Validate(PropertyName,
"PropertyName", V_STRING, Properties()) Then GoTo Catch
+ End If
+
+Try:
+ GetProperty = _PropertyGet(PropertyName)
+
+Finally:
+ ScriptForge.SF_Utils._ExitFunction(cstThisSub)
+ Exit Function
+Catch:
+ GoTo Finally
+End Function ' SFWidgets.SF_PopupMenu.GetProperty
+
+REM
-----------------------------------------------------------------------------
+Public Function Methods() As Variant
+''' Return the list of public methods of the Model service
as an array
+
+ Methods = Array( _
+ "AddCheckBox" _
+ , "AddItem" _
+ , "AddRadioButton" _
+ , "Execute" _
+ )
+
+End Function ' SFWidgets.SF_PopupMenu.Methods
+
+REM
-----------------------------------------------------------------------------
+Public Function Properties() As Variant
+''' Return the list or properties of the Timer
a.AddItem("B>B1")class as an array
+
+ Properties = Array( _
+ "ShortcutCharacter" _
+ , "SubmenuCharacter" _
+ )
+
+End Function ' SFWidgets.SF_PopupMenu.Properties
+
+REM
-----------------------------------------------------------------------------
+Public Function SetProperty(Optional ByVal PropertyName As Variant _
+ , Optional
ByRef Value As Variant _
+ ) As Boolean
+''' Set a new value to the given property
+''' Args:
+''' PropertyName: the name of the property as a
string
+''' Value: its new value
+''' Exceptions
+''' ARGUMENTERROR The property does not
exist
+
+Const cstThisSub = "SFWidgets.PopupMenu.SetProperty"
+Const cstSubArgs = "PropertyName, Value"
+
+ If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
+ SetProperty = False
+
+Check:
+ If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
+ If Not SF_Utils._Validate(PropertyName,
"PropertyName", V_STRING, Properties()) Then GoTo Catch
+ End If
+
+Try:
+ SetProperty = _PropertySet(PropertyName, Value)
+
+Finally:
+ SF_Utils._ExitFunction(cstThisSub)
+ Exit Function
+Catch:
+ GoTo Finally
+End Function ' SFWidgets.SF_PopupMenu.SetProperty
+
+REM =========================================================== PRIVATE
FUNCTIONS
+
+REM
-----------------------------------------------------------------------------
+Public Function _AddItem(ByVal MenuItem As String _
+ , ByVal Name As
String _
+ , ByVal
ItemType As String _
+ , ByVal Status
As Boolean _
+ , ByVal Icon As
String _
+ , ByVal Tooltip
As String _
+ ) As Integer
+''' Insert in the popup menu a new entry
+''' Args:
+''' MenuItem: The text to be displayed in the menu
entry.
+''' It determines also the hierarchy of the
popup menu
+''' It is made up of all the components
(separated by the "SubmenuCharacter") of the menu branch
+''' Example: A>B>C
means "C" is a new entry in submenu "A => B
=>"
+''' If the last component is equal to the
"SeparatorCharacter", a line separator is inserted
+''' Name: The name to be returned by the Execute()
method if this item is clicked
+''' Default = the last component of MenuItem
+''' ItemType: "N"(ormal,
"C"(heck) or "R"(adio)
+''' Status: when True the item is selected
+''' Icon: The path name of the icon to be
displayed, without leading path separator
+''' The icons are stored in one of the
<install folder>/share/config/images_*.zip files
+''' The exact file depends on the
user options about the current icon set
+''' Use the (normal) slash "/" as
path separator
+''' Example: "cmd/sc_cut.png"
+''' Tooltip: The help text to be displayed as a
tooltip
+''' Returns:
+''' The numeric identification of the newly
inserted item
+
+Dim iId As Integer ' Return value
+Dim vSplit As Variant ' Split menu item
+Dim sMenu As String ' Submenu where to attach
the new item, as a string
+Dim oMenu As Object ' Submenu where to attach
the new item, as an object
+Dim sName As String ' The text displayed in
the menu box
+Dim oImage As Object ' com.sun.star.graphic.XGraphic
+
+ On Local Error GoTo Catch
+ iId = 0
+
+Try:
+ ' Run through the upper menu tree
+ vSplit = _SplitMenuItem(MenuItem)
+
+ ' Create and determine the menu to which to attach the new item
+ sMenu = vSplit(0)
+ Set oMenu = _GetPopupMenu(sMenu) ' Run through the upper
menu tree and retain the last branch
+
+ ' Insert the new item
+ LastItem = LastItem + 1
+ sName = vSplit(1)
+
+ With oMenu
+ If sName = _SeparatorChar Then
+ .insertSeparator(-1)
+ Else
+ Select Case ItemType
+ Case cstNormal
+ .insertItem(LastItem, sName, 0, -1)
+ Case cstCheck
+ .insertItem(LastItem, sName,
com.sun.star.awt.MenuItemStyle.AUTOCHECK, -1)
+ .checkItem(LastItem, Status)
+ Case cstRadio
+ .insertItem(LastItem, sName,
com.sun.star.awt.MenuItemStyle.RADIOCHECK, -1)
+ .checkItem(LastItem, Status)
+ End Select
+
+ ' Store the ID - Name relation
+ If Len(Name) = 0 Then Name = Replace(sName,
_UnderlineAccessKeyChar, "")
+ MenuIdentification.Add(Str(LastItem), Name)
+
+ ' Add the icon when relevant
+ If Len(Icon) > 0 Then
+ Set oImage = _GetImageFromUrl(_IconsDirectory
& Icon)
+ If Not IsNull(oImage) Then
.setItemImage(LastItem, oImage, False)
+ End If
+
+ ' Add the tooltip when relevant
+ If Len(Tooltip) > 0 Then .setTipHelpText(LastItem,
Tooltip)
+ End If
+ End With
+
+ iId = LastItem
+
+Finally:
+ _AddItem = iId
+ Exit Function
+Catch:
+ GoTo Finally
+End Function ' SFWidgets.SF_PopupMenu._AddItem
+
+REM
-----------------------------------------------------------------------------
+Private Function _GetImageFromURL(psUrl as String) As Object
+''' Returns a com.sun.star.graphic.XGraphic instance based
on the given URL
+''' The returned object is intended to be inserted as an
icon in the popup menu
+''' Derived from "Useful Macro Information For
OpenOffice" By Andrew Pitonyak
+
+Dim vMediaProperties As Variant ' Array of
com.sun.star.beans.PropertyValue
+Dim oGraphicProvider As Object '
com.sun.star.graphic.GraphicProvider
+Dim oImage As Object ' Return value
+
+ On Local Error GoTo Catch ' Ignore errors
+ Set oImage = Nothing
+
+Try:
+ ' Create graphic provider instance to load images from files.
+ Set oGraphicProvider =
CreateUnoService("com.sun.star.graphic.GraphicProvider")
+
+ ' Set the URL property so graphic provider is able to load the
image
+ Set vMediaProperties =
Array(ScriptForge.SF_Utils._MakePropertyValue("URL", psURL))
+
+ ' Retrieve the com.sun.star.graphic.XGraphic instance
+ Set oImage = oGraphicProvider.queryGraphic(vMediaProperties)
+
+Finally:
+ Set _GetImageFromUrl = oImage
+ Exit Function
+Catch:
+ GoTo Finally
+End Function ' SFWidgets.SF°PopupMenu._GetImageFromUrl
+
+REM
-----------------------------------------------------------------------------
+Private Function _GetPopupMenu(ByVal psSubmenu As String) As Object
+''' Get the com.sun.star.awt.XPopupMenu object
corresponding with the string in argument
+''' If the menu exists, it is found in the MenuTree
dictionary
+''' If it does not exist, it is created recursively.
+''' Args:
+''' psSubmenu: a string like "A>B"
+''' Returns
+''' A com.sun.star.awt.XpopupMenu object
+''' Example
+''' If psSubmenu = "A>B>C>D",
and only the root menu exists,
+''' - "A", "A>B",
"A>B>C", "A>B>C>D" should be created
+''' - the popup menu corresponding with
"A>B>C>D" should be returned
+
+Dim oPopup As Object ' Return value
+Dim vSplit As Variant ' An array as returned by
_SplitMenuItem()
+Dim sMenu As String ' The left part
of psSubmenu
+Dim oMenu As Object '
com.sun.star.awt.XpopupMenu
+Dim oLastMenu As Object '
com.sun.star.awt.XpopupMenu
+Dim i As Long
+
+ Set oPopup = Nothing
+ Set oLastMenu = MenuRoot
+Try:
+ If Len(psSubmenu) = 0 Then '
Menu starts at the root
+ Set oPopup = MenuRoot
+ ElseIf MenuTree.Exists(psSubmenu) Then ' Shortcut: if
the submenu exists, get it directly
+ Set oPopup = MenuTree.Item(psSubmenu)
+ Else
' Build the tree
+ vSplit = Split(psSubmenu, SubmenuChar)
+ ' Search the successive submenus in the MenuTree
dictionary, If not found, create a new entry
+ For i = 0 To UBound(vSplit)
+ sMenu = Join(ScriptForge.SF_Array.Slice(vSplit, 0, i),
SubmenuChar)
+ If MenuTree.Exists(sMenu) Then
+ Set oLastMenu = MenuTree.Item(sMenu)
+ Else
+ ' Insert the new menu tree item
+ LastItem = LastItem + 1
+ oLastMenu.insertItem(LastItem, vSplit(i), 0, -1)
+ Set oMenu =
CreateUnoService("stardiv.vcl.PopupMenu")
+ MenuTree.Add(sMenu, oMenu)
+ oLastMenu.setPopupMenu(LastItem, oMenu)
+ Set oLastMenu = oMenu
+ End If
+ Next i
+ Set oPopup = oLastMenu
+ End If
+
+Finally:
+ Set _GetPopupMenu = oPopup
+ Exit Function
+End Function ' SFWidgets.SF_PopupMenu._GetPopupMenu
+
+REM
-----------------------------------------------------------------------------
+Public Sub _Initialize(ByRef poPeer As Object _
+ , plXPos As Long _
+ , plYPos As Long _
+ , psSubmenuChar As String _
+ )
+''' Complete the object creation process:
+''' - Initialize the dictionaries
+''' - initialize the root popup menu
+''' - intialize the display area
+''' - store the arguments for later use
+''' Args:
+''' poPeer: a peer window
+''' plXPos, plYPos: the coordina
+
+Try:
+ ' Initialize the dictionaries
+ With ScriptForge.SF_Services
+ Set MenuTree = .CreateScriptService("Dictionary")
+ Set MenuIdentification =
.CreateScriptService("Dictionary")
+ End With
+
+ ' Initialize the root of the menu tree
+ Set MenuRoot = CreateUnoService("stardiv.vcl.PopupMenu")
+
+ ' Setup the display area
+ Set Rectangle = New com.sun.star.awt.Rectangle
+ Rectangle.X = plXPos
+ Rectangle.Y = plYPos
+
+ ' Keep the targeted window
+ Set PeerWindow = poPeer
+
+ ' Store the submenu character
+ If Len(psSubmenuChar) > 0 Then SubmenuChar = psSubmenuChar
+
+Finally:
+ Exit Sub
+End Sub ' SFWidgets.SF_PopupMenu._Initialize
+
+REM
-----------------------------------------------------------------------------
+Private Function _PropertyGet(Optional ByVal psProperty As String) As Variant
+''' Return the value of the named property
+''' Args:
+''' psProperty: the name of the property
+
+Dim vGet As Variant '
Return value
+Dim cstThisSub As String
+Const cstSubArgs = ""
+
+ cstThisSub = "SFWidgets.PopupMenu.get" & psProperty
+ If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
+
+ ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
+ _PropertyGet = Null
+
+ Select Case UCase(psProperty)
+ Case UCase("ShortcutCharacter")
+ _PropertyGet = _UnderlineAccessKeyChar
+ Case UCase("SubmenuCharacter")
+ _PropertyGet = SubmenuChar
+ Case Else
+ _PropertyGet = Null
+ End Select
+
+Finally:
+ ScriptForge.SF_Utils._ExitFunction(cstThisSub)
+ Exit Function
+Catch:
+ GoTo Finally
+End Function ' SFWidgets.SF_PopupMenu._PropertyGet
+
+REM
-----------------------------------------------------------------------------
+Private Function _Repr() As String
+''' Convert the Model instance to a readable string,
typically for debugging purposes (DebugPrint ...)
+''' Args:
+''' Return:
+''' "[PopupMenu]: Name, Type (dialogname)
+ _Repr = "[PopupMenu]: " &
SF_String.Represent(MenuTree.Keys()) & ", " &
SF_String.Represent(MenuIdentification.Items())
+
+End Function ' SFWidgets.SF_PopupMenu._Repr
+
+REM
-----------------------------------------------------------------------------
+Private Function _SplitMenuItem(ByVal psMenuItem As String ) As Variant
+''' Split a menu item given as a string and delimited by
the submenu character
+''' Args:
+''' psMenuItem: a string like
"A>B>C"
+''' Returns:
+''' An array: [0] = "A>B"
+''' [1] = "C"
+
+Dim vReturn(0 To 1) As String ' Return value
+Dim vMenus() As Variant ' Array of menus
+
+Try:
+ vMenus = Split(psMenuItem, SubmenuChar)
+ vReturn(1) = vMenus(UBound(vMenus))
+ vReturn(0) = Left(psMenuItem, Len(psMenuItem) - Iif(UBound(vMenus) >
0, Len(SubmenuChar), 0) - Len(vReturn(1)))
+
+Finally:
+ _SplitMenuItem = vReturn
+End Function ' SFWidgets.SF_PopupMenu._SplitMenuItem
+
+REM ============================================ END OF SFWIDGETS.SF_POPUPMENU
+</script:module>
\ No newline at end of file
diff --git a/wizards/source/sfwidgets/SF_Register.xba
b/wizards/source/sfwidgets/SF_Register.xba
new file mode 100644
index 000000000000..b7f366102be4
--- /dev/null
+++ b/wizards/source/sfwidgets/SF_Register.xba
@@ -0,0 +1,127 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE script:module PUBLIC "-//OpenOffice.org//DTD OfficeDocument 1.0//EN"
"module.dtd">
+<script:module xmlns:script="http://openoffice.org/2000/script";
script:name="SF_Register" script:language="StarBasic"
script:moduleType="normal">REM
=======================================================================================================================
+REM === The ScriptForge library and its associated
libraries are part of the LibreOffice project. ===
+REM === The SFWidgets library
is one of the associated libraries.
===
+REM === Full documentation is available
on https://help.libreoffice.org/
===
+REM
=======================================================================================================================
+
+Option Compatible
+Option Explicit
+
+'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+''' SF_Register
+''' ===========
+''' The ScriptForge framework includes
+''' the master ScriptForge library
+''' a number of "associated"
libraries SF*
+''' any user/contributor extension wanting
to fit into the framework
+'''
+''' The main methods in this module allow the
current library to cling to ScriptForge
+''' - RegisterScriptServices
+''' Register the list of services
implemented by the current library
+''' - _NewPopupMenu
+''' Create a new popup menu service
instance
+'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+
+REM ==================================================================
EXCEPTIONS
+
+REM =================================================================
DEFINITIONS
+
+REM ============================================================== PUBLIC
METHODS
+
+REM
-----------------------------------------------------------------------------
+Public Sub RegisterScriptServices() As Variant
+''' Register into ScriptForge the list of the services
implemented by the current library
+''' Each library pertaining to the framework must implement
its own version of this method
+'''
+''' It consists in successive calls to the
RegisterService() and RegisterEventManager() methods
+''' with 2 arguments:
+''' ServiceName: the name of the service as a
case-insensitive string
+''' ServiceReference: the reference as an object
+''' If the reference refers to a module,
then return the module as an object:
+''' GlobalScope.Library.Module
+''' If the reference is a class instance,
then return a string referring to the method
+''' containing the New statement creating
the instance
+'''
"libraryname.modulename.function"
+
+ With GlobalScope.ScriptForge.SF_Services
+ .RegisterService("PopupMenu",
"SFWidgets.SF_Register._NewPopupMenu") '
Reference to the function initializing the service
+ End With
+
+End Sub '
SFWidgets.SF_Register.RegisterScriptServices
+
+REM =========================================================== PRIVATE
FUNCTIONS
+
+REM
-----------------------------------------------------------------------------
+Public Function _NewPopupMenu(Optional ByVal pvArgs As Variant) As Object
+''' Create a new instance of the SF_PopupMenu class
+' Args:
+''' Event: a mouse event
+''' If the event has no source or is not a
mouse event, the menu is displayed above ThisComponent
+''' X, Y: forced coordinates
+''' SubmenuChar: Delimiter in menu trees
+''' Returns: the instance or Nothing
+
+Dim oMenu As Object ' Return value
+Dim Event As Variant ' Mouse event
+Dim X As Long ' Mouse click
coordinates
+Dim Y As Long
+Dim SubmenuChar As String ' Delimiter in menu trees
+Dim oSession As Object ' ScriptForge.SF_Session
+Dim vUno As Variant ' UNO type split
into an array
+Dim sEventType As String ' Event type, must be
"MouseEvent"
+Dim oControl As Object ' The dialog or form
control view which triggered the event
+
+ If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
+
+Check:
+ If IsMissing(pvArgs) Or IsEmpty(pvArgs) Then pvArgs = Array()
+ If Not IsArray(pvArgs) Then pvArgs = Array(pvArgs)
+ If UBound(pvArgs) >= 0 Then Event = pvArgs(0) Else Event = Nothing
+ If UBound(pvArgs) >= 1 Then X = pvArgs(1) Else X = 0
+ If UBound(pvArgs) >= 2 Then Y = pvArgs(2) Else Y = 0
+ If UBound(pvArgs) >= 3 Then SubmenuChar = pvArgs(3) Else SubmenuChar
= ""
+ If Not ScriptForge.SF_Utils._Validate(Event, "Event",
ScriptForge.V_OBJECT) Then GoTo Finally
+ If Not ScriptForge.SF_Utils._Validate(X, "X",
ScriptForge.V_NUMERIC) Then GoTo Finally
+ If Not ScriptForge.SF_Utils._Validate(Y, "Y",
ScriptForge.V_NUMERIC) Then GoTo Finally
+ Set oMenu = Nothing
+
+Try:
+ Set oSession =
ScriptForge.SF_Services.CreateScriptService("Session")
+ Set oControl = Nothing
+ If Not IsNull(Event) Then
+ ' Determine the X, Y coordinates
+ vUno = Split(oSession.UnoObjectType(Event), ".")
+ sEventType = vUno(UBound(vUno))
+ If UCase(sEventType) = "MOUSEEVENT" Then
+ X = Event.X
+ Y = Event.Y
+ ' Determine the window peer target
+ If oSession.HasUnoProperty(Event, "Source")
Then Set oControl = Event.Source.Peer
+ End If
+ End If
+ ' If not a mouse event, if no control, ...
+ If IsNull(oControl) Then
+ If Not IsNull(ThisComponent) Then Set oControl =
ThisComponent.CurrentController.Frame.getContainerWindow()
+ End If
+
+ If Not IsNull(oControl) Then
+ Set oMenu = New SF_PopupMenu
+ With oMenu
+ Set .[Me] = oMenu
+ ._Initialize(oControl, X, Y, SubmenuChar)
+ End With
+ Else
+ Set oMenu = Nothing
+ End If
+
+Finally:
+ Set _NewPopupMenu = oMenu
+ Exit Function
+Catch:
+ GoTo Finally
+End Function ' SFWidgets.SF_Register._NewPopupMenu
+
+REM ============================================== END OF SFWidgets.SF_REGISTER
+</script:module>
\ No newline at end of file
diff --git a/wizards/source/sfwidgets/__License.xba
b/wizards/source/sfwidgets/__License.xba
new file mode 100644
index 000000000000..0d0990e37a71
--- /dev/null
+++ b/wizards/source/sfwidgets/__License.xba
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE script:module PUBLIC "-//OpenOffice.org//DTD OfficeDocument 1.0//EN"
"module.dtd">
+<script:module xmlns:script="http://openoffice.org/2000/script";
script:name="__License" script:language="StarBasic" script:moduleType="normal">
+''' Copyright 2019-2022 Jean-Pierre LEDURE, Rafael LIMA,
Alain ROMEDENNE
+
+REM
=======================================================================================================================
+REM === The ScriptForge library and its associated
libraries are part of the LibreOffice project. ===
+REM === The SFWidgets library
is one of the associated libraries.
===
+REM === Full documentation is available
on https://help.libreoffice.org/
===
+REM
=======================================================================================================================
+
+''' ScriptForge is distributed in the hope that it
will be useful,
+''' but WITHOUT ANY WARRANTY; without even the
implied warranty of
+''' MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.
+
+''' ScriptForge is free software; you can
redistribute it and/or modify it under the terms of either (at your option):
+
+''' 1) The Mozilla Public License, v. 2.0. If a
copy of the MPL was not
+''' distributed with this file, you can obtain one
at http://mozilla.org/MPL/2.0/ .
+
+''' 2) The GNU Lesser General Public License as
published by
+''' the Free Software Foundation, either version 3
of the License, or
+''' (at your option) any later version. If a copy
of the LGPL was not
+''' distributed with this file, see
http://www.gnu.org/licenses/ .
+
+</script:module>
\ No newline at end of file
diff --git a/wizards/source/sfwidgets/dialog.xlb
b/wizards/source/sfwidgets/dialog.xlb
new file mode 100644
index 000000000000..5d45468be116
--- /dev/null
+++ b/wizards/source/sfwidgets/dialog.xlb
@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE library:library PUBLIC "-//OpenOffice.org//DTD OfficeDocument
1.0//EN" "library.dtd">
+<library:library xmlns:library="http://openoffice.org/2000/library";
library:name="SFWidgets" library:readonly="false"
library:passwordprotected="false"/>
\ No newline at end of file
diff --git a/wizards/source/sfwidgets/script.xlb
b/wizards/source/sfwidgets/script.xlb
new file mode 100644
index 000000000000..a32c363d4ac6
--- /dev/null
+++ b/wizards/source/sfwidgets/script.xlb
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE library:library PUBLIC "-//OpenOffice.org//DTD OfficeDocument
1.0//EN" "library.dtd">
+<library:library xmlns:library="http://openoffice.org/2000/library";
library:name="SFWidgets" library:readonly="false"
library:passwordprotected="false">
+ <library:element library:name="__License"/>
+ <library:element library:name="SF_Register"/>
+ <library:element library:name="SF_PopupMenu"/>
+</library:library>
\ No newline at end of file
