[Libreoffice-commits] help.git: AllLangHelp_sbasic.mk source/text
Alain Romedenne (via logerrit)
logerrit at kemper.freedesktop.org
Mon Mar 22 16:54:17 UTC 2021
AllLangHelp_sbasic.mk | 1
source/text/sbasic/shared/03/avail_release.xhp | 45 +
source/text/sbasic/shared/03/sf_dialog.xhp | 190 ++++++--
source/text/sbasic/shared/03/sf_dialogcontrol.xhp | 506 +++++++++++++++++++---
4 files changed, 650 insertions(+), 92 deletions(-)
New commits:
commit ee7094d416ec829e7281b6a5dab0aea1d21acf59
Author: Alain Romedenne <alain.romedenne at libreoffice.org>
AuthorDate: Wed Feb 17 16:07:30 2021 +0100
Commit: Rafael Lima <rafael.palma.lima at gmail.com>
CommitDate: Mon Mar 22 17:53:56 2021 +0100
sf_dialog, sf_dialogcontrol as of 7.2
Change-Id: I970cf55070e21d4c69464cc0984fe1d1dfe894b2
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/111044
Tested-by: Jenkins
Reviewed-by: Rafael Lima <rafael.palma.lima at gmail.com>
diff --git a/AllLangHelp_sbasic.mk b/AllLangHelp_sbasic.mk
index 65fc41da7..0b2633a92 100644
--- a/AllLangHelp_sbasic.mk
+++ b/AllLangHelp_sbasic.mk
@@ -69,6 +69,7 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,sbasic,\
helpcontent2/source/text/sbasic/shared/02/11180000 \
helpcontent2/source/text/sbasic/shared/02/11190000 \
helpcontent2/source/text/sbasic/shared/02/20000000 \
+ helpcontent2/source/text/sbasic/shared/03/avail_release \
helpcontent2/source/text/sbasic/shared/03/lib_tools \
helpcontent2/source/text/sbasic/shared/03/lib_euro \
helpcontent2/source/text/sbasic/shared/03/lib_depot \
diff --git a/source/text/sbasic/shared/03/avail_release.xhp b/source/text/sbasic/shared/03/avail_release.xhp
new file mode 100644
index 000000000..a7666f637
--- /dev/null
+++ b/source/text/sbasic/shared/03/avail_release.xhp
@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<helpdocument version="1.0">
+ <!--
+ * 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/.
+ *
+ -->
+
+ <meta>
+ <topic id="availablerelease" indexer="include" status="PUBLISH">
+ <title id="tit" xml-lang="en-US">(Un)Available since release</title>
+ <filename>/text/sbasic/shared/03/avail_release.xhp</filename>
+ </topic>
+ </meta>
+
+ <body>
+ <section id="UnAvailBasicMethod"><note id="not_BasMeth">This method is not available in Basic.</note></section>
+ <section id="UnAvailBasicProperty"><note id="not_BasProp">This property is not available in Basic.</note></section>
+ <section id="UnAvailPythonMethod"><note id="not_PycMeth">This method is not available in Python.</note></section>
+ <section id="UnAvailPythonProperty"><note id="not_PycProp">This property is not available in Python.</note></section>
+ <!--
+ <section id="7.2.service">
+ <note id="par_id651551701041690">This service is available from %PRODUCTNAME 7.2 onwards.</note>
+ </section> -->
+ <section id="7.2.methods">
+ <note id="par_id281613660174140">These methods are available from %PRODUCTNAME 7.2 onwards.</note>
+ </section>
+<!--<section id="7.2.method">
+ <note id="par_id291613654389792">This method is available from %PRODUCTNAME 7.2 onwards.</note>
+ </section> -->
+ <section id="7.2.control">
+ <note id="par_id981613655373210">This control is available from %PRODUCTNAME 7.2 onwards.</note>
+ </section>
+ <section id="7.2.events">
+ <note id="par_id831613654401663">These event properties are available from %PRODUCTNAME 7.2 onwards.</note>
+ </section>
+ <section id="7.2.property">
+ <note id="par_id201613654395537">This property is available from %PRODUCTNAME 7.2 onwards.</note>
+ </section>
+
+</body>
+</helpdocument>
\ No newline at end of file
diff --git a/source/text/sbasic/shared/03/sf_dialog.xhp b/source/text/sbasic/shared/03/sf_dialog.xhp
index b96ef4752..6565192a6 100644
--- a/source/text/sbasic/shared/03/sf_dialog.xhp
+++ b/source/text/sbasic/shared/03/sf_dialog.xhp
@@ -56,7 +56,10 @@
<paragraph role="bascode" localize="false" id="bas_id421598175139021">End Sub</paragraph>
</bascode>
<paragraph role="paragraph" id="par_id251598176312571" xml-lang="en-US">Note that in previous examples, the prefix <literal>"SFDialogs."</literal> may be omitted.</paragraph>
- <h2 id="hd_id651583668365757" xml-lang="en-US">Properties</h2>
+
+ <tip id="par_id251612628336779" xml-lang="en-US">Properties or methods marked below as <emph>(7.2)</emph> are available as from %PRODUCTNAME 7.2 onwards.</tip>
+
+ <h2 id="hd_id651583668365757" xml-lang="en-US">Properties</h2>
<table id="tab_id381583668386455">
<tablerow>
<tablecell>
@@ -74,13 +77,13 @@
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id151583668386455" role="tablecontent" xml-lang="en-US" localize="false">OKBUTTON</paragraph>
+ <paragraph id="par_id151583668386455" role="tablecontent" localize="false">OKBUTTON</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id371583668519172" role="tablecontent " xml-lang="en-US">Yes</paragraph>
+ <paragraph id="par_id371583668519172" role="tablecontent" xml-lang="en-US">Yes</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id271583668386455" role="tablecontent" xml-lang="en-US" localize="false">Integer</paragraph>
+ <paragraph id="par_id271583668386455" role="tablecontent" localize="false">Integer</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id771583668386455" role="tablecontent" xml-lang="en-US">Value = 1. An OK button was pressed.</paragraph>
@@ -88,13 +91,13 @@
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id951583839708571" role="tablecontent" xml-lang="en-US" localize="false">CANCELBUTTON</paragraph>
+ <paragraph id="par_id951583839708571" role="tablecontent" localize="false">CANCELBUTTON</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id541583839708548" role="tablecontent " xml-lang="en-US">Yes</paragraph>
+ <paragraph id="par_id541583839708548" role="tablecontent" xml-lang="en-US">Yes</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id751583839708362" role="tablecontent" xml-lang="en-US" localize="false">Integer</paragraph>
+ <paragraph id="par_id751583839708362" role="tablecontent" localize="false">Integer</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id731583839708412" role="tablecontent" xml-lang="en-US">Value = 0. A Cancel button was pressed.</paragraph>
@@ -102,13 +105,13 @@
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id511584027709311" role="tablecontent" xml-lang="en-US" localize="false">Caption</paragraph>
+ <paragraph id="par_id511584027709311" role="tablecontent" localize="false">Caption</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id761584027709516" role="tablecontent " xml-lang="en-US">No</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id491584027709825" role="tablecontent" xml-lang="en-US" localize="false">String</paragraph>
+ <paragraph id="par_id491584027709825" role="tablecontent" localize="false">String</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id971584027709752" role="tablecontent" xml-lang="en-US">Specify the title of the dialog.</paragraph>
@@ -116,13 +119,13 @@
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id491583839767611" role="tablecontent" xml-lang="en-US" localize="false">Height</paragraph>
+ <paragraph id="par_id491583839767611" role="tablecontent" localize="false">Height</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id31583839767743" role="tablecontent " xml-lang="en-US">No</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id741583839767926" role="tablecontent" xml-lang="en-US" localize="false">Long</paragraph>
+ <paragraph id="par_id741583839767926" role="tablecontent" localize="false">Long</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id111583839767195" role="tablecontent" xml-lang="en-US">Specify the height of the dialog box.</paragraph>
@@ -130,13 +133,13 @@
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id83158383992056" role="tablecontent" xml-lang="en-US" localize="false">Modal</paragraph>
+ <paragraph id="par_id83158383992056" role="tablecontent" localize="false">Modal</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id771583839920487" role="tablecontent " xml-lang="en-US">Yes</paragraph>
+ <paragraph id="par_id771583839920487" role="tablecontent" xml-lang="en-US">Yes</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id971583839920282" role="tablecontent" xml-lang="en-US" localize="false">Boolean</paragraph>
+ <paragraph id="par_id971583839920282" role="tablecontent" localize="false">Boolean</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id451583839920858" role="tablecontent" xml-lang="en-US">Specifies if the dialog box is currently in execution in modal mode.</paragraph>
@@ -144,13 +147,13 @@
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id751588333908795" role="tablecontent" xml-lang="en-US" localize="false">Name</paragraph>
+ <paragraph id="par_id751588333908795" role="tablecontent" localize="false">Name</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id571588333908716" role="tablecontent " xml-lang="en-US">Yes</paragraph>
+ <paragraph id="par_id571588333908716" role="tablecontent" xml-lang="en-US">Yes</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id781588333908500" role="tablecontent" xml-lang="en-US" localize="false">String</paragraph>
+ <paragraph id="par_id781588333908500" role="tablecontent" localize="false">String</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id721588333908708" role="tablecontent" xml-lang="en-US">The name of the dialog</paragraph>
@@ -158,13 +161,13 @@
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id251583774433989" role="tablecontent" xml-lang="en-US" localize="false">Page</paragraph>
+ <paragraph id="par_id251583774433989" role="tablecontent" localize="false">Page</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id501583774433513" role="tablecontent " xml-lang="en-US">No</paragraph>
+ <paragraph id="par_id501583774433513" role="tablecontent" xml-lang="en-US">No</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id411583774433779" role="tablecontent" xml-lang="en-US" localize="false">Integer</paragraph>
+ <paragraph id="par_id411583774433779" role="tablecontent" localize="false">Integer</paragraph>
</tablecell>
<tablecell>
<paragraph role="paragraph" id="par_id151598177605296" xml-lang="en-US">A dialog may have several pages that can be traversed by the user step by step. The Page property of the Dialog object defines which page of the dialog is active.</paragraph>
@@ -172,13 +175,13 @@
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id731588334016220" role="tablecontent" xml-lang="en-US" localize="false">Visible</paragraph>
+ <paragraph id="par_id731588334016220" role="tablecontent" localize="false">Visible</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id271588334016191" role="tablecontent " xml-lang="en-US">No</paragraph>
+ <paragraph id="par_id271588334016191" role="tablecontent" xml-lang="en-US">No</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id991588334016273" role="tablecontent" xml-lang="en-US" localize="false">Boolean</paragraph>
+ <paragraph id="par_id991588334016273" role="tablecontent" localize="false">Boolean</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id251588334016874" role="tablecontent" xml-lang="en-US">Specify if the dialog box is visible on the desktop. By default it is not visible until the Execute() method is run and visible afterwards.</paragraph>
@@ -186,10 +189,10 @@
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id741598177924441" role="tablecontent" xml-lang="en-US" localize="false">XDialogModel</paragraph>
+ <paragraph id="par_id741598177924441" role="tablecontent" localize="false">XDialogModel</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id451598177924437" role="tablecontent " xml-lang="en-US">Yes</paragraph>
+ <paragraph id="par_id451598177924437" role="tablecontent" xml-lang="en-US">Yes</paragraph>
</tablecell>
<tablecell>
<bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id141598187953729">
@@ -203,23 +206,150 @@
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id801598178083859" role="tablecontent" xml-lang="en-US" localize="false">XDialogView</paragraph>
+ <paragraph id="par_id801598178083859" role="tablecontent" localize="false">XDialogView</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id811598178083501" role="tablecontent " xml-lang="en-US">Yes</paragraph>
+ <paragraph id="par_id811598178083501" role="tablecontent" xml-lang="en-US">Yes</paragraph>
</tablecell>
<tablecell>
<bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id141598187953729">
<bookmark_value>API;UnoControlDialog</bookmark_value>
</bookmark>
- <paragraph id="par_id981598178083938" role="tablecontent" xml-lang="en-US" localize="false">UNO<br />object</paragraph>
+ <paragraph id="par_id981598178083938" role="tablecontent" xml-lang="en-US" localize="true">UNO<br />object</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id731598178083442" role="tablecontent" xml-lang="en-US">The UNO object representing the dialog view. Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1XControlModel.html" name="XControl interface">XControl</link> and <link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1awt_1_1UnoControlDialog-members.html" name="UnoControlDialog interface">UnoControlDialog</link> in Application Programming Interface (API) documentation for detailed information.</paragraph>
</tablecell>
</tablerow>
</table>
- <table id="tab_id891606472825856">
+
+ <h2 id="hd_id421612628828054" xml-lang="en-US">Event properties</h2>
+ <embed href="text/sbasic/shared/03/avail_release.xhp#7.2.events"/>
+ <paragraph role="paragraph" id="par_id41612629140856" xml-lang="en-US">Returns a URI string with the reference to the script triggered by the event. Read its specification in the <link href="https://wiki.openoffice.org/wiki/Documentation/DevGuide/Scripting/Scripting_Framework_URI_Specification" name="URI specification">scripting framework URI specification</link>.</paragraph>
+ <table id="tab_id951612628879819">
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id961612628879819" role="tablehead" xml-lang="en-US">Name</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id401612628879819" role="tablehead" xml-lang="en-US">ReadOnly</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id281612628879819" role="tablehead" xml-lang="en-US">Basic IDE Description</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id431612629836735" localize="false" role="tablecontent" xml-lang="en-US">OnFocusGained</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id111612629836630" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id1001612629836902" role="tablecontent" xml-lang="en-US">When receiving focus</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id701612629836389" localize="false" role="tablecontent" xml-lang="en-US">OnFocusLost</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id291612629836294" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id62161262983683" role="tablecontent" xml-lang="en-US">When losing focus</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id241612629836863" localize="false" role="tablecontent" xml-lang="en-US">OnKeyPressed</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id81612629836634" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id881612629836744" role="tablecontent" xml-lang="en-US">Key pressed</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id201612629836996" localize="false" role="tablecontent" xml-lang="en-US">OnKeyReleased</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id591612629836830" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id161612629836775" role="tablecontent" xml-lang="en-US">Key released</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id111612629836950" localize="false" role="tablecontent" xml-lang="en-US">OnMouseDragged</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id891612629836630" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id461612629836679" role="tablecontent" xml-lang="en-US">Mouse moved while key presses</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id711612629836495" localize="false" role="tablecontent" xml-lang="en-US">OnMouseEntered</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id131612629836291" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id151612629836151" role="tablecontent" xml-lang="en-US">Mouse inside</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id971612629836286" localize="false" role="tablecontent" xml-lang="en-US">OnMouseExited</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id211612629836725" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id361612629836624" role="tablecontent" xml-lang="en-US">Mouse outside</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id721612629836537" localize="false" role="tablecontent" xml-lang="en-US">OnMouseMoved</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id311612629836481" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id721612629836752" role="tablecontent" xml-lang="en-US">Mouse moved</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id55161262983695" localize="false" role="tablecontent" xml-lang="en-US">OnMousePressed</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id981612629836116" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id381612629836635" role="tablecontent" xml-lang="en-US">Mouse button pressed</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id621612629836155" localize="false" role="tablecontent" xml-lang="en-US">OnMouseReleased</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id711612629836704" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id35161262983642" role="tablecontent" xml-lang="en-US">Mouse button released</paragraph>
+ </tablecell>
+ </tablerow>
+ </table>
+ <table id="tab_id891606472825856">
<tablerow>
<tablecell><paragraph id="par_id581606472825856" role="tablehead" localize="false"></paragraph></tablecell>
<tablecell><paragraph id="par_id921606472825856" role="tablehead">Methods</paragraph></tablecell>
@@ -370,4 +500,4 @@
<embed href="text/sbasic/shared/03/sf_ui.xhp#UIService"/>
</section>
</body>
-</helpdocument>
\ No newline at end of file
+</helpdocument>
diff --git a/source/text/sbasic/shared/03/sf_dialogcontrol.xhp b/source/text/sbasic/shared/03/sf_dialogcontrol.xhp
index 547b2147b..1016d9aa6 100644
--- a/source/text/sbasic/shared/03/sf_dialogcontrol.xhp
+++ b/source/text/sbasic/shared/03/sf_dialogcontrol.xhp
@@ -31,7 +31,8 @@
<bookmark_value>API;awt.XControlModel</bookmark_value>
</bookmark>
<paragraph role="paragraph" id="par_id701598191157426" xml-lang="en-US">The focus is set on getting and setting the values displayed by the controls of the dialog box. Formatting is accessible via the <literal>XControlModel</literal> and <literal>XControlView</literal> properties.</paragraph>
- <paragraph role="paragraph" id="par_id981598191184526" xml-lang="en-US">Note that <literal>DialogControl.Value</literal> property content varies according to UNO control types.</paragraph>
+ <paragraph role="paragraph" id="par_id981598191184526" xml-lang="en-US">Note that the unique <literal>DialogControl.Value</literal> property content varies according to the control type.</paragraph>
+ <paragraph role="paragraph" id="par_id991612698027551" xml-lang="en-US">A special attention is given to controls of type tree control. It is easy to populate a tree, either branch by branch, or with a set of branches at once. Populating a tree control can be performed statically or dynamically.</paragraph>
</section>
<tip id="par_id891598188164936" xml-lang="en-US">The <literal>SFDialogs.DialogControl</literal> service is closely related to the <link href="text/sbasic/shared/03/sf_dialog.xhp" name="Dialog service"><literal>SFDialogs.Dialog</literal></link> service.</tip>
@@ -118,6 +119,10 @@
<listitem>
<paragraph id="par_id661598456015339" localize="false" role="listitem">TimeField</paragraph>
</listitem>
+ <listitem>
+ <paragraph id="par_id171612698897514" role="listitem" xml-lang="en-US">TreeControl</paragraph>
+ <embed href="text/sbasic/shared/03/avail_release.xhp#7.2.control"/>
+ </listitem>
</list>
<h2 id="hd_id651583668365757" xml-lang="en-US">Properties</h2>
@@ -150,7 +155,7 @@
<paragraph id="par_id271583668386455" role="tablecontent" localize="false">Boolean</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id231598538847029" role="tablecontent" xml-lang="en-US" localize="false">Button</paragraph>
+ <paragraph id="par_id231598538847029" role="tablecontent" xml-lang="en-US">Button</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id771583668386455" role="tablecontent" xml-lang="en-US">Specifies if a command button has or not the behaviour of a Cancel button.</paragraph>
@@ -167,7 +172,7 @@
<paragraph id="par_id751583839708362" role="tablecontent" localize="false">String</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id351598538934413" role="tablecontent" xml-lang="en-US" localize="false">Button, CheckBox, FixedLine, FixedText, GroupBox, RadioButton</paragraph>
+ <paragraph id="par_id351598538934413" role="tablecontent" localize="false">Button, CheckBox, FixedLine, FixedText, GroupBox, RadioButton</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id731583839708412" role="tablecontent" xml-lang="en-US">Specifies the text associated with the control.</paragraph>
@@ -189,6 +194,24 @@
<tablecell>
<paragraph id="par_id971584027709752" role="tablecontent" xml-lang="en-US">One of the types listed above.</paragraph>
</tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id141612705482724" role="tablecontent" localize="false">CurrentNode</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id67161270548283" role="tablecontent" xml-lang="en-US">No</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id341612705482566" role="tablecontent" xml-lang="en-US">UNO<br/>object</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id51612705482172" role="tablecontent" localize="false">TreeControl</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id1001612705482919" role="tablecontent" xml-lang="en-US">The currently upmost node selected in the tree control. Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1tree_1_1XMutableTreeNode.html" name="awt.tree.XMutableTreeNode">XmutableTreeNode</link> in Application Programming Interface (API) documentation for detailed information.</paragraph>
+ <embed href="text/sbasic/shared/03/avail_release.xhp#7.2.property"/>
+ </tablecell>
</tablerow>
<tablerow>
<tablecell>
@@ -201,7 +224,7 @@
<paragraph id="par_id741583839767926" role="tablecontent" localize="false">Boolean</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id71598539168348" role="tablecontent" xml-lang="en-US" localize="false">Button</paragraph>
+ <paragraph id="par_id71598539168348" role="tablecontent" localize="false">Button</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id111583839767195" role="tablecontent" xml-lang="en-US">Specifies whether a command button is the default (OK) button.</paragraph>
@@ -235,7 +258,8 @@
<paragraph id="par_id781588333908500" role="tablecontent" localize="false">String</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id491598539231618" role="tablecontent" xml-lang="en-US">DateField, TimeField, FormattedField (read-only)</paragraph>
+ <paragraph id="par_id491598539231618" role="tablecontent" localize="false">DateField, TimeField, FormattedField</paragraph>
+ <paragraph id="par_id491598529331618" role="tablecontent" xml-lang="en-US">(read-only)</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id721588333908708" role="tablecontent" xml-lang="en-US">Specifies the format used to display dates and times. It must be one these strings:</paragraph>
@@ -254,7 +278,7 @@
<paragraph id="par_id411583774433779" role="tablecontent" localize="false">Long</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id531598539561342" role="tablecontent" xml-lang="en-US" localize="false">ComboBox, ListBox</paragraph>
+ <paragraph id="par_id531598539561342" role="tablecontent" localize="false">ComboBox, ListBox</paragraph>
</tablecell>
<tablecell>
<paragraph role="paragraph" id="par_id151598177605296" xml-lang="en-US">Specifies the number of rows in a list box or a combo box.</paragraph>
@@ -271,7 +295,7 @@
<paragraph id="par_id991588334016273" role="tablecontent" localize="false">Long</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id451598539598242" role="tablecontent" xml-lang="en-US" localize="false">ComboBox, ListBox</paragraph>
+ <paragraph id="par_id451598539598242" role="tablecontent" localize="false">ComboBox, ListBox</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id251588334016874" role="tablecontent" xml-lang="en-US">Specifies which item is selected in a list box or combo box.</paragraph>
@@ -288,7 +312,7 @@
<paragraph id="par_id571598457655365" role="tablecontent" localize="false">Boolean</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id111598539631340" role="tablecontent" xml-lang="en-US" localize="false">ComboBox, CurrencyField, DateField, FileControl, FormattedField, ListBox, NumericField, PatternField, TextField, TimeField</paragraph>
+ <paragraph id="par_id111598539631340" role="tablecontent" localize="false">ComboBox, CurrencyField, DateField, FileControl, FormattedField, ListBox, NumericField, PatternField, TextField, TimeField</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id2159845765568" role="tablecontent" xml-lang="en-US">Specifies if the control is read-only.</paragraph>
@@ -305,7 +329,7 @@
<paragraph id="par_id311598457951281" role="tablecontent" localize="false">Boolean</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id361598539747680" role="tablecontent" xml-lang="en-US" localize="false">ListBox</paragraph>
+ <paragraph id="par_id361598539747680" role="tablecontent" localize="false">ListBox</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id821598457951782" role="tablecontent" xml-lang="en-US">Specifies whether a user can make multiple selections in a listbox.</paragraph>
@@ -374,12 +398,30 @@
<paragraph id="par_id471598458773993" role="tablecontent" localize="false">String</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id831598539848472" role="tablecontent" xml-lang="en-US" localize="false">Button, ImageControl</paragraph>
+ <paragraph id="par_id831598539848472" role="tablecontent" localize="false">Button, ImageControl</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id451598458773588" role="tablecontent" xml-lang="en-US">Specifies the file name containing a bitmap or other type of graphic to be displayed on the specified control. The filename must comply with the <literal>FileNaming</literal> attribute of the <literal>ScriptForge.FileSystem</literal> service.</paragraph>
</tablecell>
</tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id791612700624395" role="tablecontent" localize="false">RootNode</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id831612700624650" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id711612700624483" role="tablecontent" xml-lang="en-US">UNO<br/>object</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id581612700624717" role="tablecontent" localize="false">TreeControl</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id11612700624514" role="tablecontent" xml-lang="en-US">An object representing the lowest root node (usually there is only one such root node). Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1tree_1_1XMutableTreeNode.html" name="awt.tree.XMutableTreeNode">XmutableTreeNode</link> in Application Programming Interface (API) documentation for detailed information.</paragraph>
+ <embed href="text/sbasic/shared/03/avail_release.xhp#7.2.property"/>
+ </tablecell>
+ </tablerow>
<tablerow>
<tablecell>
<paragraph id="par_id681598516577774" role="tablecontent" localize="false">RowSource</paragraph>
@@ -391,7 +433,7 @@
<paragraph id="par_id59159851657754" role="tablecontent" localize="false">Array of strings</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id131598539880024" role="tablecontent" xml-lang="en-US" localize="false">ComboBox, ListBox</paragraph>
+ <paragraph id="par_id131598539880024" role="tablecontent" localize="false">ComboBox, ListBox</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id311598516577712" role="tablecontent" xml-lang="en-US">Specifies the data contained in a combobox or a listbox.</paragraph>
@@ -408,7 +450,7 @@
<paragraph id="par_id741598516764696" role="tablecontent" localize="false">String</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id761598539912452" role="tablecontent" xml-lang="en-US" localize="false">ComboBox, FileControl, FormattedField, PatternField, TextField</paragraph>
+ <paragraph id="par_id761598539912452" role="tablecontent" localize="false">ComboBox, FileControl, FormattedField, PatternField, TextField</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id11159851676440" role="tablecontent" xml-lang="en-US">Gives access to the text being displayed by the control.</paragraph>
@@ -442,7 +484,7 @@
<paragraph id="par_id231598517418608" role="tablecontent" localize="false">Boolean</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id81598540007035" role="tablecontent" xml-lang="en-US" localize="false">CheckBox</paragraph>
+ <paragraph id="par_id81598540007035" role="tablecontent" localize="false">CheckBox</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id141598517418822" role="tablecontent" xml-lang="en-US">Specifies if the checkbox control may appear dimmed (grayed) or not.</paragraph>
@@ -456,13 +498,11 @@
<paragraph id="par_id701598517671373" role="tablecontent" xml-lang="en-US">No</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id2159851767113" role="tablecontent" localize="false">Any</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id1001598540024225" role="tablecontent" xml-lang="en-US" localize="false"></paragraph>
+ <paragraph id="par_id2159851767113" role="tablecontent" localize="false">Variant</paragraph>
</tablecell>
+ <tablecell></tablecell>
<tablecell>
- <paragraph id="par_id991598517671916" role="tablecontent" xml-lang="en-US">Read below.</paragraph>
+ <paragraph id="par_id1001598540024225" role="tablecontent" xml-lang="en-US">Refer to <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#hd_id81598540704978" name="Value property">Value property</link></paragraph>
</tablecell>
</tablerow>
<tablerow>
@@ -515,10 +555,28 @@
<tablecell>
<paragraph id="par_id731598178083442" role="tablecontent" xml-lang="en-US">The UNO object representing the control view. Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1XControl.html" name="awt.XControl">XControl</link> and <link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1awt_1_1UnoControlDialog.html)" name="awt.UnoControlDialog">UnoControlDialog</link> in Application Programming Interface (API) documentation for detailed information.</paragraph>
</tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id55161269944658" role="tablecontent" localize="false">XTreeDataModel</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id741612699446459" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id311612699446893" role="tablecontent" xml-lang="en-US">UNO<br/>object</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id25161269944611" role="tablecontent" xml-lang="en-US">TreeControl</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id691612699446892" role="tablecontent" xml-lang="en-US">The UNO object representing the tree control data model. Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1tree_1_1XMutableTreeDataModel.html" name="awt.tree.XMutableTreeDataModel">XMutableTreeDataModel</link> in Application Programming Interface (API) documentation for detailed information.</paragraph>
+ <embed href="text/sbasic/shared/03/avail_release.xhp#7.2.property"/>
+ </tablecell>
</tablerow>
</table>
-
- <h2 id="hd_id81598540704978" xml-lang="en-US">The Value property</h2>
+
+ <h2 id="hd_id81598540704978" xml-lang="en-US">The <variable id="ValueProperty">Value property</variable></h2>
<table id="tab_id48159854325479">
<tablerow>
<tablecell>
@@ -533,10 +591,10 @@
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id461598543254494" role="tablecontent" xml-lang="en-US" localize="false">Button</paragraph>
+ <paragraph id="par_id461598543254494" role="tablecontent" localize="false">Button</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id271598543254590" role="tablecontent" xml-lang="en-US" localize="false">Boolean</paragraph>
+ <paragraph id="par_id271598543254590" role="tablecontent" xml-lang="en-US">Boolean</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id741598543254108" role="tablecontent" xml-lang="en-US">For toggle buttons only</paragraph>
@@ -544,7 +602,7 @@
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id131598543254931" role="tablecontent" xml-lang="en-US" localize="false">CheckBox</paragraph>
+ <paragraph id="par_id131598543254931" role="tablecontent" localize="false">CheckBox</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id741598543254376" role="tablecontent" xml-lang="en-US">Boolean or Integer</paragraph>
@@ -555,10 +613,10 @@
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id891598543254563" role="tablecontent" xml-lang="en-US" localize="false">ComboBox</paragraph>
+ <paragraph id="par_id891598543254563" role="tablecontent" localize="false">ComboBox</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id781598543254887" role="tablecontent" xml-lang="en-US" localize="false">String</paragraph>
+ <paragraph id="par_id781598543254887" role="tablecontent" xml-lang="en-US">String</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id331598543254947" role="tablecontent" xml-lang="en-US">The selected value. The <literal>ListIndex</literal> property is an alternate option.</paragraph>
@@ -566,32 +624,32 @@
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id58159854325446" role="tablecontent" xml-lang="en-US" localize="false">CurrencyField</paragraph>
+ <paragraph id="par_id58159854325446" role="tablecontent" localize="false">CurrencyField</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id5159854325443" role="tablecontent" xml-lang="en-US">Numeric</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id90159854325450" role="tablecontent" xml-lang="en-US" localize="false"></paragraph>
+ <paragraph id="par_id90159854325450" role="tablecontent" xml-lang="en-US"></paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id241598543254415" role="tablecontent" xml-lang="en-US" localize="false">DateField</paragraph>
+ <paragraph id="par_id241598543254415" role="tablecontent" localize="false">DateField</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id401598543254743" role="tablecontent" xml-lang="en-US" localize="false">Date</paragraph>
+ <paragraph id="par_id401598543254743" role="tablecontent" xml-lang="en-US">Date</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id421598543254587" role="tablecontent" xml-lang="en-US" localize="false"></paragraph>
+ <paragraph id="par_id421598543254587" role="tablecontent" xml-lang="en-US"></paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id851598543254508" role="tablecontent" xml-lang="en-US" localize="false">FileControl</paragraph>
+ <paragraph id="par_id851598543254508" role="tablecontent" localize="false">FileControl</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id731598543254544" role="tablecontent" xml-lang="en-US" localize="false">String</paragraph>
+ <paragraph id="par_id731598543254544" role="tablecontent" xml-lang="en-US">String</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id971598543254757" role="tablecontent" xml-lang="en-US">A file name formatted in accordance with the <literal>FileNaming</literal> property of the <literal>ScriptForge.FileSystem</literal> service</paragraph>
@@ -599,18 +657,18 @@
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id921598543254323" role="tablecontent" xml-lang="en-US" localize="false">FormattedField</paragraph>
+ <paragraph id="par_id921598543254323" role="tablecontent" localize="false">FormattedField</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id221598543254760" role="tablecontent" xml-lang="en-US">String or Numeric</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id651598543254212" role="tablecontent" xml-lang="en-US" localize="false"></paragraph>
+ <paragraph id="par_id651598543254212" role="tablecontent" xml-lang="en-US"></paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id151598543254318" role="tablecontent" xml-lang="en-US" localize="false">ListBox</paragraph>
+ <paragraph id="par_id151598543254318" role="tablecontent" localize="false">ListBox</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id42159854325422" role="tablecontent" xml-lang="en-US">String or array of strings</paragraph>
@@ -621,29 +679,29 @@
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id771598543254973" role="tablecontent" xml-lang="en-US" localize="false">NumericField</paragraph>
+ <paragraph id="par_id771598543254973" role="tablecontent" localize="false">NumericField</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id461598543254909" role="tablecontent" xml-lang="en-US">Numeric</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id161598543254662" role="tablecontent" xml-lang="en-US" localize="false"></paragraph>
+ <paragraph id="par_id161598543254662" role="tablecontent" xml-lang="en-US"></paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id38159854325480" role="tablecontent" xml-lang="en-US" localize="false">PatternField</paragraph>
+ <paragraph id="par_id38159854325480" role="tablecontent" localize="false">PatternField</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id81598543254625" role="tablecontent" xml-lang="en-US" localize="false">String</paragraph>
+ <paragraph id="par_id81598543254625" role="tablecontent" xml-lang="en-US">String</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id911598543254335" role="tablecontent" xml-lang="en-US" localize="false"></paragraph>
+ <paragraph id="par_id911598543254335" role="tablecontent" xml-lang="en-US"></paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id951598543254998" role="tablecontent" xml-lang="en-US" localize="false">ProgressBar</paragraph>
+ <paragraph id="par_id951598543254998" role="tablecontent" localize="false">ProgressBar</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id631598543254771" role="tablecontent" xml-lang="en-US">Numeric</paragraph>
@@ -654,10 +712,10 @@
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id791598543254779" role="tablecontent" xml-lang="en-US" localize="false">RadioButton</paragraph>
+ <paragraph id="par_id791598543254779" role="tablecontent" localize="false">RadioButton</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id561598543254115" role="tablecontent" xml-lang="en-US" localize="false">Boolean</paragraph>
+ <paragraph id="par_id561598543254115" role="tablecontent" xml-lang="en-US">Boolean</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id851598543254624" role="tablecontent" xml-lang="en-US">Each button has its own name. They are linked together if their TAB positions are contiguous. If a radiobutton is set to <literal>True</literal>, the other related buttons are automatically set to <literal>False</literal></paragraph>
@@ -665,7 +723,7 @@
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id141598543254361" role="tablecontent" xml-lang="en-US" localize="false">ScrollBar</paragraph>
+ <paragraph id="par_id141598543254361" role="tablecontent" localize="false">ScrollBar</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id531598543254869" role="tablecontent" xml-lang="en-US">Numeric</paragraph>
@@ -676,10 +734,10 @@
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id811598543254140" role="tablecontent" xml-lang="en-US" localize="false">TextField</paragraph>
+ <paragraph id="par_id811598543254140" role="tablecontent" localize="false">TextField</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id751598543254299" role="tablecontent" xml-lang="en-US" localize="false">String</paragraph>
+ <paragraph id="par_id751598543254299" role="tablecontent" xml-lang="en-US">String</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id441598543254738" role="tablecontent" xml-lang="en-US">The text appearing in the field</paragraph>
@@ -687,31 +745,355 @@
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id89159854325478" role="tablecontent" xml-lang="en-US" localize="false">TimeField</paragraph>
+ <paragraph id="par_id89159854325478" role="tablecontent" localize="false">TimeField</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id341598543254600" role="tablecontent" xml-lang="en-US" localize="false">Date</paragraph>
+ <paragraph id="par_id341598543254600" role="tablecontent" xml-lang="en-US">Date</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id881598543254964" role="tablecontent" xml-lang="en-US" localize="false"></paragraph>
+ <paragraph id="par_id881598543254964" role="tablecontent" xml-lang="en-US"></paragraph>
</tablecell>
</tablerow>
</table>
+ <h2 id="hd_id421612628828054" xml-lang="en-US">Event properties</h2>
+ <paragraph role="paragraph" id="par_id41612629140856" xml-lang="en-US">Returns a URI string with the reference to the script triggered by the event. Read its specification in the <link href="https://wiki.openoffice.org/wiki/Documentation/DevGuide/Scripting/Scripting_Framework_URI_Specification" name="URI specification">scripting framework URI specification</link>.</paragraph>
+ <embed href="text/sbasic/shared/03/avail_release.xhp#7.2.events"/>
+ <table id="tab_id951612628879819">
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id961612628879819" role="tablehead" xml-lang="en-US">Name</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id401612628879819" role="tablehead" xml-lang="en-US">ReadOnly</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id281612628879819" role="tablehead" xml-lang="en-US">Description as labeled in the Basic IDE</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id801612707166342" localize="false" role="tablecontent" xml-lang="en-US">OnActionPerformed</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id91612707166532" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id291612707166258" role="tablecontent" xml-lang="en-US">Execute action</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id261612707166662" localize="false" role="tablecontent" xml-lang="en-US">OnAdjustmentValueChanged</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id79161270716675" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id831612707166731" role="tablecontent" xml-lang="en-US">While adjusting</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id431612629836735" localize="false" role="tablecontent" xml-lang="en-US">OnFocusGained</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id111612629836630" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id1001612629836902" role="tablecontent" xml-lang="en-US">When receiving focus</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id701612629836389" localize="false" role="tablecontent" xml-lang="en-US">OnFocusLost</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id291612629836294" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id62161262983683" role="tablecontent" xml-lang="en-US">When losing focus</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id10161270735471" localize="false" role="tablecontent" xml-lang="en-US">OnItemStateChanged</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id51612707354544" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id211612707354899" role="tablecontent" xml-lang="en-US">Item status changed</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id241612629836863" localize="false" role="tablecontent" xml-lang="en-US">OnKeyPressed</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id81612629836634" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id881612629836744" role="tablecontent" xml-lang="en-US">Key pressed</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id201612629836996" localize="false" role="tablecontent" xml-lang="en-US">OnKeyReleased</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id591612629836830" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id161612629836775" role="tablecontent" xml-lang="en-US">Key released</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id111612629836950" localize="false" role="tablecontent" xml-lang="en-US">OnMouseDragged</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id891612629836630" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id461612629836679" role="tablecontent" xml-lang="en-US">Mouse moved while key presses</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id711612629836495" localize="false" role="tablecontent" xml-lang="en-US">OnMouseEntered</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id131612629836291" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id151612629836151" role="tablecontent" xml-lang="en-US">Mouse inside</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id971612629836286" localize="false" role="tablecontent" xml-lang="en-US">OnMouseExited</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id211612629836725" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id361612629836624" role="tablecontent" xml-lang="en-US">Mouse outside</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id721612629836537" localize="false" role="tablecontent" xml-lang="en-US">OnMouseMoved</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id311612629836481" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id721612629836752" role="tablecontent" xml-lang="en-US">Mouse moved</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id55161262983695" localize="false" role="tablecontent" xml-lang="en-US">OnMousePressed</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id981612629836116" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id381612629836635" role="tablecontent" xml-lang="en-US">Mouse button pressed</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id621612629836155" localize="false" role="tablecontent" xml-lang="en-US">OnMouseReleased</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id711612629836704" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id35161262983642" role="tablecontent" xml-lang="en-US">Mouse button released</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id671612707606983" localize="false" role="tablecontent" xml-lang="en-US">OnNodeExpanded</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id851612707606863" role="tablecontent" xml-lang="en-US">No</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id351612707606197" role="tablecontent" xml-lang="en-US">(Not in Basic IDE) when the expansion button is pressed on a node in a tree control</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id331612707606104" localize="false" role="tablecontent" xml-lang="en-US">OnNodeSelected</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id121612707606251" role="tablecontent" xml-lang="en-US">No</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id881612707606121" role="tablecontent" xml-lang="en-US">(Not in Basic IDE) when a node in a tree control is selected</paragraph>
+ </tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id84161270760678" localize="false" role="tablecontent" xml-lang="en-US">OnTextChanged</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id811612707606330" role="tablecontent" xml-lang="en-US">Yes</paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id621612707606219" role="tablecontent" xml-lang="en-US">Text modified</paragraph>
+ </tablecell>
+ </tablerow>
+ </table>
+
<h2 id="hd_id421583670049913" xml-lang="en-US">Methods</h2>
+
<table id="tab_id891606472825856">
<tablerow>
- <tablecell colspan="2"><paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the DialogControl Service</paragraph></tablecell>
+ <tablecell colspan="3"><paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the DialogControl Service</paragraph></tablecell>
</tablerow>
- <tablerow>
- <tablecell><paragraph id="par_id381606472825856" role="tablecontent" localize="false">
- <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#SetFocus" name="SetFocus method">SetFocus</link>
+ <tablerow>
+ <tablecell><paragraph id="par_id751612709117248" role="tablecontent" localize="false">
+ <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#AddSubNode" name="AddSubNode method">AddSubNode</link><br/>
+ <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#AddSubTree" name="AddSubTree method">AddSubTree</link>
</paragraph></tablecell>
- <tablecell><paragraph id="par_id161606472825856" role="tablecontent" localize="false">
- <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#WriteLine" name="WriteLine method">WriteLine</link><br/>
+ <tablecell><paragraph id="par_id63161270911712" role="tablecontent" localize="false">
+ <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#CreateRoot" name="CreateRoot method">CreateRoot</link><br/>
+ <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#FindNode" name="FindNode method">FindNode</link>
+ </paragraph></tablecell>
+ <tablecell><paragraph id="par_id651612709117457" role="tablecontent" localize="false">
+ <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#SetFocus" name="SetFocus method">SetFocus</link><br/>
+ <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#WriteLine" name="WriteLine method">WriteLine</link>
</paragraph></tablecell>
</tablerow>
</table>
+ <embed href="text/sbasic/shared/03/avail_release.xhp#7.2.methods"/>
+
+ <section id="AddSubNode">
+ <comment> AddSubNode -------------------------------------------------------------------------------------------------------------------------- </comment>
+ <bookmark localize="false" branch="index" id="bm_id1516127118236">
+ <bookmark_value>DialogControl service;AddSubNode</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id791612711823914" localize="false">AddSubNode</h2>
+ <paragraph role="paragraph" id="par_id831612711823126">Create and return a new node of the tree control as a UNO object subordinate to a parent node. <variable id="XMutableTreeNode">Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1tree_1_1XMutableTreeNode.html" name="awt.tree.XMutableTreeNode">XMutableTreeNode</link> in Application Programming Interface (API) documentation for detailed information.</variable></paragraph>
+ <section id="OnNodeExpanded">
+ <paragraph role="paragraph" id="par_id741612711823706" xml-lang="en-US">This method may be called before displaying the dialog box to build the initial tree. It may also be called from a dialog or control event - using the <literal>OnNodeExpanded</literal> event - to complete the tree dynamically.</paragraph>
+ </section>
+ <h3 id="hd_id841612711823995" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id721612711823131">oControl.AddSubNode(ParentNode As Object, DisplayValue As String[, DataValue As Variant]) As Object</paragraph>
+ </bascode>
+ <h3 id="hd_id261612711823446" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph" id="par_id761612711823834"><emph>ParentNode</emph>: A node UNO object, of type <literal>com.sun.star.awt.tree.XMutableTreeNode</literal>.</paragraph>
+ <paragraph role="paragraph" id="par_id791612711823819"><emph>DisplayValue</emph>: The text appearing in the tree control box.</paragraph>
+ <paragraph role="paragraph" id="par_id911612711823382"><emph>DataValue</emph>: Any value associated with the new node. Default value is <literal>Empty</literal>.</paragraph>
+ <h3 id="hd_id931612711823178" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id781612711823502">Dim oDlg As Object, myTree As Object, myNode As Object, theRoot As Object</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id811612711823106">Set oDlg = CreateScriptService(,, "myDialog")</paragraph>
+ <paragraph role="bascode" id="bas_id401612711823779">'Dialog stored in current document's standard library</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id751612711823763">Set myTree = oDlg.Controls("myTreeControl")</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id31612711823423">Set theRoot = myTree.CreateRoot("Tree top")</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id211612712366538">Set myNode = myTree.AddSubNode(theRoot, "A branch ...")</paragraph>
+ </bascode>
+ </section>
+
+ <section id="AddSubTree">
+ <comment> AddSubTree -------------------------------------------------------------------------------------------------------------------------- </comment>
+ <bookmark localize="false" branch="index" id="bm_id481612713087784">
+ <bookmark_value>DialogControl service;AddSubTree</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id81161271308746" localize="false">AddSubTree</h2>
+ <paragraph role="paragraph" id="par_id221612713087885">Return <literal>True</literal> when a subtree, subordinate to a parent node, could be inserted successfully in a tree control. If the parent node had already child nodes before calling this method, the child nodes are erased.</paragraph>
+ <embed href="text/sbasic/shared/03/sf_dialogcontrol.xhp#OnNodeExpanded"/>
+ <h3 id="hd_id781612713087790" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id841612713087102">oControl.AddSubTree(ParentNode As Object, FlatTree As Variant[, WithDataValue As Boolean]) As Boolean</paragraph>
+ </bascode>
+ <h3 id="hd_id791612713087478" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph" id="par_id781612713087722"><emph>ParentNode</emph>: A node UNO object, of type <literal>com.sun.star.awt.tree.XMutableTreeNode</literal>.</paragraph>
+ <paragraph role="paragraph" id="par_id36161271308759"><emph>FlatTree</emph>: a two dimension array sorted on the columns containing the display values. Such an array can be issued by the <literal>GetRows</literal> method applied on the <literal>SFDatabases.Database</literal> service. When an array item containing the text to be displayed is <literal>Empty</literal> or <literal>Null</literal>, no new subnode is created and the remainder of the row is skipped.</paragraph>
+ <bascode>
+ <paragraph role="bascode" id="bas_id61612716027443">Flat tree >>>> Resulting subtree</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id881612716035711">A1 B1 C1 |__ A1 </paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id221612716043100">A1 B1 C2 |__ B1</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id861612716050132">A1 B2 C3 |__ C1</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id251612716057266">A2 B3 C4 |__ C2</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id316127156064145">A2 B3 C5 |__ B2</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id321612716075452">A3 B4 C6 |__ C3</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id171612716083505"> |__ A2</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id231612716092043"> |__ B3</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id216124716100898"> |__ C4</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id241612716108208"> |__ C5</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id531612716115408"> |__ A3</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id621612716122130"> |__ B4</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id212612716132791"> |__ C6</paragraph>
+ </bascode>
+ <paragraph role="paragraph" id="par_id51612713087915"><emph>WithDataValue</emph>: When <literal>False</literal> default value is used, every column of <literal>FlatTree</literal> contains the text to be displayed in the tree control. When <literal>True</literal>, the texts to be displayed (<literal>DisplayValue</literal>) are in columns 0, 2, 4, ... while the data values (<literal>DataValue</literal>) are in columns 1, 3, 5, ...</paragraph>
+ <h3 id="hd_id781612713087851" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id531612713087285">Dim myTree As Object, theRoot As Object, oDb As Object, vData As Variant</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id991612713087724">Set myTree = myDialog.Controls("myTreeControl")</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id581612713087989">Set theRoot = myTree.CreateRoot("By product category")</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id771612713087670">Set oDb = CreateScriptService("SFDatabases.Database", "/home/.../mydatabase.odb")</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id731612713087683">vData = oDb.GetRows("SELECT [Category].[Name], [Category].[ID], [Product].[Name], [Product].[ID] " _</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id551612714130895"> & "FROM [Category], [Product] WHERE [Product].[CategoryID] = [Category].[ID] " _</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id551612714139429"> & "ORDER BY [Category].[Name], [Product].[Name]")</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id361612714193588">myTree.AddSubTree(theRoot, vData, WithDataValue := True)</paragraph>
+ </bascode>
+ </section>
+
+ <section id="CreateRoot">
+ <comment> CreateRoot -------------------------------------------------------------------------------------------------------------------------- </comment>
+ <bookmark localize="false" branch="index" id="bm_id791612780723864">
+ <bookmark_value>DialogControl service;CreateRoot</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id291612780723671" localize="false">CreateRoot</h2>
+ <paragraph role="paragraph" id="par_id151612780723320">Returns a new root node of the tree control, as a node UNO object of type <literal>com.sun.star.awt.tree.XMutableTreeNode</literal>. The new tree root is inserted below pre-existing root nodes. <embedvar href="text/sbasic/shared/03/sf_dialogcontrol.xhp#XMutableTreeNode"/></paragraph>
+ <paragraph role="paragraph" id="par_id821612780723965" xml-lang="en-US">This method may be called before displaying the dialog box to build the initial tree. It may also be called from a dialog or control event to complete the tree dynamically.</paragraph>
+ <h3 id="hd_id211612780723578" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id921612780723147">oControl.CreateRoot(DisplayValue As String[, DataValue As Variant]) As Object</paragraph>
+ </bascode>
+ <h3 id="hd_id871612780723668" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph" id="par_id671612780723837"><emph>DisplayValue</emph>: The text appearing in the tree control box.</paragraph>
+ <paragraph role="paragraph" id="par_id31612780723267"><emph>DataValue</emph>: Any value associated with the new node. Default value is <literal>Empty</literal>.</paragraph>
+ <h3 id="hd_id241612780723961" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id491612780723925">Dim myTree As Object, myNode As Object</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id241612780723722">Set myTree = myDialog.Controls("myTreeControl")</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id441612780723817">Set myNode = myTree.CreateRoot("Tree starts here ...")</paragraph>
+ </bascode>
+ </section>
+
+ <section id="FindNode">
+ <comment> FindNode -------------------------------------------------------------------------------------------------------------------------- </comment>
+ <bookmark localize="false" branch="index" id="bm_id741612781589926">
+ <bookmark_value>DialogControl service;FindNode</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id801612781589891" localize="false">FindNode</h2>
+ <paragraph role="paragraph" id="par_id171612781589503">Traverses the tree and finds recursively, starting from the root, a node meeting some criteria. Either - 1 match is enough - having its display value matching <literal>DisplayValue</literal> pattern or having its data value equal to <literal>DataValue</literal>. The comparisons may be or not case-sensitive. The first matching occurrence is returned as a node UNO object of type <literal>com.sun.star.awt.tree.XMutableTreeNode</literal>. <embedvar href="text/sbasic/shared/03/sf_dialogcontrol.xhp#XMutableTreeNode"/></paragraph>
+ <paragraph role="paragraph" id="par_id741612782475457" xml-lang="en-US">When not found, the method returns <literal>Nothing</literal>, to be tested with the <literal>IsNull()</literal> builtin function.</paragraph>
+ <paragraph role="paragraph" id="par_id41612781589363" xml-lang="en-US">This method may be called before displaying the dialog box to build the initial tree. It may also be called from a dialog or control event.</paragraph>
+ <h3 id="hd_id60161278158981" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id881612781589726">oControl.FindNode(DisplayValue = Empty, DataValue = Empty [, CaseSensitive = False]) As Object</paragraph>
+ </bascode>
+ <h3 id="hd_id771612781589667" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph" id="par_id541613670199211">One argument out of <literal>DisplayValue</literal>or <literal>DataValue</literal> must be specified. If both present, one match is sufficient to select the node.</paragraph>
+ <paragraph role="paragraph" id="par_id591612781589560"><emph>DisplayValue</emph>: The pattern to be matched. See the <link href="text/sbasic/shared/03/sf_string.xhp#IsLike" name="Sting service IsLike() method"><literal>SF_String.IsLike()</literal></link> method. When equal to the zero-length string (default), this display value is not searched for.</paragraph>
+ <paragraph role="paragraph" id="par_id481612781589626"><emph>DataValue</emph>: A string, a numeric value, a date. Use <literal>Empty</literal> default value when no value applies.</paragraph>
+ <paragraph role="paragraph" id="par_id141582384726168"><emph>CaseSensitive</emph>: Default value is <literal>False</literal></paragraph>
+ <h3 id="hd_id41612781589546" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id61612781589464">Dim myTree As Object, myNode As Object</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id991612781589903">Set myTree = myDialog.Controls("myTreeControl")</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id461612781589942">et myNode = myTree.FindNode("*Sophie*", CaseSensitive := True)</paragraph>
+ </bascode>
+ </section>
<section id="SetFocus">
<comment> SetFocus -------------------------------------------------------------------------------------------------------------------------- </comment>
@@ -727,12 +1109,11 @@
</bascode>
<h3 id="hd_id26158393307687" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
<bascode>
- <paragraph role="bascode" localize="false" id="bas_id221598179105596">Dim oDlg As Object, oControl As Object</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id221598179105596">Dim oControl As Object</paragraph>
<paragraph role="bascode" localize="false" id="bas_id171598179111121">Set oDlg = CreateScriptService(,, "myDialog")</paragraph>
- <paragraph role="bascode" id="bas_id841598179117184">'Dialog stored in current document's standard library</paragraph>
<paragraph role="bascode" localize="false" id="bas_id681598179123436">Set oControl = oDlg.Controls("thisControl")</paragraph>
<paragraph role="bascode" localize="false" id="bas_id361598179135096">oControl.SetFocus()</paragraph>
- </bascode>
+ </bascode>
</section>
<section id="WriteLine">
@@ -748,7 +1129,7 @@
<paragraph role="bascode" localize="false" id="bas_id821598619892939">oControl.WriteLine([Line As String]) As Boolean</paragraph>
</bascode>
<h3 id="hd_id291584541257237" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
- <paragraph role="paragraph" id="par_id1001584541257789"><emph>Line</emph> : The string to insert. Default = an empty line.</paragraph>
+ <paragraph role="paragraph" id="par_id1001584541257789"><emph>Line</emph>: The string to insert. Default is an empty line.</paragraph>
<h3 id="hd_id391598619892559" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
<bascode>
<paragraph role="bascode" localize="false" id="bas_id681598619892624">Dim oDlg As Object, oControl As Object</paragraph>
@@ -761,9 +1142,10 @@
<embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/>
<section id="relatedtopics">
- <embed href="text/sbasic/shared/03/sf_dialog.xhp#dlg_h1"/>
- <embed href="text/sbasic/shared/03/sf_ui.xhp#UIService"/>
+ <embed href="text/sbasic/shared/03/sf_dialog.xhp#dlg_h1"/>
+ <embed href="text/sbasic/shared/03/sf_string.xhp#StringService"/>
+ <embed href="text/sbasic/shared/03/sf_ui.xhp#UIService"/>
</section>
-
+
</body>
</helpdocument>
More information about the Libreoffice-commits
mailing list