XListBox: Add more hints about return values

Change-Id: I74385b762ed70ec9d8303f1cb94f76b9edac7cc5
Reviewed-on: https://gerrit.libreoffice.org/24261
Tested-by: Jenkins <ci@libreoffice.org>
Reviewed-by: Noel Grandin <noelgrandin@gmail.com>
This commit is contained in:
Samuel Mehrbrodt
2016-04-20 11:32:35 +00:00
committed by Noel Grandin
parent 5abc669599
commit c285d043be

View File

@@ -89,7 +89,9 @@ published interface XListBox: com::sun::star::uno::XInterface
sequence<string> getItems();
/** returns the position of the currently selected item, or -1 when nothing is selected.
/** returns the position of the currently selected item.
When multiple items are selected, the position of the first one is returned.
When nothing is selected, -1 is returned.
*/
short getSelectedItemPos();
@@ -100,6 +102,8 @@ published interface XListBox: com::sun::star::uno::XInterface
/** returns the currently selected item.
When multiple items are selected, the first one is returned.
When nothing is selected, an empty string is returned.
*/
string getSelectedItem();