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