| blob | d3eacfae09829d0bb472b0f0800b65b34cb1054e |
3 <script:module xmlns:script="http://openoffice.org/2000/script" script:name="SF_Region" script:language="StarBasic" script:moduleType="normal">REM =======================================================================================================================
4 REM === The ScriptForge library and its associated libraries are part of the LibreOffice project. ===
5 REM === Full documentation is available on https://help.libreoffice.org/ ===
6 REM =======================================================================================================================
8 Option Compatible
9 Option Explicit
11 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
12 ''' SF_Region
13 ''' =========
15 ''' Implemented as a usual Basic module
16 '''
17 ''' A collection of functions about languages, countries and timezones
18 ''' - Locales
19 ''' - Currencies
20 ''' - Numbers and dates formatting
21 ''' - Calendars
22 ''' - Timezones conversions
23 ''' - Numbers transformed to text
24 '''
25 ''' Definitions:
26 ''' Locale or Region
27 ''' A combination of a language (2 or 3 lower case characters) and a country (2 upper case characters)
28 ''' Most properties and methods require a locale as argument.
29 ''' Some of them accept either the complete locale or only the language or country parts.
30 ''' When absent, the considered locale is the locale used in the LibreOffice user interface.
31 ''' (see the SF_Platform.OfficeLocale property)
32 ''' Timezone
33 ''' Specified as "Region/City" name like "Europe/Berlin", or a custom time zone ID such as "UTC" or "GMT-8:00".
34 ''' The time offset between the timezone and the Greenwich Meridian Time (GMT) is expressed in minutes.
35 ''' The Daylight Saving Time (DST) is an additional offset.
36 ''' Both offsets can be positive or negative.
37 ''' More info on
38 ''' https://timezonedb.com/time-zones
39 ''' https://en.wikipedia.org/wiki/Time_zone
40 '''
41 ''' Service invocation example:
42 ''' Dim regio As Object
44 '''
45 ''' Detailed user documentation:
46 ''' https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_region.html?DbPAR=BASIC
47 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
49 REM ================================================================== EXCEPTIONS
51 REM ============================================================= PRIVATE MEMBERS
53 Private UserLocale As String ' platform.OfficeLocale
55 ' Reference tables
56 Private LocaleData As Variant ' com.sun.star.i18n.LocaleData
59 Private UserIndex As Integer ' Index of UserLocale in reference tables
61 REM ============================================================ MODULE CONSTANTS
63 REM ===================================================== CONSTRUCTOR/DESTRUCTOR
65 REM -----------------------------------------------------------------------------
66 Public Function Dispose() As Variant
67 Set Dispose = Nothing
68 End Function ' ScriptForge.SF_Region Explicit destructor
70 REM ================================================================== PROPERTIES
72 REM -----------------------------------------------------------------------------
73 Property Get Country(Optional ByVal Region As Variant) As String
74 ''' Returns the english country name applicable in the given region.
75 ''' The region expressed either as a
76 ''' - locale combining language-COUNTRY (la-CO)
77 ''' - country only (CO)
78 ''' Example:
81 End Property ' ScriptForge.SF_Region.Country (get)
83 REM -----------------------------------------------------------------------------
84 Property Get Currency(Optional ByVal Region As Variant) As String
85 ''' Returns the currency applicable in the given region.
86 ''' The region is expressed either as a
87 ''' - locale combining language-COUNTRY (la-CO)
88 ''' - country only (CO)
89 ''' Example:
92 End Property ' ScriptForge.SF_Region.Currency (get)
94 REM -----------------------------------------------------------------------------
95 Public Function DatePatterns(Optional ByVal Region As Variant) As Variant ' Function better than Property when return value is an array
96 ''' Returns list of date acceptance patterns for the given region.
97 ''' Patterns with input combinations that are accepted as incomplete date input, such as M/D or D.M
98 ''' The region is expressed as a locale combining language-COUNTRY (la-CO)
99 ''' The list is zero-based.
100 ''' Example:
101 ''' MsgBox Join(Regio.DatePatterns("it-IT"), ",") ' D/M/Y,D/M
103 End Function ' ScriptForge.SF_Region.DatePatterns (get)
105 REM -----------------------------------------------------------------------------
106 Property Get DateSeparator(Optional ByVal Region As Variant) As String
107 ''' Returns the separator used in dates applicable in the given region.
108 ''' The region is expressed as a locale combining language-COUNTRY (la-CO)
109 ''' Example:
112 End Property ' ScriptForge.SF_Region.DateSeparator (get)
114 REM -----------------------------------------------------------------------------
115 Public Function DayAbbrevNames(Optional ByVal Region As Variant) As Variant ' Function better than Property when return value is an array
116 ''' Returns list of abbreviated names of weekdays applicable in the given region.
117 ''' The region expressed as a
118 ''' - locale combining language-COUNTRY (la-CO)
119 ''' - language only (la)
121 ''' Example:
122 ''' MsgBox Join(Regio.DayAbbrevNames("it-IT"), ",") ' lun,mar,mer,gio,ven,sab,dom
124 End Function ' ScriptForge.SF_Region.DayAbbrevNames (get)
126 REM -----------------------------------------------------------------------------
127 Public Function DayNames(Optional ByVal Region As Variant) As Variant ' Function better than Property when return value is an array
128 ''' Returns list of names of weekdays applicable in the given region.
129 ''' The region expressed as a
130 ''' - locale combining language-COUNTRY (la-CO)
131 ''' - language only (la)
133 ''' Example:
134 ''' MsgBox Join(Regio.DayNames("it-IT"), ",") ' lunedì,martedì,mercoledì,giovedì,venerdì,sabato,domenica
136 End Function ' ScriptForge.SF_Region.DayNames (get)
138 REM -----------------------------------------------------------------------------
139 Public Function DayNarrowNames(Optional ByVal Region As Variant) As Variant ' Function better than Property when return value is an array
140 ''' Returns list of initials of weekdays applicable in the given region.
141 ''' The region expressed as a
142 ''' - locale combining language-COUNTRY (la-CO)
143 ''' - language only (la)
145 ''' Example:
146 ''' MsgBox Join(Regio.DayNarrowNames("it-IT"), ",") ' l,m,m,g,v,s,d
148 End Function ' ScriptForge.SF_Region.DayNarrowNames (get)
150 REM -----------------------------------------------------------------------------
151 Property Get DecimalPoint(Optional ByVal Region As Variant) As String
152 ''' Returns the decimal separator used in numbers applicable in the given region.
153 ''' The region is expressed as a locale combining language-COUNTRY (la-CO)
154 ''' Example:
157 End Property ' ScriptForge.SF_Region.DecimalPoint (get)
159 REM -----------------------------------------------------------------------------
160 Property Get Language(Optional ByVal Region As Variant) As String
161 ''' Returns the english Language name applicable in the given region.
162 ''' The region expressed as a
163 ''' - locale combining language-COUNTRY (la-CO)
164 ''' - language only (la)
165 ''' Example:
168 End Property ' ScriptForge.SF_Region.Language (get)
170 REM -----------------------------------------------------------------------------
171 Property Get ListSeparator(Optional ByVal Region As Variant) As String
172 ''' Returns the separator used in lists applicable in the given region.
173 ''' The region is expressed as a locale combining language-COUNTRY (la-CO)
174 ''' Example:
177 End Property ' ScriptForge.SF_Region.ListSeparator (get)
179 REM -----------------------------------------------------------------------------
180 Public Function MonthAbbrevNames(Optional ByVal Region As Variant) As Variant ' Function better than Property when return value is an array
181 ''' Returns list of abbreviated names of months applicable in the given region.
182 ''' The region expressed as a
183 ''' - locale combining language-COUNTRY (la-CO)
184 ''' - language only (la)
185 ''' The list is zero-based.
186 ''' Example:
187 ''' MsgBox Join(Regio.MonthAbbrevNames("it-IT"), ",") ' gen,feb,mar,apr,mag,giu,lug,ago,set,ott,nov,dic
189 End Function ' ScriptForge.SF_Region.MonthAbbrevNames (get)
191 REM -----------------------------------------------------------------------------
192 Public Function MonthNames(Optional ByVal Region As Variant) As Variant ' Function better than Property when return value is an array
193 ''' Returns list of names of months applicable in the given region.
194 ''' The region expressed as a
195 ''' - locale combining language-COUNTRY (la-CO)
196 ''' - language only (la)
197 ''' The list is zero-based.
198 ''' Example:
199 ''' MsgBox Join(Regio.MonthNames("it-IT"), ",") ' gennaio,febbraio,marzo,aprile,maggio,giugno,luglio,agosto,settembre,ottobre,novembre,dicembre
201 End Function ' ScriptForge.SF_Region.MonthNames (get)
203 REM -----------------------------------------------------------------------------
204 Public Function MonthNarrowNames(Optional ByVal Region As Variant) As Variant ' Function better than Property when return value is an array
205 ''' Returns list of initials of months applicable in the given region.
206 ''' The region expressed as a
207 ''' - locale combining language-COUNTRY (la-CO)
208 ''' - language only (la)
209 ''' The list is zero-based.
210 ''' Example:
211 ''' MsgBox Join(Regio.MonthNarrowNames("it-IT"), ",") ' g,f,m,a,m,g,l,a,s,o,n,d
213 End Function ' ScriptForge.SF_Region.MonthNarrowNames (get)
215 REM -----------------------------------------------------------------------------
216 Property Get ObjectType As String
217 ''' Only to enable object representation
219 End Property ' ScriptForge.SF_Region.ObjectType
221 REM -----------------------------------------------------------------------------
222 Property Get ServiceName As String
223 ''' Internal use
225 End Property ' ScriptForge.SF_Region.ServiceName
227 REM -----------------------------------------------------------------------------
228 Property Get ThousandSeparator(Optional ByVal Region As Variant) As String
229 ''' Returns the thousands separator used in numbers applicable in the given region.
230 ''' The region is expressed as a locale combining language-COUNTRY (la-CO)
231 ''' Example:
234 End Property ' ScriptForge.SF_Region.ThousandSeparator (get)
236 REM -----------------------------------------------------------------------------
237 Property Get TimeSeparator(Optional ByVal Region As Variant) As String
238 ''' Returns the separator used to format times applicable in the given region.
239 ''' The region is expressed as a locale combining language-COUNTRY (la-CO)
240 ''' Example:
243 End Property ' ScriptForge.SF_Region.TimeSeparator (get)
245 REM ===================================================================== METHODS
247 REM -----------------------------------------------------------------------------
248 Public Function DSTOffset(Optional ByVal LocalDateTime As Variant _
249 , Optional ByVal TimeZone As Variant _
250 , Optional ByVal Locale As Variant _
251 ) As Integer
252 ''' Computes the additional offset due to daylight saving ("summer time")
253 ''' Args
254 ''' LocalDateTime: local date and time as a Date. DST offset varies during the year.
255 ''' TimeZone: specified as "Region/City" name like "Europe/Berlin", or a custom time zone ID such as "UTC" or "GMT-8:00"
256 ''' Locale: expressed as a locale combining language-COUNTRY (la-CO), or COUNTRY alone (CO)
257 ''' Return:
258 ''' The offset in minutes
259 ''' Examples:
260 ''' regio.DSTOffset(DateSerial(2022, 8, 20) + TimeSerial(16, 58, 17), "Europe/Brussels", "fr-BE") ' 60
262 Dim iDSTOffset As Integer ' Return value
263 Dim oLocale As Object ' com.sun.star.lang.Locale
264 Dim oCalendarImpl As Object ' com.sun.star.i18n.CalendarImpl
268 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
269 iDSTOffset = 0
271 Check:
272 If IsMissing(Locale) Or IsEmpty(Locale) Then Locale = ""
273 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
277 End If
279 Set oLocale = SF_Region._GetLocale(Locale, pbCountry := True)
280 If IsNull(oLocale) Then GoTo Finally
282 Try:
284 With oCalendarImpl
285 .loadDefaultCalendarTZ(oLocale, TimeZone)
286 .setLocalDateTime(LocaldateTime)
287 iDSTOffset = .getValue(com.sun.star.i18n.CalendarFieldIndex.DST_OFFSET)
288 End With
290 Finally:
291 DSTOffset = iDSTOffset
292 SF_Utils._ExitFunction(cstThisSub)
293 Exit Function
294 Catch:
295 GoTo Finally
296 End Function ' ScriptForge.SF_Region.DSTOffset
298 REM -----------------------------------------------------------------------------
299 Public Function GetProperty(Optional ByVal PropertyName As Variant _
300 , Optional Region As Variant _
301 ) As Variant
302 ''' Return the actual value of the given property
303 ''' Args:
304 ''' PropertyName: the name of the property as a string
305 ''' Region: the language-COUNTRY combination (la-CO) or the country (CO- or the language (la)
306 ''' Returns:
307 ''' The actual value of the property
308 ''' Exceptions:
309 ''' ARGUMENTERROR The property does not exist
312 Const cstSubArgs = ""
314 If ScriptForge.SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
315 GetProperty = Null
317 Check:
318 If IsMissing(Region) Or IsEmpty(Region) Then Region = ""
319 If ScriptForge.SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
320 If Not ScriptForge.SF_Utils._Validate(PropertyName, "PropertyName", V_STRING, Properties()) Then GoTo Catch
322 End If
324 Try:
325 If Len(Region) = 0 Then
326 GetProperty = _PropertyGet(PropertyName)
327 Else
328 GetProperty = _PropertyGet(PropertyName, Region)
329 End If
331 Finally:
332 SF_Utils._ExitFunction(cstThisSub)
333 Exit Function
334 Catch:
335 GoTo Finally
336 End Function ' ScriptForge.SF_Region.GetProperty
338 REM -----------------------------------------------------------------------------
339 Public Function LocalDateTime(Optional ByVal UTCDateTime As Variant _
340 , Optional ByVal TimeZone As Variant _
341 , Optional ByVal Locale As Variant _
342 ) As Date
343 ''' Computes the local date and time from a UTC date and time
344 ''' Args
345 ''' UTCDateTime: the universal date and time to be converted to local time
346 ''' TimeZone: specified as "Region/City" name like "Europe/Berlin", or a custom time zone ID such as "UTC" or "GMT-8:00"
347 ''' Locale: expressed as a locale combining language-COUNTRY (la-CO), or COUNTRY alone (CO)
348 ''' Return:
349 ''' The local time converted from the corresponding UTC date and time as a Date
350 ''' If the returned value is before 1900, it is likely that the Locale is not recognized
351 ''' If the returned value matches the local time, it is likely that the timezone is not recognized
352 ''' Examples:
353 ''' regio.LocalDateTime(DateSerial(2022, 3, 20) + TimeSerial(16, 58, 17), "Europe/Brussels", "fr-BE")
356 Dim dLocalDateTime As Double ' Return value
357 Dim oLocale As Object ' com.sun.star.lang.Locale
358 Dim oCalendarImpl As Object ' com.sun.star.i18n.CalendarImpl
362 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
363 dLocalDateTime = -1
365 Check:
366 If IsMissing(Locale) Or IsEmpty(Locale) Then Locale = ""
367 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
371 End If
373 Set oLocale = SF_Region._GetLocale(Locale, pbCountry := True)
374 If IsNull(oLocale) Then GoTo Finally
376 Try:
378 With oCalendarImpl
379 .loadDefaultCalendarTZ(oLocale, TimeZone)
380 .setDateTime(UTCDateTime)
381 dLocalDateTime = .getLocalDateTime()
382 End With
384 Finally:
385 LocalDateTime = CDate(dLocalDateTime)
386 SF_Utils._ExitFunction(cstThisSub)
387 Exit Function
388 Catch:
389 GoTo Finally
390 End Function ' ScriptForge.SF_Region.LocalDateTime
392 REM -----------------------------------------------------------------------------
393 Public Function Methods() As Variant
394 ''' Return the list of public methods of the Region class as an array
396 Methods = Array( _
403 )
405 End Function ' ScriptForge.SF_Region.Methods
407 REM -----------------------------------------------------------------------------
408 Public Function Number2Text(Optional ByVal Number As Variant _
409 , Optional ByVal Locale As Variant _
410 ) As String
411 ''' Convert numbers and money amounts in many languages into words
412 ''' Args
413 ''' Number: the number to spell out
414 ''' Accepted types: strings or numeric values (integer or real numbers)
415 ''' When a string, a variety of prefixes is supported
416 ''' The string "help" provides helpful tips about allowed prefixes by language
417 ''' Example for french
418 ''' un, deux, trois
419 ''' feminine: une, deux, trois
420 ''' masculine: un, deux, trois
421 ''' ordinal: premier, deuxième, troisième
422 ''' ordinal-feminine: première, deuxième, troisième
423 ''' ordinal-masculine: premier, deuxième, troisième
424 ''' informal: onze-cents, douze-cents, treize-cents
425 ''' Numbers may be prefixed by ISO currency codes (EUR, USD, ...)
426 ''' Locale: expressed as a locale combining language-COUNTRY (la-CO), or language alone (la)
427 ''' The list of supported languages can be found on
428 ''' https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1linguistic2_1_1XNumberText.html
429 ''' Return:
430 ''' The number or amount transformed in words
431 ''' Examples:
433 ''' regio.Number2Text("79,93", "fr-BE") ' septante-neuf virgule nonante-trois
434 ''' regio.Number2Text(Pi(), "pt-BR") ' três vírgula um quatro um cinco nove dois seis cinco três cinco oito nove sete nove
435 ''' regio.Number2Text("EUR 1234.56", "it") ' milleduecentotrentaquattro euro cinquantasei centesimi
437 Dim sNumber2Text As String ' Return value
438 Dim oLocale As Object ' com.sun.star.lang.Locale
439 Dim oNumber2Text As Object ' com.sun.star.linguistic2.NumberText
443 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
444 sNumber2Text = ""
446 Check:
447 If IsMissing(Locale) Or IsEmpty(Locale) Then Locale = ""
448 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
449 If Not SF_Utils._Validate(Number, "Number", Array(V_STRING, V_NUMERIC)) Then GoTo Finally
451 End If
453 Set oLocale = SF_Region._GetLocale(Locale, pbLanguage := True)
454 If IsNull(oLocale) Then GoTo Finally
456 Try:
458 sNumber2Text = oNumber2Text.getNumberText(Number, oLocale)
460 Finally:
461 Number2Text = sNumber2Text
462 SF_Utils._ExitFunction(cstThisSub)
463 Exit Function
464 Catch:
465 GoTo Finally
466 End Function ' ScriptForge.SF_Region.Number2Text
468 REM -----------------------------------------------------------------------------
469 Public Function Properties() As Variant
470 ''' Return the list or properties of the Region class as an array
472 Properties = Array( _
488 )
490 End Function ' ScriptForge.SF_Region.Properties
492 REM -----------------------------------------------------------------------------
493 Public Function TimeZoneOffset(Optional ByVal TimeZone As Variant _
494 , Optional ByVal Locale As Variant _
495 ) As Integer
496 ''' Computes the offset between GMT and the given timezone and locale
497 ''' Args
498 ''' TimeZone: specified as "Region/City" name like "Europe/Berlin", or a custom time zone ID such as "UTC" or "GMT-8:00"
499 ''' Locale: expressed as a locale combining language-COUNTRY (la-CO), or COUNTRY alone (CO)
500 ''' Return:
501 ''' The offset in minutes
502 ''' Examples:
503 ''' regio.TimeZoneOffset("Europe/Brussels", "fr-BE") ' 60
505 Dim iTimeZoneOffset As Integer ' Return value
506 Dim oLocale As Object ' com.sun.star.lang.Locale
507 Dim oCalendarImpl As Object ' com.sun.star.i18n.CalendarImpl
511 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
512 iTimeZoneOffset = 0
514 Check:
515 If IsMissing(Locale) Or IsEmpty(Locale) Then Locale = ""
516 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
519 End If
521 Set oLocale = SF_Region._GetLocale(Locale, pbCountry := True)
522 If IsNull(oLocale) Then GoTo Finally
524 Try:
526 With oCalendarImpl
527 .loadDefaultCalendarTZ(oLocale, TimeZone)
528 iTimeZoneOffset = .getValue(com.sun.star.i18n.CalendarFieldIndex.ZONE_OFFSET)
529 End With
531 Finally:
532 TimeZoneOffset = iTimeZoneOffset
533 SF_Utils._ExitFunction(cstThisSub)
534 Exit Function
535 Catch:
536 GoTo Finally
537 End Function ' ScriptForge.SF_Region.TimeZoneOffset
539 REM -----------------------------------------------------------------------------
540 Public Function UTCDateTime(Optional ByVal LocalDateTime As Variant _
541 , Optional ByVal TimeZone As Variant _
542 , Optional ByVal Locale As Variant _
543 ) As Date
544 ''' Computes the UTC date and time of a given local date and time
545 ''' Args
546 ''' LocalDateTime: the date and time measured in a given timezone
547 ''' TimeZone: specified as "Region/City" name like "Europe/Berlin", or a custom time zone ID such as "UTC" or "GMT-8:00"
548 ''' Locale: expressed as a locale combining language-COUNTRY (la-CO), or COUNTRY alone (CO)
549 ''' Return:
550 ''' The local time converted to the corresponding UTC date and time as a Date
551 ''' If the returned value is before 1900, it is likely that the Locale is not recognized
552 ''' If the returned value matches the local time, it is likely that the the timezone is not recognized
553 ''' Examples:
554 ''' regio.UTCDateTime(DateSerial(2022, 3, 20) + TimeSerial(17, 58, 17), "Europe/Brussels", "fr-BE")
557 Dim dUTCDateTime As Double ' Return value
558 Dim oLocale As Object ' com.sun.star.lang.Locale
559 Dim oCalendarImpl As Object ' com.sun.star.i18n.CalendarImpl
563 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
564 dUTCDateTime = -1
566 Check:
567 If IsMissing(Locale) Or IsEmpty(Locale) Then Locale = ""
568 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
572 End If
574 Set oLocale = SF_Region._GetLocale(Locale, pbCountry := True)
575 If IsNull(oLocale) Then GoTo Finally
577 Try:
579 With oCalendarImpl
580 .loadDefaultCalendarTZ(oLocale, TimeZone)
581 .setLocalDateTime(LocalDateTime)
582 dUTCDateTime = .getDateTime()
583 End With
585 Finally:
586 UTCDateTime = CDate(dUTCDateTime)
587 SF_Utils._ExitFunction(cstThisSub)
588 Exit Function
589 Catch:
590 GoTo Finally
591 End Function ' ScriptForge.SF_Region.UTCDateTime
593 REM -----------------------------------------------------------------------------
594 Public Function UTCNow(Optional ByVal TimeZone As Variant _
595 , Optional ByVal Locale As Variant _
596 ) As Date
597 ''' Computes the actual UTC date and time
598 ''' Args
599 ''' TimeZone: specified as "Region/City" name like "Europe/Berlin", or a custom time zone ID such as "UTC" or "GMT-8:00"
600 ''' Locale: expressed as a locale combining language-COUNTRY (la-CO), or COUNTRY alone (CO)
601 ''' Return:
602 ''' The actual UTC date and time as a Date
603 ''' If the returned value is before 1900, it is likely that the Locale is not recognized
604 ''' If the returned value matches the local time, it is likely that the the timezone is not recognized
605 ''' Examples:
606 ''' regio.UTCNow("Europe/Brussels", "fr-BE") ' 2022-03-20 16:58:17
608 Dim dUTCNow As Double ' Return value
609 Dim oLocale As Object ' com.sun.star.lang.Locale
610 Dim oCalendarImpl As Object ' com.sun.star.i18n.CalendarImpl
614 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
615 dUTCNow = -1
617 Check:
618 If IsMissing(Locale) Or IsEmpty(Locale) Then Locale = ""
619 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
622 End If
624 Set oLocale = SF_Region._GetLocale(Locale, pbCountry := True)
625 If IsNull(oLocale) Then GoTo Finally
627 Try:
629 With oCalendarImpl
630 .loadDefaultCalendarTZ(oLocale, TimeZone)
631 .setLocalDateTime(Now())
632 dUTCNow = .getDateTime()
633 End With
635 Finally:
636 UTCNow = CDate(dUTCNow)
637 SF_Utils._ExitFunction(cstThisSub)
638 Exit Function
639 Catch:
640 GoTo Finally
641 End Function ' ScriptForge.SF_Region.UTCNow
643 REM =========================================================== PRIVATE FUNCTIONS
645 REM -----------------------------------------------------------------------------
646 Private Function _GetLocale(ByVal psLocale As String _
647 , Optional ByVal pbCountry As Variant _
648 , Optional ByVal pbLanguage As Variant _
649 ) As Object
650 ''' Convert a locale given as a string to a com.sun.star.lang.Locale object
651 ''' Args:
652 ''' psLocale: the input string, as "la-CO", "la" or "CO"
655 ''' At most one out of pbLanguage or pbCountry may be True
656 ''' Returns:
657 ''' com.sun.star.lang.Locale
660 Dim iLocale As Integer ' Index in reference tables
661 Dim oLocale As Object ' Return value com.sun.star.lang.Locale
662 Dim i As Integer
664 If IsMissing(pbCountry) Or IsEmpty(pbCountry) Then pbCountry = False
665 If IsMissing(pbLanguage) Or IsEmpty(pbLanguage) Then pbLanguage = False
667 _LoadAllLocales() ' Initialize locale reference tables
669 Check:
670 ' The argument may be a language "la", a country "CO" or a Locale "la-CO"
671 ' Scan the reference tables to find a valid locale as a com.sun.star.lang.Locale
674 sLocale = UserLocale
675 iLocale = UserIndex
677 Select Case True
678 Case pbLanguage
679 ' Find any locale having the argument as language
680 For i = 0 To UBound(LocaleNames)
683 sLocale = LocaleNames(i)
684 iLocale = i
685 Exit For
686 End If
687 Next i
688 Case pbCountry
689 ' Find any locale having the argument as country
690 For i = 0 To UBound(LocaleNames)
692 If Right(LocaleNames(i), 2) = UCase(psLocale) Then
693 sLocale = LocaleNames(i)
694 iLocale = i
695 Exit For
696 End If
697 Next i
698 Case Else
699 End Select
700 Else ' A full locale is given
701 iLocale = SF_Array.IndexOf(LocaleNames, psLocale, CaseSensitive := False)
703 End If
705 Try:
706 ' Build error message when relevant
708 If Not SF_Utils._Validate(psLocale, "Locale", V_STRING, LocaleNames) Then GoTo Finally
709 Else
712 oLocale.Country = Right(sLocale, 2)
713 End If
715 Finally:
716 Set _GetLocale = oLocale
717 Exit Function
718 End Function ' ScriptForge.SF_Region._GetLocale
720 REM -----------------------------------------------------------------------------
721 Private Sub _LoadAllLocales()
722 ''' Initialize the LocaleNames array = the list of all available locales in the LibreOffice installation
724 Dim oOffice As Object ' com.sun.star.lang.Locale
725 Dim vLocales As Variant ' Array of com.sun.star.lang.Locale
726 Dim iTop As Integer ' Upper bound of LocaleNames
727 Dim i As Integer
729 Try:
730 ' Office locale
731 If Len(UserLocale) = 0 Then
734 End If
736 ' LocaleData, localeNames and UserIndex
737 If IsEmpty(LocaleData) Or IsNull(LocaleData) Or Not IsArray(LocaleNames) Then
739 vLocales = LocaleData.getAllInstalledLocaleNames()
740 LocaleNames = Array()
741 iTop = UBound(vLocales)
742 ReDim LocaleNames(0 To iTop)
743 For i = 0 To iTop
745 If LocaleNames(i) = UserLocale Then UserIndex = i
746 Next i
747 End If
749 End Sub ' ScriptForge.SF_Region._LoadAllLocales
751 REM -----------------------------------------------------------------------------
752 Private Function _PropertyGet(Optional ByVal psProperty As String _
753 , Optional ByVal pvLocale As Variant) As Variant
754 ''' Return the value of the named property
755 ''' Args:
756 ''' psProperty: the name of the property
757 ''' pvLocale: a locale in the form language-COUNTRY (la-CO) or language only, or country only
758 ''' When language or country only, any locale matching either the language or the country is selected
760 Dim oLocale As Object ' com.sun.star.lang.Locale
761 Dim vCurrencies As Variant ' Array of com.sun.star.i18n.Currency
762 Dim oCurrency As Object ' com.sun.star.i18n.Currency
763 Dim oLanguageCountryInfo As Object ' com.sun.star.i18n.LanguageCountryInfo
764 Dim oLocaleDataItem2 As Object ' com.sun.star.i18n.LocaleDataItem2
765 Dim oCalendarImpl As Object ' com.sun.star.i18n.CalendarImpl
766 Dim oCalItem As Object ' com.sun.star.i18n.CalendarItem2
767 Dim vCalItems() As Variant ' Array of days/months
768 Dim i As Integer, j As Integer
770 Dim cstThisSub As String
771 Const cstSubArgs = ""
774 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
776 Check:
777 If IsMissing(pvLocale) Or IsEmpty(pvLocale) Then pvLocale = ""
780 Select Case psProperty
782 Set oLocale = SF_Region._GetLocale(pvLocale, pbCountry := True) ' Country only is admitted
783 Case "Language", "DayNames", "DayAbbrevNames", "DayNarrowNames" _
785 Set oLocale = SF_Region._GetLocale(pvLocale, pbLanguage := True) ' Language only is admitted
786 Case Else
787 Set oLocale = SF_Region._GetLocale(pvLocale)
788 End Select
789 If IsNull(oLocale) Then GoTo Finally
791 Try:
792 Select Case psProperty
794 Set oLanguageCountryInfo = LocaleData.getLanguageCountryInfo(oLocale)
795 With oLanguageCountryInfo
796 If psProperty = "Country" Then _PropertyGet = .CountryDefaultName Else _PropertyGet = .LanguageDefaultName
797 End With
799 vCurrencies = LocaleData.getAllCurrencies(oLocale)
800 _PropertyGet = ""
801 For Each oCurrency In vCurrencies
802 If oCurrency.Default Then
803 _PropertyGet = oCurrency.BankSymbol
804 Exit For
805 End If
806 Next oCurrency
808 _PropertyGet = LocaleData.getDateAcceptancePatterns(oLocale)
809 Case "DateSeparator", "DecimalPoint", "ListSeparator", "ThousandSeparator", "TimeSeparator"
810 Set oLocaleDataItem2 = LocaleData.getLocaleItem2(oLocale)
811 With oLocaleDataItem2
812 Select Case psProperty
818 End Select
819 End With
822 With oCalendarImpl
823 .loadDefaultCalendar(oLocale)
825 For i = 0 To UBound(.Days2)
826 Set oCalItem = .Days2(i)
828 Select Case psProperty
832 End Select
833 Next i
834 _PropertyGet = vCalItems
835 End With
838 With oCalendarImpl
839 .loadDefaultCalendar(oLocale)
841 For i = 0 To UBound(.Months2)
842 Set oCalItem = .Months2(i)
843 Select Case psProperty
847 End Select
848 Next i
849 _PropertyGet = vCalItems
850 End With
851 Case Else
852 _PropertyGet = ""
853 End Select
855 Finally:
856 SF_Utils._ExitFunction(cstThisSub)
857 Exit Function
858 End Function ' ScriptForge.SF_Region._PropertyGet
860 REM ================================================ END OF SCRIPTFORGE.SF_REGION
861 </script:module>