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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_sheet_RangeSelectionArguments_idl__
  28 #define __com_sun_star_sheet_RangeSelectionArguments_idl__
  29
  30 //=============================================================================
  31
  32  module com {  module sun {  module star {  module sheet {
  33
  34 //=============================================================================
  35
  36 /** contains the arguments for starting the range selection.
  37
  38     @see com::sun::star::sheet::XRangeSelection
  39  */
  40 published service RangeSelectionArguments
  41 {
  42     /** contains the initial value for the range descriptor.
  43      */
  44     [property] string InitialValue;
  45
  46     /** contains a title for the operation.
  47      */
  48     [property] string Title;
  49
  50     /** specifies if the range selection is finished when the
  51         mouse button is released, after selecting cells.
  52      */
  53     [property] boolean CloseOnMouseRelease;
  54
  55     /** specifies if the range selection is limited to a single
  56         cell only.
  57
  58         <p>If <TRUE/>, the selection is restricted to a
  59         single cell.  If <FALSE/>, multiple adjoining cells can be
  60         selected.  The default value is <FALSE/>.</p>
  61
  62     @since OOo 2.0.3
  63      */
  64     [optional, property] boolean SingleCellMode;
  65 };
  66
  67 //=============================================================================
  68
  69 }; }; }; };
  70
  71 #endif
  72