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