offapi/com/sun/star/sheet/XSheetConditionalEntries.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
  20
  21 module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** provides methods to add and remove conditions of a conditional format.
  25
  26     @see com::sun::star::sheet::TableConditionalFormat
  27     @see com::sun::star::sheet::TableConditionalEntry
  28  */
  29 published interface XSheetConditionalEntries: com::sun::star::container::XIndexAccess
  30 {
  31
  32     /** adds a conditional entry to the format.
  33
  34         <p>Supported properties are:</p>
  35
  36         <dl>
  37         <dt>ConditionOperator Operator</dt>
  38         <dd>contains the operation to perform for this condition.</dd>
  39
  40         <dt>`string` Formula1</dt>
  41         <dd>contains the value or formula for the operation.</dd>
  42
  43         <dt>`string` Formula2</dt>
  44         <dd>contains the second value or formula for the operation (used with
  45         ConditionOperator::BETWEEN or
  46         ConditionOperator::NOT_BETWEEN operations).</dd>
  47
  48         <dt>com::sun::star::table::CellAddress
  49         SourcePosition</dt>
  50         <dd>contains the base address for relative cell references in formulas.
  51         </dd>
  52
  53         <dt>`string` StyleName</dt>
  54         <dd>contains the name of the cell style used by this condition.</dd>
  55         </dl>
  56
  57         @see com::sun::star::sheet::TableConditionalFormat
  58      */
  59     void addNew( [in] sequence< com::sun::star::beans::PropertyValue > aConditionalEntry );
  60
  61
  62     /** removes a conditional entry from the format.
  63      */
  64     void removeByIndex( [in] long nIndex );
  65
  66
  67     /** clears all condition entries.
  68      */
  69     void clear();
  70
  71 };
  72
  73
  74 }; }; }; };
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */