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