offapi/com/sun/star/sheet/TableConditionalFormat.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: TableConditionalFormat.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
  31 #ifndef __com_sun_star_sheet_TableConditionalFormat_idl__
  32 #define __com_sun_star_sheet_TableConditionalFormat_idl__
  33
  34 #ifndef __com_sun_star_sheet_XSheetConditionalEntries_idl__
  35 #include <com/sun/star/sheet/XSheetConditionalEntries.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_container_XNameAccess_idl__
  39 #include <com/sun/star/container/XNameAccess.idl>
  40 #endif
  41 #ifndef __com_sun_star_container_XEnumerationAccess_idl__
  42 #include <com/sun/star/container/XEnumerationAccess.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47 module com {  module sun {  module star {  module sheet {
  48
  49 //=============================================================================
  50
  51 /** represents a collection of conditional formatting settings for a
  52     cell or cell range.
  53
  54     <p>The style of the first fulfilled condition (in index order) will
  55     be applied to the cell(s).</p>
  56
  57     @see com::sun::star::sheet::SheetCell
  58     @see com::sun::star::sheet::SheetCellRange
  59     @see com::sun::star::sheet::SheetCellRanges
  60  */
  61 published service TableConditionalFormat
  62 {
  63     //-------------------------------------------------------------------------
  64
  65     /** provides methods to insert and remove conditions and to access
  66         the condition via index.
  67
  68         @see com::sun::star::sheet::TableConditionalEntry
  69      */
  70     interface com::sun::star::sheet::XSheetConditionalEntries;
  71
  72     //-------------------------------------------------------------------------
  73
  74     /** provides methods to access the condition via name.
  75
  76         <p>The name of a condition is "Entry", followed by its index
  77         (i.e. Entry0, Entry1, ...).</p>
  78
  79         @see com::sun::star::sheet::TableConditionalEntry
  80      */
  81     interface com::sun::star::container::XNameAccess;
  82
  83     //-------------------------------------------------------------------------
  84
  85     /** creates an enumeration of all conditional entries.
  86
  87         @see com::sun::star::sheet::TableConditionalEntryEnumeration
  88      */
  89     interface com::sun::star::container::XEnumerationAccess;
  90
  91     //-------------------------------------------------------------------------
  92
  93     /** provides methods to access the contained conditional entries by index.
  94
  95         @see com::sun::star::sheet::TableConditionalEntry
  96      */
  97     interface com::sun::star::container::XIndexAccess;
  98
  99 };
 100
 101 //=============================================================================
 102
 103 }; }; }; };
 104
 105 #endif
 106