offapi/com/sun/star/view/XSelectionSupplier.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XSelectionSupplier.idl,v $
  10  * $Revision: 1.11 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_view_XSelectionSupplier_idl__
  31 #define __com_sun_star_view_XSelectionSupplier_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  38 #include <com/sun/star/lang/IllegalArgumentException.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_view_XSelectionChangeListener_idl__
  42 #include <com/sun/star/view/XSelectionChangeListener.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module view {
  49
  50 //=============================================================================
  51
  52 /** makes it possible to access and change the selection in a view.
  53
  54     @see OfficeDocumentView
  55  */
  56 published interface XSelectionSupplier: com::sun::star::uno::XInterface
  57 {
  58     //-------------------------------------------------------------------------
  59     /** selects the object represented by <var>xSelection</var> if it is
  60         known and selectable in this object.
  61      */
  62     boolean select( [in] any xSelection )
  63             raises( com::sun::star::lang::IllegalArgumentException );
  64
  65     //-------------------------------------------------------------------------
  66     /** @returns
  67                 the current selection.
  68
  69         <p>The selection is either specified by an object which is contained
  70         in the component to which the view belongs, or it is an interface of a
  71         collection which contains such objects.
  72      */
  73     any getSelection();
  74
  75     //-------------------------------------------------------------------------
  76     /** registers an event listener, which is called when the selection changes.
  77      */
  78     void addSelectionChangeListener( [in] com::sun::star::view::XSelectionChangeListener xListener );
  79
  80     //-------------------------------------------------------------------------
  81     /** unregisters an event listener which was registered with
  82         <method>XSelectionSupplier::addSelectionChangeListener</method>.
  83      */
  84     void removeSelectionChangeListener( [in] com::sun::star::view::XSelectionChangeListener xListener );
  85
  86 };
  87
  88 //=============================================================================
  89
  90 }; }; }; };
  91
  92 #endif