offapi/com/sun/star/sheet/XSheetConditionalEntries.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
  28 #ifndef __com_sun_star_sheet_XSheetConditionalEntries_idl__
  29 #define __com_sun_star_sheet_XSheetConditionalEntries_idl__
  30
  31 #ifndef __com_sun_star_container_XIndexAccess_idl__
  32 #include <com/sun/star/container/XIndexAccess.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_beans_PropertyValue_idl__
  36 #include <com/sun/star/beans/PropertyValue.idl>
  37 #endif
  38
  39 //=============================================================================
  40
  41 module com {  module sun {  module star {  module sheet {
  42
  43 //=============================================================================
  44
  45 /** provides methods to add and remove conditions of a conditional format.
  46
  47     @see com::sun::star::sheet::TableConditionalFormat
  48     @see com::sun::star::sheet::TableConditionalEntry
  49  */
  50 published interface XSheetConditionalEntries: com::sun::star::container::XIndexAccess
  51 {
  52     //-------------------------------------------------------------------------
  53
  54     /** adds a conditional entry to the format.
  55
  56         <p>Supported properties are:</p>
  57
  58         <dl>
  59         <dt><type>ConditionOperator</type> Operator</dt>
  60         <dd>contains the operation to perform for this condition.</dd>
  61
  62         <dt><atom>string</atom> Formula1</dt>
  63         <dd>contains the value or formula for the operation.</dd>
  64
  65         <dt><atom>string</atom> Formula2</dt>
  66         <dd>contains the second value or formula for the operation (used with
  67         <const>ConditionOperator::BETWEEN</const> or
  68         <const>ConditionOperator::NOT_BETWEEN</const> operations).</dd>
  69
  70         <dt><type scope="com::sun::star::table">CellAddress</type>
  71         SourcePosition</dt>
  72         <dd>contains the base address for relative cell references in formulas.
  73         </dd>
  74
  75         <dt><atom>string</atom> StyleName</dt>
  76         <dd>contains the name of the cell style used by this condition.</dd>
  77         </dl>
  78
  79         @see com::sun::star::sheet::TableConditionalFormat
  80      */
  81     void addNew( [in] sequence< com::sun::star::beans::PropertyValue > aConditionalEntry );
  82
  83     //-------------------------------------------------------------------------
  84
  85     /** removes a conditional entry from the format.
  86      */
  87     void removeByIndex( [in] long nIndex );
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** clears all condition entries.
  92      */
  93     void clear();
  94
  95 };
  96
  97 //=============================================================================
  98
  99 }; }; }; };
 100
 101 #endif
 102