Document new locale-related properties in SF_Platform

New properties are: FormatLocale, OfficeLocale and SystemLocale.

Change-Id: I9203a41c891f3c7491d78b8d2eede369d77679e6
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/129831
Tested-by: Jenkins
Reviewed-by: Alain Romedenne

1 files changed, 46 insertions, 2 deletions

diff --git a/source/text/sbasic/shared/03/sf_platform.xhp b/source/text/sbasic/shared/03/sf_platform.xhp
index 07a4c4c050..e6b94a9955 100644
--- a/source/text/sbasic/shared/03/sf_platform.xhp
+++ b/source/text/sbasic/shared/03/sf_platform.xhp
@@ -62,8 +62,10 @@
       <bookmark_value>Platform service;CurrentUser</bookmark_value>
       <bookmark_value>Platform service;Extensions</bookmark_value>
       <bookmark_value>Platform service;Fonts</bookmark_value>
+      <bookmark_value>Platform service;FormatLocale</bookmark_value>
       <bookmark_value>Platform service;Locale</bookmark_value>
       <bookmark_value>Platform service;Machine</bookmark_value>
+      <bookmark_value>Platform service;OfficeLocale</bookmark_value>
       <bookmark_value>Platform service;OfficeVersion</bookmark_value>
       <bookmark_value>Platform service;OSName</bookmark_value>
       <bookmark_value>Platform service;OSPlatform</bookmark_value>
@@ -72,6 +74,7 @@
       <bookmark_value>Platform service;Printers</bookmark_value>
       <bookmark_value>Platform service;Processor</bookmark_value>
       <bookmark_value>Platform service;PythonVersion</bookmark_value>
+      <bookmark_value>Platform service;SystemLocale</bookmark_value>
     </bookmark>
     <h2 id="hd_id711600788076834">Properties</h2>
     <table id="tab_id701600788076583">
@@ -175,6 +178,20 @@
         </tablerow>
         <tablerow>
             <tablecell>
+               <paragraph id="par_id831633021710186" localize="false" role="tablecontent">FormatLocale</paragraph>
+            </tablecell>
+           <tablecell>
+               <paragraph id="par_id561633021748013" role="tablecontent">Yes</paragraph>
+           </tablecell>
+           <tablecell>
+               <paragraph id="par_id201633021749655" localize="false" role="tablecontent">String</paragraph>
+           </tablecell>
+           <tablecell>
+               <paragraph id="par_id831633021749297" role="tablecontent">Returns the locale used for numbers and dates as a string in the format "la-CO" (language-COUNTRY).</paragraph>
+            </tablecell>
+        </tablerow>
+        <tablerow>
+            <tablecell>
                 <paragraph id="par_id831633021719022" localize="false" role="tablecontent">Locale</paragraph>
             </tablecell>
            <tablecell>
@@ -184,8 +201,7 @@
                <paragraph id="par_id201633021743058" localize="false" role="tablecontent">String</paragraph>
            </tablecell>
            <tablecell>
-               <paragraph id="par_id831633021749018" role="tablecontent">Returns the operating system locale as a string in the format language-COUNTRY (la-CO).</paragraph>
-               <paragraph id="par_id831633021745548" role="tablecontent">Examples: "en-US", "pt-BR", "fr-BE".</paragraph>
+               <paragraph id="par_id831633021749018" role="tablecontent">Returns the locale of the operating system as a string in the format "la-CO" (language-COUNTRY). This is equivalent to the <literal>SystemLocale</literal> property.</paragraph>
             </tablecell>
         </tablerow>
         <tablerow>
@@ -204,6 +220,20 @@
         </tablerow>
         <tablerow>
             <tablecell>
+               <paragraph id="par_id831633021710156" localize="false" role="tablecontent">OfficeLocale</paragraph>
+            </tablecell>
+           <tablecell>
+               <paragraph id="par_id561633021706513" role="tablecontent">Yes</paragraph>
+           </tablecell>
+           <tablecell>
+               <paragraph id="par_id201633021746335" localize="false" role="tablecontent">String</paragraph>
+           </tablecell>
+           <tablecell>
+               <paragraph id="par_id831633021741117" role="tablecontent">Returns the locale of the user interface as a string in the format "la-CO" (language-COUNTRY).</paragraph>
+            </tablecell>
+        </tablerow>
+        <tablerow>
+            <tablecell>
                 <paragraph id="par_id41600788076936" role="tablecontent" localize="false">OfficeVersion</paragraph>
             </tablecell>
             <tablecell>
@@ -319,6 +349,20 @@
                 <paragraph id="par_id661300789527994" role="tablecontent">Returns the version of the Python interpreter being used as a string in the format "Python major.minor.patchlevel" (ex: "Python 3.9.7").</paragraph>
             </tablecell>
         </tablerow>
+        <tablerow>
+            <tablecell>
+               <paragraph id="par_id83163302112358" localize="false" role="tablecontent">SystemLocale</paragraph>
+            </tablecell>
+           <tablecell>
+               <paragraph id="par_id561633021708547" role="tablecontent">Yes</paragraph>
+           </tablecell>
+           <tablecell>
+               <paragraph id="par_id201633021746229" localize="false" role="tablecontent">String</paragraph>
+           </tablecell>
+           <tablecell>
+               <paragraph id="par_id831633021741336" role="tablecontent">Returns the locale of the operating system as a string in the format "la-CO" (language-COUNTRY). This is equivalent to the <literal>Locale</literal> property.</paragraph>
+            </tablecell>
+        </tablerow>
     </table>
     <embed href="text/sbasic/shared/00000003.xhp#functexample"/>
     <paragraph role="paragraph" id="par_id311633022159446">The following examples in Basic and Python illustrate how to use the <literal>Fonts</literal> property to write the names of all available fonts to the current Calc sheet starting at cell "A1":</paragraph>