From 6099811d666ddaf1d9f445891096f97ab53175cc Mon Sep 17 00:00:00 2001
From: Lionel Elie Mamane <lionel@mamane.lu>
Date: Mon, 22 Apr 2013 17:40:01 +0200
Subject: Data-aware ListBox: document changes & improve documentation

Change-Id: If75a2e86654ffef71e37cf55c24af721182215d7
---
 offapi/com/sun/star/form/component/DatabaseListBox.idl | 17 +++++++++++++++--
 offapi/com/sun/star/form/component/ListBox.idl         |  3 ++-
 2 files changed, 17 insertions(+), 3 deletions(-)

(limited to 'offapi')

diff --git a/offapi/com/sun/star/form/component/DatabaseListBox.idl b/offapi/com/sun/star/form/component/DatabaseListBox.idl
index d0070211368c..ba6e17197f70 100644
--- a/offapi/com/sun/star/form/component/DatabaseListBox.idl
+++ b/offapi/com/sun/star/form/component/DatabaseListBox.idl
@@ -33,8 +33,11 @@
 /** This service specifies a data-aware list box control model.
 
     <p>The base service for list boxes (<type>ListBox</type>) offers only
-    one possibility to specify the list entries: the <member>ListBox::ListSource</member>
-    property, which contains all the strings to be displayed.</p>
+    one possibility to specify the list entries:
+    The display strings in the
+    <member scope="com::sun::star::awt">UnoControlListBoxModel::StringItemList</member>
+    property and the corresponding values in the <member>ListBox::ListSource</member>
+    property.</p>
 
     <p>This service here extends this mimic. It allows to fill the list from a data source.
     This means that a second result set is opened, which works on the same connection as the
@@ -54,6 +57,8 @@
     pure numbers.<br/>
     Let's call this result set the list is filled from the <em>list result set</em> here ...</p>
 
+    <p>The display strings are always taken from the first column of that result set,
+    and the corresponding value as per the BoundColumn property.</p>
  */
 published service DatabaseListBox
 {
@@ -134,6 +139,14 @@ published service DatabaseListBox
      */
     [property] com::sun::star::form::ListSourceType ListSourceType;
 
+    /** The selected values.
+     */
+    [property, transient, optional] sequence< any > SelectedValues;
+
+    /** The selected value, if there is at most one.
+     */
+    [property, transient, optional] any SelectedValue;
+
 };
 
 
diff --git a/offapi/com/sun/star/form/component/ListBox.idl b/offapi/com/sun/star/form/component/ListBox.idl
index 21f954b12c2a..7219999e7b67 100644
--- a/offapi/com/sun/star/form/component/ListBox.idl
+++ b/offapi/com/sun/star/form/component/ListBox.idl
@@ -55,7 +55,8 @@ published service ListBox
     [property] sequence<short> DefaultSelection;
 
 
-    /** contains the listbox entries.
+    /** contains the values associated to the strings to be displayed
+        (which are specified by <member scope="com::sun::star::awt">UnoControlListBoxModel::StringItemList</member>)
      */
     [property] sequence<string> ListSource;
 
-- 
cgit