Content for OpenOffice.org version 3.3.
:: com :: sun :: star :: view ::
|
| unpublished |
interface XMultiSelectionSupplier |
|
|
- Base Interfaces
XMultiSelectionSupplier
┗ XSelectionSupplier
| XSelectionSupplier |
- (referenced interface's summary:)
- makes it possible to access and change the selection in a view.
|
|
- Usage Restrictions
- not published
- 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' Details |
addSelection
- 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
@raises 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
- 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.
@raises 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
|
| getSelectionCount
|
createSelectionEnumeration
- Returns
- a new object to enumerate the selection of this XMultiSelectionSupplier.
It returns NULL if there are no objects in the selection.
|
|
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
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.
