(incubating) | The Free and Open Productivity Suite

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.
Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

:: 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

Copyright © 1995, 2010, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

Copyright & License
Apache and the Apache feather logos are trademarks of The Apache Software Foundation. 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.