offapi/com/sun/star/sheet/XRangeSelection.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_sheet_XRangeSelection_idl__
  20 #define __com_sun_star_sheet_XRangeSelection_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/beans/PropertyValue.idl>
  24
  25
  26  module com {  module sun {  module star {  module sheet {
  27
  28  published interface XRangeSelectionListener;
  29  published interface XRangeSelectionChangeListener;
  30
  31
  32 /** allows to let the user to select a cell range.
  33
  34     @see com::sun::star::sheet::SpreadsheetView
  35  */
  36 published interface XRangeSelection: com::sun::star::uno::XInterface
  37 {
  38     /** starts the range selection.
  39
  40         @param aArguments
  41         the RangeSelectionArguments that specify how the
  42         range selection is done.
  43      */
  44     void startRangeSelection(
  45                 [in] sequence<com::sun::star::beans::PropertyValue> aArguments );
  46
  47     /** aborts the range selection.
  48      */
  49     void abortRangeSelection();
  50
  51     /** adds a listener that is notified when range selection is completed
  52         or aborted.
  53      */
  54     void addRangeSelectionListener(
  55                 [in] com::sun::star::sheet::XRangeSelectionListener aListener );
  56
  57     /** removes the specified listener.
  58      */
  59     void removeRangeSelectionListener(
  60                 [in] com::sun::star::sheet::XRangeSelectionListener aListener );
  61
  62     /** adds a listener that is notified when the selected range is changed.
  63      */
  64     void addRangeSelectionChangeListener(
  65                 [in] com::sun::star::sheet::XRangeSelectionChangeListener aListener );
  66
  67     /** removes the specified listener.
  68      */
  69     void removeRangeSelectionChangeListener(
  70                 [in] com::sun::star::sheet::XRangeSelectionChangeListener aListener );
  71
  72 };
  73
  74
  75 }; }; }; };
  76
  77 #endif
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */