offapi/com/sun/star/sheet/RangeSelectionArguments.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: RangeSelectionArguments.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_RangeSelectionArguments_idl__
  31 #define __com_sun_star_sheet_RangeSelectionArguments_idl__
  32
  33 //=============================================================================
  34
  35  module com {  module sun {  module star {  module sheet {
  36
  37 //=============================================================================
  38
  39 /** contains the arguments for starting the range selection.
  40
  41     @see com::sun::star::sheet::XRangeSelection
  42  */
  43 published service RangeSelectionArguments
  44 {
  45     /** contains the initial value for the range descriptor.
  46      */
  47     [property] string InitialValue;
  48
  49     /** contains a title for the operation.
  50      */
  51     [property] string Title;
  52
  53     /** specifies if the range selection is finished when the
  54         mouse button is released, after selecting cells.
  55      */
  56     [property] boolean CloseOnMouseRelease;
  57
  58     /** specifies if the range selection is limited to a single
  59         cell only.
  60
  61         <p>If <TRUE/>, the selection is restricted to a
  62         single cell.  If <FALSE/>, multiple adjoining cells can be
  63         selected.  The default value is <FALSE/>.</p>
  64
  65     @since OOo 2.0.3
  66      */
  67     [optional, property] boolean SingleCellMode;
  68 };
  69
  70 //=============================================================================
  71
  72 }; }; }; };
  73
  74 #endif
  75