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