offapi/com/sun/star/sheet/RangeSelectionArguments.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_RangeSelectionArguments_idl__
  20 #define __com_sun_star_sheet_RangeSelectionArguments_idl__
  21
  22
  23  module com {  module sun {  module star {  module sheet {
  24
  25
  26 /** contains the arguments for starting the range selection.
  27
  28     @see com::sun::star::sheet::XRangeSelection
  29  */
  30 published service RangeSelectionArguments
  31 {
  32     /** contains the initial value for the range descriptor.
  33      */
  34     [property] string InitialValue;
  35
  36     /** contains a title for the operation.
  37      */
  38     [property] string Title;
  39
  40     /** specifies if the range selection is finished when the
  41         mouse button is released, after selecting cells.
  42      */
  43     [property] boolean CloseOnMouseRelease;
  44
  45     /** specifies if the range selection is limited to a single
  46         cell only.
  47
  48         <p>If `TRUE`, the selection is restricted to a
  49         single cell.  If `FALSE`, multiple adjoining cells can be
  50         selected.  The default value is `FALSE`.</p>
  51
  52     @since OOo 2.0.3
  53      */
  54     [optional, property] boolean SingleCellMode;
  55 };
  56
  57
  58 }; }; }; };
  59
  60 #endif
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */