offapi/com/sun/star/sheet/XRangeSelection.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: XRangeSelection.idl,v $
  10  * $Revision: 1.7 $
  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_sheet_XRangeSelection_idl__
  31 #define __com_sun_star_sheet_XRangeSelection_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_beans_PropertyValue_idl__
  38 #include <com/sun/star/beans/PropertyValue.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43  module com {  module sun {  module star {  module sheet {
  44
  45  published interface XRangeSelectionListener;
  46  published interface XRangeSelectionChangeListener;
  47
  48 //=============================================================================
  49
  50 /** allows to let the user to select a cell range.
  51
  52     @see com::sun::star::sheet::SpreadsheetView
  53  */
  54 published interface XRangeSelection: com::sun::star::uno::XInterface
  55 {
  56     /** starts the range selection.
  57
  58         @param aArguments
  59         the <type>RangeSelectionArguments</type> that specify how the
  60         range selection is done.
  61      */
  62     void startRangeSelection(
  63                 [in] sequence<com::sun::star::beans::PropertyValue> aArguments );
  64
  65     /** aborts the range selection.
  66      */
  67     void abortRangeSelection();
  68
  69     /** adds a listener that is notified when range selection is completed
  70         or aborted.
  71      */
  72     void addRangeSelectionListener(
  73                 [in] com::sun::star::sheet::XRangeSelectionListener aListener );
  74
  75     /** removes the specified listener.
  76      */
  77     void removeRangeSelectionListener(
  78                 [in] com::sun::star::sheet::XRangeSelectionListener aListener );
  79
  80     /** adds a listener that is notified when the selected range is changed.
  81      */
  82     void addRangeSelectionChangeListener(
  83                 [in] com::sun::star::sheet::XRangeSelectionChangeListener aListener );
  84
  85     /** removes the specified listener.
  86      */
  87     void removeRangeSelectionChangeListener(
  88                 [in] com::sun::star::sheet::XRangeSelectionChangeListener aListener );
  89
  90 };
  91
  92 //=============================================================================
  93
  94 }; }; }; };
  95
  96 #endif
  97