offapi/com/sun/star/sheet/TableConditionalFormat.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 #ifndef __com_sun_star_sheet_TableConditionalFormat_idl__
  21 #define __com_sun_star_sheet_TableConditionalFormat_idl__
  22
  23 #include <com/sun/star/sheet/XSheetConditionalEntries.idl>
  24 #include <com/sun/star/container/XNameAccess.idl>
  25 #include <com/sun/star/container/XEnumerationAccess.idl>
  26
  27
  28 module com {  module sun {  module star {  module sheet {
  29
  30
  31 /** represents a collection of conditional formatting settings for a
  32     cell or cell range.
  33
  34     <p>The style of the first fulfilled condition (in index order) will
  35     be applied to the cell(s).</p>
  36
  37     @see com::sun::star::sheet::SheetCell
  38     @see com::sun::star::sheet::SheetCellRange
  39     @see com::sun::star::sheet::SheetCellRanges
  40  */
  41 published service TableConditionalFormat
  42 {
  43
  44     /** provides methods to insert and remove conditions and to access
  45         the condition via index.
  46
  47         @see com::sun::star::sheet::TableConditionalEntry
  48      */
  49     interface com::sun::star::sheet::XSheetConditionalEntries;
  50
  51
  52     /** provides methods to access the condition via name.
  53
  54         <p>The name of a condition is "Entry", followed by its index
  55         (i.e. Entry0, Entry1, ...).</p>
  56
  57         @see com::sun::star::sheet::TableConditionalEntry
  58      */
  59     interface com::sun::star::container::XNameAccess;
  60
  61
  62     /** creates an enumeration of all conditional entries.
  63
  64         @see com::sun::star::sheet::TableConditionalEntryEnumeration
  65      */
  66     interface com::sun::star::container::XEnumerationAccess;
  67
  68
  69     /** provides methods to access the contained conditional entries by index.
  70
  71         @see com::sun::star::sheet::TableConditionalEntry
  72      */
  73     interface com::sun::star::container::XIndexAccess;
  74
  75 };
  76
  77
  78 }; }; }; };
  79
  80 #endif
  81
  82 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */