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

interface XMultiSelectionSupplier
Base Interfaces
XMultiSelectionSupplierXSelectionSupplier

XSelectionSupplier
(referenced interface's summary:)
makes it possible to access and change the selection in a view.
Description
makes it possible to append and remove objects from a selection.

The method XSelectionSupplier::setSelection for an instance that also supports should be implemented that it also takes either a selectable object or a sequence of selectable objects.

Adding an object more than once to a selection should not toggle the selection for that object but only select it once


Methods' Summary
addSelection adds the object or the objects represented by Selection to the selection of this XMultiSelectionSupplier.  
removeSelection remove the object or objects represented by Selection from the selection of this XMultiSelectionSupplier.  
clearSelection clears the selection of this XMultiSelectionSupplier.  
getSelectionCount returns the number of selected objects of this XMultiSelectionSupplier.  
createSelectionEnumeration  
createReverseSelectionEnumeration  
Methods' Details
addSelection
boolean
addSelection( [in] any  Selection )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
adds the object or the objects represented by Selection to the selection of this XMultiSelectionSupplier.
Parameter Selection
either an Object that is selectable or a sequence of objects that are selectable.
Returns
true/, if Selection was added to the current selection. false, if Selection or parts of Selection could not be added to the current selection. For example, if the selection already contains objects that are forbidden to be selected together with Selection
Throws
com::sun::star::lang::IllegalArgumentException If Selection is not a selectable object for this XMultiSelectionSupplier.

Adding an object to the selection that is already part of the selection should not raise this exception

removeSelection
void
removeSelection( [in] any  Selection )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
remove the object or objects represented by Selection from the selection of this XMultiSelectionSupplier.
Parameter Selection
either an Object that is selectable or a sequence of objects that are selectable.
Returns
true/, if Selection was added to the current selection. false, if Selection or parts of Selection could not be added to the current selection. For example, if the selection already contains objects that are forbidden to be selected together with Selection.
Throws
com::sun::star::lang::IllegalArgumentException If Selection is not a selectable object for this XMultiSelectionSupplier.

Removing an object from the selection that is not part of the selection should not raise this exception

clearSelection
void
clearSelection();

Description
clears the selection of this XMultiSelectionSupplier.
getSelectionCount
long
getSelectionCount();

Description
returns the number of selected objects of this XMultiSelectionSupplier.
createSelectionEnumeration
::com::sun::star::container::XEnumeration
createSelectionEnumeration();

Returns
a new object to enumerate the selection of this XMultiSelectionSupplier. It returns NULL if there are no objects in the selection.
createReverseSelectionEnumeration
::com::sun::star::container::XEnumeration
createReverseSelectionEnumeration();

Returns
a new object to enumerate the selection of this XMultiSelectionSupplier in reverse order. If the order of the selected objects It returns NULL if there are no objects in the selection.
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.