offapi/com/sun/star/sheet/XSheetCondition.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 /** provides methods to access the settings of a condition in a
  25     conditional format or data validation.
  26
  27     @see com::sun::star::sheet::TableConditionalEntry
  28     @see com::sun::star::sheet::TableValidation
  29  */
  30 published interface XSheetCondition: com::sun::star::uno::XInterface
  31 {
  32
  33     /** returns the operator in the condition.
  34      */
  35     com::sun::star::sheet::ConditionOperator getOperator();
  36
  37
  38     /** sets the operator in the condition.
  39      */
  40     void setOperator(
  41             [in] com::sun::star::sheet::ConditionOperator nOperator );
  42
  43
  44     /** returns either the comparison value, which is used in the condition,
  45         or the first value if two values are needed for the operator.
  46
  47         @returns
  48             a formula, a numeric constant, or a string constant in quotes.
  49      */
  50     string getFormula1();
  51
  52
  53     /** sets either the comparison value, which is used in the condition,
  54         or the first value if two values are needed for the operator.
  55
  56         @param aFormula1
  57             a formula, a numeric constant, or a string constant in quotes.
  58      */
  59     void setFormula1( [in] string aFormula1 );
  60
  61
  62     /** if two values are needed for the operator, this method returns
  63         the second one.
  64
  65         @returns
  66             a formula, a numeric constant, or a string constant in quotes.
  67      */
  68     string getFormula2();
  69
  70
  71     /** if two values are needed for the operator, this method sets
  72         the second one.
  73
  74         @param aFormula2
  75             a formula, a numeric constant, or a string constant in quotes.
  76      */
  77     void setFormula2( [in] string aFormula2 );
  78
  79
  80     /** returns the position in the document which is used as a base for
  81         relative references in the formulas.
  82      */
  83     com::sun::star::table::CellAddress getSourcePosition();
  84
  85
  86     /** sets the position in the document which is used as a base for
  87         relative references in the formulas.
  88      */
  89     void setSourcePosition(
  90             [in] com::sun::star::table::CellAddress aSourcePosition );
  91
  92 };
  93
  94
  95 }; }; }; };
  96
  97 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */