source/text/sbasic/shared/03104400.xhp | 3
source/text/sbasic/shared/03104600.xhp | 1
source/text/sbasic/shared/03131500.xhp | 41 ++++++
source/text/sbasic/shared/03131600.xhp | 31 +++++
source/text/sbasic/shared/03131800.xhp | 56 +++++++--
source/text/sbasic/shared/03132000.xhp | 125 +++++++++++++--------
source/text/sbasic/shared/03132300.xhp | 3
source/text/sbasic/shared/CreateUnoSvcWithArgs.xhp | 45 ++++++-
8 files changed, 237 insertions(+), 68 deletions(-)
New commits:
commit 4e20b30849bd3149067a8680cfb80d71008ff892
Author: Olivier Hallot <olivier.hal...@libreoffice.org>
AuthorDate: Mon Apr 14 19:55:59 2025 -0300
Commit: Olivier Hallot <olivier.hal...@libreoffice.org>
CommitDate: Wed Apr 16 14:46:36 2025 +0200
tdf#163745 BASIC help pages must explicitly state types of all arguments
+ refactor and tweaks
Change-Id: I39a88a35af32aac68e8ebfe566bce0fc927ceef3
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/184186
Reviewed-by: Olivier Hallot <olivier.hal...@libreoffice.org>
Tested-by: Jenkins
diff --git a/source/text/sbasic/shared/03104400.xhp
b/source/text/sbasic/shared/03104400.xhp
index 4c26846992..a8518a478a 100644
--- a/source/text/sbasic/shared/03104400.xhp
+++ b/source/text/sbasic/shared/03104400.xhp
@@ -84,5 +84,8 @@
<paragraph role="bascode" id="par_id741744649843190" localize="false">
Print bHas ' = True</paragraph>
<paragraph role="bascode" id="par_id41744649848326" localize="false">End
Sub</paragraph>
</bascode>
+<section id="relatedtopics">
+ <embed href="text/sbasic/shared/uno_objects.xhp#UnoObjects_h1"/>
+</section>
</body>
</helpdocument>
diff --git a/source/text/sbasic/shared/03104600.xhp
b/source/text/sbasic/shared/03104600.xhp
index 0b4e5b9188..9d7d3d7f38 100644
--- a/source/text/sbasic/shared/03104600.xhp
+++ b/source/text/sbasic/shared/03104600.xhp
@@ -99,6 +99,7 @@
<section id="relatedtopics">
<embed href="text/sbasic/shared/03102800.xhp#IsObject_h1"/>
+ <embed href="text/sbasic/shared/uno_objects.xhp#UnoObjects_h1"/>
</section>
</body>
</helpdocument>
diff --git a/source/text/sbasic/shared/03131500.xhp
b/source/text/sbasic/shared/03131500.xhp
index 6b29259c8f..09266f71e9 100644
--- a/source/text/sbasic/shared/03131500.xhp
+++ b/source/text/sbasic/shared/03131500.xhp
@@ -21,7 +21,7 @@
<helpdocument version="1.0">
<meta>
<topic id="textsbasicshared03131500xml" indexer="include"
status="PUBLISH">
- <title id="tit" xml-lang="en-US">CreateUnoStruct Function</title>
+ <title id="tit" >CreateUnoStruct Function</title>
<filename>/text/sbasic/shared/03131500.xhp</filename>
</topic>
<history>
@@ -30,20 +30,51 @@
</meta>
<body>
<section id="createunostruct">
- <bookmark xml-lang="en-US" branch="index"
id="bm_id3150499"><bookmark_value>CreateUnoStruct function</bookmark_value>
+ <bookmark branch="index"
id="bm_id3150499"><bookmark_value>CreateUnoStruct function</bookmark_value>
</bookmark>
<h1 id="hd_id3150499"><link
href="text/sbasic/shared/03131500.xhp">CreateUnoStruct Function</link></h1>
- <paragraph role="paragraph" id="par_id3150713"
xml-lang="en-US"><ahelp hid=".">Creates an instance of a Uno structure
type.</ahelp></paragraph>
+ <paragraph role="paragraph" id="par_id3150713" ><ahelp
hid=".">Creates an instance of a Uno structure type.</ahelp></paragraph>
</section>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
- <paragraph role="code" id="par_id3155341" xml-lang="en-US">oStruct =
CreateUnoStruct( Uno type name )</paragraph>
+ <paragraph role="code" id="par_id3155341" >oStruct = CreateUnoStruct(
UnoTypeName as String ) as Object</paragraph>
+ <embed href="text/sbasic/shared/00000003.xhp#functvalue"/>
+ <paragraph role="paragraph" id="par_id851677925987795">Object</paragraph>
+ <embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
+ <table id="tab_id611744667519485">
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id661744667519485" role="tablehead"
localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_name"
markup="ignore"/></paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id631744667519485" role="tablehead"
localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_type"
markup="ignore"/></paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id91744667519485" role="tablehead"
localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_desc"
markup="ignore"/></paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id181744667519485"
role="tablecontent">UnoTypeName</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id711744667519485" role="tablecontent"
localize="false">String</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id581744667519485"
role="tablecontent">Name of the UNO structure.</paragraph>
+ </tablecell>
+ </tablerow>
+ </table>
+
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<bascode>
<paragraph role="bascode" localize="false" id="par_id3149762">oStruct
= CreateUnoStruct( "com.sun.star.beans.Property" )</paragraph>
</bascode>
- <paragraph role="paragraph" id="par_id3147226" xml-lang="en-US">Or use
the following structure for your statement:</paragraph>
+ <paragraph role="paragraph" id="par_id3147226" >Or use the following
structure for your statement:</paragraph>
<bascode>
<paragraph role="bascode" id="par_id3149177" localize="false">Dim
oStruct as new com.sun.star.beans.Property</paragraph>
</bascode>
+ <section id="relatedtopics">
+ <embed href="text/sbasic/shared/uno_objects.xhp#UnoObjects_h1"/>
+ </section>
</body>
</helpdocument>
diff --git a/source/text/sbasic/shared/03131600.xhp
b/source/text/sbasic/shared/03131600.xhp
index 4d868a75d1..131621f1a2 100644
--- a/source/text/sbasic/shared/03131600.xhp
+++ b/source/text/sbasic/shared/03131600.xhp
@@ -37,7 +37,36 @@
<bascode>
<paragraph role="bascode" localize="false" id="bas_syntax">
CreateUnoService(serviceName As String) As Object</paragraph>
</bascode>
- <tip id="par_id921629989537850">For a list of available services, visit the
<link
href="https://api.libreoffice.org/docs/idl/ref/namespacecom_1_1sun_1_1star.html";>com::sun::star
Module</link> reference page.</tip>
+
+ <embed href="text/sbasic/shared/00000003.xhp#functvalue"/>
+ <paragraph role="paragraph" id="par_id851677925987795">Object</paragraph>
+
+ <embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
+ <table id="tab_id971744666698689">
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id591744666698689" role="tablehead"
localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_name"
markup="ignore"/></paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id611744666698689" role="tablehead"
localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_type"
markup="ignore"/></paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id441744666698689" role="tablehead"
localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_desc"
markup="ignore"/></paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id601744666698689"
role="tablecontent">serviceName</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id861744666698689" role="tablecontent"
localize="false">String</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id621744666698689" role="tablecontent">The service
name.</paragraph>
+ <paragraph id="par_id921629989537850" role="tablecontent">For a list
of available services, visit the <link
href="https://api.libreoffice.org/docs/idl/ref/namespacecom_1_1sun_1_1star.html";>com::sun::star
Module</link> reference page.</paragraph>
+ </tablecell>
+ </tablerow>
+ </table>
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<paragraph role="paragraph" id="par_id891561653344669">The example below
creates the function <literal>FileExists</literal> that uses the service
<literal>com.sun.star.ucb.SimpleFileAccess</literal> to test if a given path is
an existing file.</paragraph>
<bascode>
diff --git a/source/text/sbasic/shared/03131800.xhp
b/source/text/sbasic/shared/03131800.xhp
index a9ca58db4c..9b55c3787e 100644
--- a/source/text/sbasic/shared/03131800.xhp
+++ b/source/text/sbasic/shared/03131800.xhp
@@ -21,7 +21,7 @@
<helpdocument version="1.0">
<meta>
<topic id="textsbasicshared03131800xml" indexer="include" status="PUBLISH">
-<title id="tit" xml-lang="en-US">CreateUnoDialog Function</title>
+<title id="tit" >CreateUnoDialog Function</title>
<filename>/text/sbasic/shared/03131800.xhp</filename>
</topic>
<history>
@@ -31,24 +31,56 @@
<body>
<section id="createunodialog">
-<bookmark xml-lang="en-US" branch="index" id="bm_id3150040">
+<bookmark branch="index" id="bm_id3150040">
<bookmark_value>CreateUnoDialog function</bookmark_value>
</bookmark>
<h1 id="hd_id3150040"><link
href="text/sbasic/shared/03131800.xhp">CreateUnoDialog Function</link></h1>
-<paragraph role="paragraph" id="par_id3154186" xml-lang="en-US">Creates a
Basic Uno object that represents a Uno dialog control during Basic
runtime.</paragraph>
+<paragraph role="paragraph" id="par_id3154186" >Creates a Basic Uno object
that represents a Uno dialog control during Basic runtime.</paragraph>
</section>
-<paragraph role="paragraph" id="par_id3153750" xml-lang="en-US">Dialogs are
defined in the dialog libraries. To display a dialog, a "live" dialog must be
created from the library.</paragraph>
-<paragraph role="paragraph" id="par_id3153681" xml-lang="en-US">See <link
href="text/sbasic/guide/sample_code.xhp">Examples</link>.</paragraph>
+<paragraph role="paragraph" id="par_id3153750" >Dialogs are defined in the
dialog libraries. To display a dialog, a "live" dialog must be created from the
library.</paragraph>
+<paragraph role="paragraph" id="par_id3153681" >See <link
href="text/sbasic/guide/sample_code.xhp">Examples</link>.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
-<paragraph role="code" localize="false" id="par_id3159176"
xml-lang="en-US">CreateUnoDialog( oDlgDesc )</paragraph>
+<paragraph role="code" localize="false" id="par_id3159176" >CreateUnoDialog(
oDlgDesc )</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functvalue"/>
+<paragraph role="paragraph" localize="false"
id="par_id3148538">Object</paragraph>
+
+<embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
+<table id="tab_id851744670127729">
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id671744670127729" role="tablehead"
localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_name"
markup="ignore"/></paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id331744670127730" role="tablehead"
localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_type"
markup="ignore"/></paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id531744670127730" role="tablehead"
localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_desc"
markup="ignore"/></paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id991744670127730"
role="tablecontent">oDlgDesc</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id251744670127730" role="tablecontent"
localize="false">Object</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id541744670127730" role="tablecontent">The dialog
object stored in a library.</paragraph>
+ </tablecell>
+ </tablerow>
+</table>
+
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<bascode>
- <paragraph id="par_id3159157" role="bascode" xml-lang="en-US">' Get dialog
description from the dialog library</paragraph>
- <paragraph id="par_id3149234" role="bascode" localize="false"
xml-lang="en-US">oDlgDesc = DialogLibraries.Standard.Dialog1</paragraph>
- <paragraph id="par_id3154923" role="bascode" xml-lang="en-US">' Generate
"live" dialog</paragraph>
- <paragraph id="par_id3149670" role="bascode" localize="false"
xml-lang="en-US">oDlgControl = CreateUnoDialog( oDlgDesc )</paragraph>
- <paragraph id="par_id3148550" role="bascode" xml-lang="en-US">' display
"live" dialog</paragraph>
- <paragraph id="par_id3154072" role="bascode" localize="false"
xml-lang="en-US">oDlgControl.execute</paragraph>
+ <paragraph id="par_id3159157" role="bascode" >' Get dialog description from
the dialog library</paragraph>
+ <paragraph id="par_id3149234" role="bascode" localize="false" >oDlgDesc =
DialogLibraries.Standard.Dialog1</paragraph>
+ <paragraph id="par_id3154923" role="bascode" >' Generate "live"
dialog</paragraph>
+ <paragraph id="par_id3149670" role="bascode" localize="false" >oDlgControl =
CreateUnoDialog( oDlgDesc )</paragraph>
+ <paragraph id="par_id3148550" role="bascode" >' display "live"
dialog</paragraph>
+ <paragraph id="par_id3154072" role="bascode" localize="false"
>oDlgControl.execute</paragraph>
</bascode>
+<section id="relatedtopics">
+ <embed href="text/sbasic/shared/uno_objects.xhp#UnoObjects_h1"/>
+</section>
</body>
</helpdocument>
diff --git a/source/text/sbasic/shared/03132000.xhp
b/source/text/sbasic/shared/03132000.xhp
index 7a29072760..9fde7ee11f 100644
--- a/source/text/sbasic/shared/03132000.xhp
+++ b/source/text/sbasic/shared/03132000.xhp
@@ -20,7 +20,7 @@
<meta>
<topic id="textsbasicshared03132000xml" indexer="include" status="PUBLISH">
- <title id="tit" xml-lang="en-US">CreateUnoListener Function</title>
+ <title id="tit">CreateUnoListener Function</title>
<filename>/text/sbasic/shared/03132000.xhp</filename>
</topic>
</meta>
@@ -28,41 +28,75 @@
<body>
<section id="createunolistener">
-<bookmark xml-lang="en-US" branch="index" id="bm_id3155150">
+<bookmark branch="index" id="bm_id3155150">
<bookmark_value>CreateUnoListener function</bookmark_value>
</bookmark>
-<h1 id="hd_id3155150" xml-lang="en-US"><variable id="CreateUnoListener"><link
href="text/sbasic/shared/03132000.xhp">CreateUnoListener
Function</link></variable></h1>
-<paragraph id="par_id3149346" role="paragraph" xml-lang="en-US">Creates a
Listener instance.</paragraph>
+<h1 id="hd_id3155150"><variable id="CreateUnoListener"><link
href="text/sbasic/shared/03132000.xhp">CreateUnoListener
Function</link></variable></h1>
+<paragraph id="par_id3149346" role="paragraph">Creates a Listener
instance.</paragraph>
</section>
-<paragraph id="par_id3153681" role="paragraph" xml-lang="en-US">Many Uno
objects let you register listeners with dedicated listener interfaces. This
allows to listen for specific events and call up the appropriate listener
method. The <literal>CreateUnoListener</literal> function sets a listener
interface associated to an UNO object. The listener interface is then bound to
its associated object.</paragraph>
+<paragraph id="par_id3153681" role="paragraph">Many Uno objects let you
register listeners with dedicated listener interfaces. This allows to listen
for specific events and call up the appropriate listener method. The
<literal>CreateUnoListener</literal> function sets a listener interface
associated to an UNO object. The listener interface is then bound to its
associated object.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<bascode>
<paragraph role="bascode" id="bas_id681666359376854" localize="false">
CreateUnoListener( Prefix As String, Typename As String) As Object</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
-<paragraph role="paragraph" id="par_id531666699350617"><emph>Prefix</emph>: A
text prefix used in BASIC subroutines that handle events.</paragraph>
-<paragraph role="paragraph" id="par_id281666699351161"><emph>Typename</emph>:
A fully qualified UNO listener interface name.</paragraph>
+<table id="tab_id751744670502583">
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id981744670502583" role="tablehead"
localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_name"
markup="ignore"/></paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id281744670502583" role="tablehead"
localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_type"
markup="ignore"/></paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id671744670502583" role="tablehead"
localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_desc"
markup="ignore"/></paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id241744670502583"
role="tablecontent">Prefix</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id461744670502583" role="tablecontent"
localize="false">String</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id11744670502583" role="tablecontent">A text prefix
used in BASIC subroutines that handle events.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id241744670502584"
role="tablecontent">Typename</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id951744670502584" role="tablecontent"
localize="false">String</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id601744670502584" role="tablecontent">A fully
qualified UNO listener interface name.</paragraph>
+ </tablecell>
+ </tablerow>
+</table>
+
<embed href="text/sbasic/shared/00000003.xhp#functvalue"/>
-<paragraph role="paragraph" id="par_id241666699584417">The UNO service
corresponding to the <literal>Typename</literal> listener interface name,
<literal>Null</literal> value otherwise.</paragraph>
+<paragraph role="paragraph" id="par_id241666699584417">Object. The UNO service
corresponding to the <literal>Typename</literal> listener interface name,
<literal>Null</literal> value otherwise.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
-<paragraph id="par_id3154046" role="paragraph" xml-lang="en-US">The following
example listens to events occurring for a BASIC library object.</paragraph>
+<paragraph id="par_id3154046" role="paragraph">The following example listens
to events occurring for a BASIC library object.</paragraph>
<bascode>
-<paragraph id="par_idm1340547456" role="bascode" localize="false"
xml-lang="en-US">Dim oListener As Object</paragraph>
-<paragraph id="par_idm1340546224" role="bascode" localize="false"
xml-lang="en-US">oListener = CreateUnoListener(
"ContListener_","com.sun.star.container.XContainerListener" )</paragraph>
+<paragraph id="par_idm1340547456" role="bascode" localize="false">Dim
oListener As Object</paragraph>
+<paragraph id="par_idm1340546224" role="bascode" localize="false">oListener =
CreateUnoListener( "ContListener_","com.sun.star.container.XContainerListener"
)</paragraph>
</bascode>
-<paragraph id="par_id3149294" role="paragraph" xml-lang="en-US">The
<literal>CreateUnoListener</literal> method requires two parameters. The first
is <emph>Prefix</emph> and is explained in detail below. <emph>Typename</emph>
second parameter is the fully qualified name of the listener
interface.</paragraph>
-<paragraph id="par_id3149670" role="paragraph" xml-lang="en-US">Every listener
must be registered to %PRODUCTNAME broadcaster feature. This is performed by
binding each listener to its associated object. Bind methods always follow the
pattern '<literal>add</literal>Foo<literal>Listener</literal>', where 'Foo' is
the object type of the listener interface, without the 'X'. In this example,
the <link
href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1container_1_1XContainer.html#a69e03a743cfa3e99935cac90b5f4e291";><literal>addContainerListener</literal></link>
method is called to register the
<literal>XContainerListener</literal>:</paragraph>
+<paragraph id="par_id3149294" role="paragraph">The
<literal>CreateUnoListener</literal> method requires two parameters. The first
is <emph>Prefix</emph> and is explained in detail below. <emph>Typename</emph>
second parameter is the fully qualified name of the listener
interface.</paragraph>
+<paragraph id="par_id3149670" role="paragraph">Every listener must be
registered to %PRODUCTNAME broadcaster feature. This is performed by binding
each listener to its associated object. Bind methods always follow the pattern
'<literal>add</literal>Foo<literal>Listener</literal>', where 'Foo' is the
object type of the listener interface, without the 'X'. In this example, the
<link
href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1container_1_1XContainer.html#a69e03a743cfa3e99935cac90b5f4e291";><literal>addContainerListener</literal></link>
method is called to register the
<literal>XContainerListener</literal>:</paragraph>
<bascode>
-<paragraph id="par_idm1340540544" role="bascode" localize="false"
xml-lang="en-US">Dim oLib As Object</paragraph>
-<paragraph id="par_id3154940" role="bascode" xml-lang="en-US">oLib =
BasicLibraries.Library1 ' Library1 must exist!</paragraph>
-<paragraph id="par_id3150359" role="bascode"
xml-lang="en-US">oLib.addContainerListener( oListener ) ' Register the
listener</paragraph>
+<paragraph id="par_idm1340540544" role="bascode" localize="false">Dim oLib As
Object</paragraph>
+<paragraph id="par_id3154940" role="bascode">oLib = BasicLibraries.Library1 '
Library1 must exist!</paragraph>
+<paragraph id="par_id3150359" role="bascode">oLib.addContainerListener(
oListener ) ' Register the listener</paragraph>
</bascode>
-<paragraph id="par_id3154138" role="paragraph" xml-lang="en-US">The listener
is now registered. When an event occurs, the active listener calls the
appropriate method defined in <link
href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1container_1_1XContainerListener.html";>com.sun.star.container.XContainerListener</link>
interface.</paragraph>
+<paragraph id="par_id3154138" role="paragraph">The listener is now registered.
When an event occurs, the active listener calls the appropriate method defined
in <link
href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1container_1_1XContainerListener.html";>com.sun.star.container.XContainerListener</link>
interface.</paragraph>
- <paragraph id="par_id3148922" role="paragraph" xml-lang="en-US">Event-driven
registered BASIC subroutines require to use a defined <emph>Prefix</emph>. The
BASIC run-time system searches for subroutines or functions that have the name
'Prefix+ListenerMethod' and calls them when found. Otherwise, a run-time error
occurs.</paragraph>
-<paragraph id="par_id3150768" role="paragraph" xml-lang="en-US">In this
example, <link
href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1container_1_1XContainerListener-members.html";>com.sun.star.container.XContainerListener</link>
interface defines the following methods:</paragraph>
+ <paragraph id="par_id3148922" role="paragraph">Event-driven registered BASIC
subroutines require to use a defined <emph>Prefix</emph>. The BASIC run-time
system searches for subroutines or functions that have the name
'Prefix+ListenerMethod' and calls them when found. Otherwise, a run-time error
occurs.</paragraph>
+<paragraph id="par_id3150768" role="paragraph">In this example, <link
href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1container_1_1XContainerListener-members.html";>com.sun.star.container.XContainerListener</link>
interface defines the following methods:</paragraph>
<table id="tab_id591666342054257">
<tablerow>
<tablecell>
@@ -106,46 +140,46 @@
</tablerow>
</table>
-<paragraph id="par_id3147435" role="paragraph"
xml-lang="en-US">'ContListener_' used in this example implies that the
following subroutines must be implemented in BASIC:</paragraph>
+<paragraph id="par_id3147435" role="paragraph">'ContListener_' used in this
example implies that the following subroutines must be implemented in
BASIC:</paragraph>
<list type="unordered">
<listitem>
- <paragraph id="par_id3155411" role="listitem" xml-lang="en-US"
localize="false">ContListener_<literal>disposing</literal></paragraph>
+ <paragraph id="par_id3155411" role="listitem"
localize="false">ContListener_<literal>disposing</literal></paragraph>
</listitem>
<listitem>
- <paragraph id="par_id3146923" role="listitem" xml-lang="en-US"
localize="false">ContListener_<literal>elementInserted</literal></paragraph>
+ <paragraph id="par_id3146923" role="listitem"
localize="false">ContListener_<literal>elementInserted</literal></paragraph>
</listitem>
<listitem>
- <paragraph id="par_id3147318" role="listitem" xml-lang="en-US"
localize="false">ContListener_<literal>elementRemoved</literal></paragraph>
+ <paragraph id="par_id3147318" role="listitem"
localize="false">ContListener_<literal>elementRemoved</literal></paragraph>
</listitem>
<listitem>
- <paragraph id="par_id3152578" role="listitem" xml-lang="en-US"
localize="false">ContListener_<literal>elementReplaced</literal></paragraph>
+ <paragraph id="par_id3152578" role="listitem"
localize="false">ContListener_<literal>elementReplaced</literal></paragraph>
</listitem></list>
-<paragraph id="par_id3150592" role="paragraph" xml-lang="en-US">Every listener
interface defines a set of controlled event names associated to Uno objects.
When an event occurs, it is sent to the method as a parameter. BASIC event
methods can also call one another, as long as the appropriate parameter is
passed in the <literal>Sub</literal> declaration. For example:</paragraph>
+<paragraph id="par_id3150592" role="paragraph">Every listener interface
defines a set of controlled event names associated to Uno objects. When an
event occurs, it is sent to the method as a parameter. BASIC event methods can
also call one another, as long as the appropriate parameter is passed in the
<literal>Sub</literal> declaration. For example:</paragraph>
<bascode>
-<paragraph id="par_idm1340499136" role="bascode" localize="false"
xml-lang="en-US">Sub ContListener_disposing( oEvent As
com.sun.star.lang.EventObject )</paragraph>
-<paragraph id="par_id31538768025" role="bascode" localize="false"
xml-lang="en-US"> MsgBox "disposing"</paragraph>
-<paragraph id="par_idm1340684736" role="bascode" localize="false"
xml-lang="en-US">End Sub</paragraph>
-<paragraph id="par_idm1340683504" role="bascode" localize="false"
xml-lang="en-US"> </paragraph>
-<paragraph id="par_idm1340682256" role="bascode" localize="false"
xml-lang="en-US">Sub ContListener_elementInserted( oEvent As
com.sun.star.container.ContainerEvent )</paragraph>
-<paragraph id="par_id31540984458" role="bascode" localize="false"
xml-lang="en-US"> MsgBox oEvent.Source.' "elementInserted"</paragraph>
-<paragraph id="par_idm1340678016" role="bascode" localize="false"
xml-lang="en-US">End Sub</paragraph>
-<paragraph id="par_idm1340676784" role="bascode" localize="false"
xml-lang="en-US"> </paragraph>
-<paragraph id="par_idm1340675584" role="bascode" localize="false"
xml-lang="en-US">Sub ContListener_elementRemoved( oEvent As
com.sun.star.container.ContainerEvent )</paragraph>
-<paragraph id="par_id31539470236" role="bascode" localize="false"
xml-lang="en-US"> MsgBox "elementRemoved"</paragraph>
-<paragraph id="par_idm1340671296" role="bascode" localize="false"
xml-lang="en-US">End Sub</paragraph>
-<paragraph id="par_idm1340670064" role="bascode" localize="false"
xml-lang="en-US"> </paragraph>
-<paragraph id="par_idm1340668864" role="bascode" localize="false"
xml-lang="en-US">Sub ContListener_elementReplaced( oEvent As
com.sun.star.container.ContainerEvent )</paragraph>
-<paragraph id="par_id31489150148" role="bascode" localize="false"
xml-lang="en-US"> MsgBox "elementReplaced"</paragraph>
-<paragraph id="par_idm1340664576" role="bascode" localize="false"
xml-lang="en-US">End Sub</paragraph>
+<paragraph id="par_idm1340499136" role="bascode" localize="false">Sub
ContListener_disposing( oEvent As com.sun.star.lang.EventObject )</paragraph>
+<paragraph id="par_id31538768025" role="bascode" localize="false"> MsgBox
"disposing"</paragraph>
+<paragraph id="par_idm1340684736" role="bascode" localize="false">End
Sub</paragraph>
+<paragraph id="par_idm1340683504" role="bascode" localize="false"> </paragraph>
+<paragraph id="par_idm1340682256" role="bascode" localize="false">Sub
ContListener_elementInserted( oEvent As com.sun.star.container.ContainerEvent
)</paragraph>
+<paragraph id="par_id31540984458" role="bascode" localize="false"> MsgBox
oEvent.Source.' "elementInserted"</paragraph>
+<paragraph id="par_idm1340678016" role="bascode" localize="false">End
Sub</paragraph>
+<paragraph id="par_idm1340676784" role="bascode" localize="false"> </paragraph>
+<paragraph id="par_idm1340675584" role="bascode" localize="false">Sub
ContListener_elementRemoved( oEvent As com.sun.star.container.ContainerEvent
)</paragraph>
+<paragraph id="par_id31539470236" role="bascode" localize="false"> MsgBox
"elementRemoved"</paragraph>
+<paragraph id="par_idm1340671296" role="bascode" localize="false">End
Sub</paragraph>
+<paragraph id="par_idm1340670064" role="bascode" localize="false"> </paragraph>
+<paragraph id="par_idm1340668864" role="bascode" localize="false">Sub
ContListener_elementReplaced( oEvent As com.sun.star.container.ContainerEvent
)</paragraph>
+<paragraph id="par_id31489150148" role="bascode" localize="false"> MsgBox
"elementReplaced"</paragraph>
+<paragraph id="par_idm1340664576" role="bascode" localize="false">End
Sub</paragraph>
</bascode>
-<paragraph id="par_id3156056" role="paragraph" xml-lang="en-US">Not need to
include the event object parameter when not used:</paragraph>
+<paragraph id="par_id3156056" role="paragraph">Not need to include the event
object parameter when not used:</paragraph>
<bascode>
-<paragraph id="par_id3150042" role="bascode" xml-lang="en-US">' Minimal
implementation of Sub disposing</paragraph>
+<paragraph id="par_id3150042" role="bascode">' Minimal implementation of Sub
disposing</paragraph>
<paragraph id="par_idm1340659344" role="bascode" localize="false">Sub
ContListener_disposing</paragraph>
<paragraph id="par_idm1340658096" role="bascode" localize="false">End
Sub</paragraph>
</bascode>
-<warning id="par_id621666343214282" xml-lang="en-US">Listener methods must
<emph>always</emph> be implemented to avoid BASIC run-time errors.</warning>
+<warning id="par_id621666343214282">Listener methods must <emph>always</emph>
be implemented to avoid BASIC run-time errors.</warning>
<tip id="par_id101666620765251">Use <link
href="text/sbasic/shared/03/sf_exception.xhp"><literal>ScriptForge</literal></link>
library console when the BASIC IDE is not easily accessible, that is during
events processing. Use the <link
href="text/sbasic/shared/03/sf_exception.xhp#DebugPrint"><literal>DebugPrint</literal></link>
method to add any relevant information to the console. Console entries can be
dumped to a text file or visualized in a dialog window. Use
<literal>Trace</literal> module of <link
href="text/sbasic/guide/access2base.xhp"><literal>Access2Base</literal></link>
library as an alternative</tip>
<bascode>
<paragraph role="bascode" id="bas_id871666620966333" localize="false">Sub
SF_Trace</paragraph>
@@ -154,7 +188,7 @@
<paragraph role="bascode" id="bas_id821666620967245" localize="false">
svc.Console modal:=False</paragraph>
<paragraph role="bascode" id="bas_id741666621069519" localize="false">
svc.DebugPrint("Lorem", "Ipsum", "...")</paragraph>
<paragraph role="bascode" id="bas_id771666620967685" localize="false">End
Sub ' SF_Trace</paragraph>
- <paragraph role="bascode" id="bas_id451666683735574"
localize="false"></paragraph>
+ <paragraph role="bascode" id="bas_id451666683735574" localize="false"/>
<paragraph role="bascode" id="bas_id261666683736832" localize="false">Sub
A2B_Trace</paragraph>
<paragraph role="bascode" id="bas_id61666683737033" localize="false">
GlobalScope.BasicLibraries.LoadLibrary("Access2Base")</paragraph>
<paragraph role="bascode" id="bas_id301666683737232" localize="false">
Access2Base.Trace.DebugPrint("Lorem", "Ipsum", "...")</paragraph>
@@ -162,12 +196,13 @@
<paragraph role="bascode" id="bas_id251666683738645" localize="false">End
Sub ' A2B_Trace</paragraph>
</bascode>
- <section id="relatedtopics" >
+ <section id="relatedtopics">
<embed href="text/sbasic/python/python_listener.xhp#pythonlistener"/>
<paragraph role="paragraph" id="N0506"><link
href="text/swriter/01/05060700.xhp">Events mapping to objects</link></paragraph>
<paragraph role="paragraph" id="N0509">See also <link
href="text/sbasic/shared/01040000.xhp">Document events</link>, <link
href="text/shared/02/01170202.xhp">Form events</link>.</paragraph>
<embed href="text/sbasic/python/python_handler.xhp#pythonhandler_h1"/>
<embed
href="text/sbasic/python/python_document_events.xhp#pythonmonitor"/>
+ <embed href="text/sbasic/shared/uno_objects.xhp#UnoObjects_h1"/>
</section>
</body>
diff --git a/source/text/sbasic/shared/03132300.xhp
b/source/text/sbasic/shared/03132300.xhp
index ef7a646379..a91fa49b20 100644
--- a/source/text/sbasic/shared/03132300.xhp
+++ b/source/text/sbasic/shared/03132300.xhp
@@ -98,5 +98,8 @@
<paragraph role="bascode" id="bas_id181677936010027" localize="false">End
With </paragraph>
</bascode>
<paragraph role="paragraph" id="par_id3150769">You can also use this function
to pass non-Any values, but this is not recommended. If Basic already knows the
target type, using the <literal>CreateUnoValue()</literal> function will only
lead to additional converting operations that slow down the Basic
execution.</paragraph>
+<section id="relatedtopics">
+ <embed href="text/sbasic/shared/uno_objects.xhp#UnoObjects_h1"/>
+</section>
</body>
</helpdocument>
diff --git a/source/text/sbasic/shared/CreateUnoSvcWithArgs.xhp
b/source/text/sbasic/shared/CreateUnoSvcWithArgs.xhp
index 611f04e462..4e31cbf095 100644
--- a/source/text/sbasic/shared/CreateUnoSvcWithArgs.xhp
+++ b/source/text/sbasic/shared/CreateUnoSvcWithArgs.xhp
@@ -34,15 +34,50 @@
</section>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<bascode>
- <paragraph role="bascode" localize="false" id="bas_syntax">
CreateUnoServiceWithArguments(ServiceName As String, Arguments() As Variant) As
Object</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_syntax">CreateUnoServiceWithArguments(ServiceName As String,
Arguments() As Variant) As Object</paragraph>
</bascode>
<tip id="par_id301666950633646">UNO services that can be used with
<literal>CreateUnoServiceWithArguments</literal> function are identifiable with
method names that follow a <literal>createInstanceWith..</literal> or
<literal>createWith..</literal> naming pattern.</tip>
- <embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
- <paragraph role="paragraph"
id="par_id781666942583785"><emph>ServiceName</emph>: The UNO service name to be
created.</paragraph>
- <paragraph role="paragraph"
id="par_id11666942585785"><emph>Arguments</emph>: One to many arguments that
specify the instance of the service. <emph>Arguments</emph> are stored as a one
dimensional array, according to their positions in the constructor method
definition.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functvalue"/>
- <paragraph role="paragraph" id="par_id311666942529939">An instance of the
given UNO service name, otherwise <literal>Null</literal> value.</paragraph>
+ <paragraph role="paragraph" id="par_id311666942529939">Object</paragraph>
<note id="par_id921629989537850">For a list of available services, visit the
<link
href="https://api.libreoffice.org/docs/idl/ref/namespacecom_1_1sun_1_1star.html";>com::sun::star
Module</link> reference page.</note>
+
+ <embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
+ <table id="tab_id971744665754543">
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id161744665754543" role="tablehead"
localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_name"
markup="ignore"/></paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id551744665754543" role="tablehead"
localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_type"
markup="ignore"/></paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id201744665754543" role="tablehead"
localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#param_desc"
markup="ignore"/></paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id951744665754544"
role="tablecontent">ServiceName</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id11744665754544" role="tablecontent"
localize="false">String</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id111744665754544" role="tablecontent">The UNO
service name to be created.</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id691744665754544"
role="tablecontent">Arguments</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id921744665754544" role="tablecontent"
localize="false">Variant</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id971744665754544" role="tablecontent">One to many
arguments that specify the instance of the service. <emph>Arguments</emph> are
stored as a one dimensional array, according to their positions in the
constructor method definition.</paragraph>
+ </tablecell>
+ </tablerow>
+ </table>
+
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<paragraph role="paragraph" id="par_id891561653344669">The
<literal>com.sun.star.ui.dialogs.FilePicker</literal> example below displays a
built-in %PRODUCTNAME <emph>Save As</emph> dialog with two extra controls: a
listbox and a checkbox.</paragraph>
<bascode>
