Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: form :: binding ::

unpublished interface XListEntrySource
Usage Restrictions
not published
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
Developers Guide
Forms - External List Sources

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  Position )
raises( ::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  Listener )
raises( ::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  Listener )
raises( ::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

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.