Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: view ::

interface XSelectionSupplier

Base Interface
com::sun::star::uno::XInterface

Description
makes it possible to access and change the selection in a view.
See also
OfficeDocumentView


Known Services which Export this Interface

com::sun::star::view::OfficeDocumentView specifies a view of a standard office document.
com::sun::star::form::control::GridControl describes a table-like control for displaying data.
com::sun::star::form::component::GridControl This service specifies a ControlModel to represent data in a table.
com::sun::star::drawing::DrawingDocumentDrawView This view service is implemented by objects that can display DrawPage s or MasterPage s in drawing mode.
com::sun::star::sheet::SpreadsheetView a view of a spreadsheet document.

Methods' Summary

select selects the object represented by xSelection if it is known and selectable in this object.
getSelection
addSelectionChangeListener registers an event listener, which is called when the selection changes.
removeSelectionChangeListener unregisters an event listener which was registered with XSelectionSupplier::addSelectionChangeListener .

Methods' Details

select
 
boolean
select(
[ in ] any xSelection )
raises ( com::sun::star::lang::IllegalArgumentException );

Description
selects the object represented by xSelection if it is known and selectable in this object.
getSelection
 
any
getSelection();
Returns
the current selection.

The selection is either specified by an object which is contained in the component to which the view belongs, or it is an interface of a collection which contains such objects.

addSelectionChangeListener
 
void
addSelectionChangeListener(
[ in ] com::sun::star::view::XSelectionChangeListener xListener );

Description
registers an event listener, which is called when the selection changes.
removeSelectionChangeListener
 
void
removeSelectionChangeListener(
[ in ] com::sun::star::view::XSelectionChangeListener xListener );

Description
unregisters an event listener which was registered with XSelectionSupplier::addSelectionChangeListener .

Top of Page