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

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