:: drafts :: com :: sun :: star :: form ::

interface XListEntrySource
Base Hierarchy
::com::sun::star::uno::XInterface
 |
 +-XListEntrySource
Description
specifies a source of string list entries

The interface supports foreign components which actively retrieve list entries, as well as components which want to passively being notified of changes in the list.

See also
XListEntrySink

Methods' Summary
getListEntryCount retrieves the number of entries in the list
getListEntry provides access to a single list entry
getAllListEntries provides access to the entirety of all list entries
addListEntryListener adds a listener which will be notified about changes in the list reflected by the component.
removeListEntryListener revokes the given listener from the list of components which will be notfiied about changes in the entry list.
Methods' Details
getListEntryCount
long
getListEntryCount();
 
 

Description
retrieves the number of entries in the list
getListEntry
string
getListEntry(
 
[in] long 

raises(

 
Position ) 
::com::sun::star::lang::IndexOutOfBoundsException );

Description
provides access to a single list entry
Throws
::com::sun::star::lang::IndexOutOfBoundsException if the given position does not denote a valid index in the list
See also
getListEntryCount
getAllListEntries
sequence< string >
getAllListEntries();
 
 

Description
provides access to the entirety of all list entries
addListEntryListener
void
addListEntryListener(
 
[in] XListEntryListener 

raises(

 
Listener ) 
::com::sun::star::lang::NullPointerException );

Description
adds a listener which will be notified about changes in the list reflected by the component.
Throws
::com::sun::star::lang::NullPointerException if the given listener is NULL
removeListEntryListener
void
removeListEntryListener(
 
[in] XListEntryListener 

raises(

 
Listener ) 
::com::sun::star::lang::NullPointerException );

Description
revokes the given listener from the list of components which will be notfiied about changes in the entry list.
Throws
::com::sun::star::lang::NullPointerException if the given listener is NULL
Top of Page