| blob | d2c4245131681d3e542209f0f26b7bb8e68cce7b |
3 <script:module xmlns:script="http://openoffice.org/2000/script" script:name="SF_Register" script:language="StarBasic" script:moduleType="normal">REM =======================================================================================================================
4 REM === The ScriptForge library and its associated libraries are part of the LibreOffice project. ===
5 REM === The SFWidgets library is one of the associated libraries. ===
6 REM === Full documentation is available on https://help.libreoffice.org/ ===
7 REM =======================================================================================================================
9 Option Compatible
10 Option Explicit
12 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
13 ''' SF_Register
14 ''' ===========
15 ''' The ScriptForge framework includes
16 ''' the master ScriptForge library
18 ''' any user/contributor extension wanting to fit into the framework
19 '''
20 ''' The main methods in this module allow the current library to cling to ScriptForge
21 ''' - RegisterScriptServices
22 ''' Register the list of services implemented by the current library
23 ''' - _NewMenu
24 ''' Create a new menu service instance.
25 ''' Called from SFDocuments services with CreateMenu()
26 ''' - _NewPopupMenu
27 ''' Create a new popup menu service instance.
28 ''' Called from CreateScriptService()
29 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
31 REM ================================================================== EXCEPTIONS
33 REM ================================================================= DEFINITIONS
35 REM ============================================================== PUBLIC METHODS
37 REM -----------------------------------------------------------------------------
38 Public Sub RegisterScriptServices() As Variant
39 ''' Register into ScriptForge the list of the services implemented by the current library
40 ''' Each library pertaining to the framework must implement its own version of this method
41 '''
42 ''' It consists in successive calls to the RegisterService() and RegisterEventManager() methods
44 ''' ServiceName: the name of the service as a case-insensitive string
45 ''' ServiceReference: the reference as an object
46 ''' If the reference refers to a module, then return the module as an object:
47 ''' GlobalScope.Library.Module
48 ''' If the reference is a class instance, then return a string referring to the method
49 ''' containing the New statement creating the instance
52 With GlobalScope.ScriptForge.SF_Services
53 .RegisterService("Menu", "SFWidgets.SF_Register._NewMenu") ' Reference to the function initializing the service
54 .RegisterService("PopupMenu", "SFWidgets.SF_Register._NewPopupMenu") ' id.
56 .RegisterService("ToolbarButton", "SFWidgets.SF_Register._NewToolbarButton") ' id.
57 End With
59 End Sub ' SFWidgets.SF_Register.RegisterScriptServices
61 REM =========================================================== PRIVATE FUNCTIONS
63 REM -----------------------------------------------------------------------------
64 Public Function _NewMenu(Optional ByVal pvArgs As Variant) As Object
65 ''' Create a new instance of the SF_Menu class
66 ''' [called internally from SFDocuments.Document.CreateMenu() ONLY]
67 ''' Args:
68 ''' Component: the com.sun.star.lang.XComponent where to find the menubar to plug the new menu in
69 ''' Header: the name/header of the menu
70 ''' Before: the place where to put the new menu on the menubar (string or number >= 1)
73 ''' Returns: the instance or Nothing
75 Dim oMenu As Object ' Return value
76 Dim oComponent As Object ' The document or formdocument's component - com.sun.star.lang.XComponent
77 Dim sHeader As String ' Menu header
78 Dim sBefore As String ' Position of menu as a string
79 Dim iBefore As Integer ' as a number
80 Dim sSubmenuChar As String ' Delimiter in menu trees
82 If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
83 Set oMenu = Nothing
85 Check:
86 ' Types and number of arguments are not checked because internal call only
87 Set oComponent = pvArgs(0)
88 sHeader = pvArgs(1)
89 Select Case VarType(pvArgs(2))
90 Case V_STRING : sBefore = pvArgs(2)
91 iBefore = 0
92 Case Else : sBefore = ""
93 iBefore = pvArgs(2)
94 End Select
95 sSubmenuChar = pvArgs(3)
97 Try:
98 If Not IsNull(oComponent) Then
99 Set oMenu = New SF_Menu
100 With oMenu
101 Set .[Me] = oMenu
102 ._Initialize(oComponent, sHeader, sBefore, iBefore, sSubmenuChar)
103 End With
104 End If
106 Finally:
107 Set _NewMenu = oMenu
108 Exit Function
109 Catch:
110 GoTo Finally
111 End Function ' SFWidgets.SF_Register._NewMenu
113 REM -----------------------------------------------------------------------------
114 Public Function _NewPopupMenu(Optional ByVal pvArgs As Variant) As Object
115 ''' Create a new instance of the SF_PopupMenu class
116 ''' Args:
117 ''' Event: a mouse event
118 ''' If the event has no source or is not a mouse event, the menu is displayed above the actual window
119 ''' X, Y: forced coordinates
120 ''' SubmenuChar: Delimiter used in menu trees
121 ''' Returns: the instance or Nothing
123 Dim oMenu As Object ' Return value
124 Dim Event As Variant ' Mouse event
125 Dim X As Long ' Mouse click coordinates
126 Dim Y As Long
127 Dim SubmenuChar As String ' Delimiter in menu trees
128 Dim vUno As Variant ' UNO type split into an array
130 Dim oControl As Object ' The dialog or form control view which triggered the event
131 Dim oWindow As Object ' ui.Window type
132 Dim oSession As Object : Set oSession = ScriptForge.SF_Services.CreateScriptService("ScriptForge.Session")
133 Dim oUi As Object : Set oUi = ScriptForge.SF_Services.CreateScriptService("ScriptForge.UI")
135 If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
136 Set oMenu = Nothing
138 Check:
139 ' Check and get arguments, their number may vary
140 If IsMissing(pvArgs) Or IsEmpty(pvArgs) Then pvArgs = Array()
141 If Not IsArray(pvArgs) Then pvArgs = Array(pvArgs)
143 If IsEmpty(Event) Then Event = Nothing
147 If Not ScriptForge.SF_Utils._Validate(Event, "Event", ScriptForge.V_OBJECT) Then GoTo Finally
148 If Not ScriptForge.SF_Utils._Validate(X, "X", ScriptForge.V_NUMERIC) Then GoTo Finally
149 If Not ScriptForge.SF_Utils._Validate(Y, "Y", ScriptForge.V_NUMERIC) Then GoTo Finally
150 If Not ScriptForge.SF_Utils._Validate(SubmenuChar, "SubmenuChar", V_STRING) Then GoTo Finally
152 Try:
153 ' Find and identify the control that triggered the popup menu
154 Set oControl = Nothing
155 If Not IsNull(Event) Then
156 ' Determine the X, Y coordinates
158 sEventType = vUno(UBound(vUno))
160 X = Event.X
161 Y = Event.Y
162 ' Determine the window peer target
164 End If
165 End If
166 ' If not a mouse event, if no control, find what can be decent alternatives: (a menu header in) the actual window
167 If IsNull(oControl) Then
168 Set oWindow = oUi._IdentifyWindow(StarDesktop.getCurrentComponent()) ' A menu has been clicked necessarily in the current window
169 With oWindow
170 If Not IsNull(.Frame) Then Set oControl = .Frame.getContainerWindow()
171 End With
172 End If
174 If Not IsNull(oControl) Then
175 Set oMenu = New SF_PopupMenu
176 With oMenu
177 Set .[Me] = oMenu
178 ._Initialize(oControl, X, Y, SubmenuChar)
179 End With
180 Else
181 Set oMenu = Nothing
182 End If
184 Finally:
185 Set _NewPopupMenu = oMenu
186 Exit Function
187 Catch:
188 GoTo Finally
189 End Function ' SFWidgets.SF_Register._NewPopupMenu
191 REM -----------------------------------------------------------------------------
192 Public Function _NewToolbar(Optional ByVal pvArgs As Variant) As Object
193 ''' Create a new instance of the SF_Toolbar class
194 ''' The "Toolbar" service must not be invoked directly in a user script
195 ''' Args:
196 ''' ToolbarDesc: a proto-toolbar object type. See ScriptForge.SF_UI for a detailed description
197 ''' Returns:
198 ''' the instance or Nothing
200 Dim oToolbar As Object ' Return value
201 Dim oToolbarDesc As Object ' A proto-toolbar description
203 If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
204 Set oToolbar = Nothing
206 Check:
207 Set oToolbarDesc = pvArgs(0)
209 Try:
210 Set oToolbar = New SF_Toolbar
211 With oToolbar
212 Set .[Me] = oToolbar
213 ._Initialize(oToolbarDesc)
214 End With
216 Finally:
217 Set _NewToolbar = oToolbar
218 Exit Function
219 Catch:
220 GoTo Finally
221 End Function ' SFWidgets.SF_Register._NewToolbar
223 REM -----------------------------------------------------------------------------
224 Public Function _NewToolbarButton(Optional ByVal pvArgs As Variant) As Object
225 ''' Create a new instance of the SF_ToolbarButton class
226 ''' The "ToolbarButton" service must not be invoked directly in a user script
227 ''' Args:
228 ''' ToolbarButtonDesc: a proto-toolbarButton object type. See SFWidgets.SF_Toolbar for a detailed description
229 ''' Returns:
230 ''' the instance or Nothing
232 Dim oToolbarButton As Object ' Return value
233 Dim oToolbarButtonDesc As Object ' A proto-toolbarbutton description
235 If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
236 Set oToolbarButton = Nothing
238 Check:
239 Set oToolbarButtonDesc = pvArgs(0)
241 Try:
242 Set oToolbarButton = New SF_ToolbarButton
243 With oToolbarButton
244 Set .[Me] = oToolbarButton
245 ._Initialize(oToolbarButtonDesc)
246 End With
248 Finally:
249 Set _NewToolbarButton = oToolbarButton
250 Exit Function
251 Catch:
252 GoTo Finally
253 End Function ' SFWidgets.SF_Register._NewToolbarButton
256 REM ============================================== END OF SFWIDGETS.SF_REGISTER
257 </script:module>