offapi/com/sun/star/chart2/XScaling.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_chart2_XScaling_idl
  21 #define com_sun_star_chart2_XScaling_idl
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24
  25
  26 module com {  module sun {  module star {  module chart2 {
  27
  28
  29 interface XScaling : ::com::sun::star::uno::XInterface
  30 {
  31     /**
  32      * Given a numeric value, return the scaled value that conforms
  33      * to a predefined scaling rule.  For instance, for linear
  34      * scaling, given a x value, the method may return a y value as
  35      * defined by y = Ax + B for predefined values of A and B.
  36      *
  37      * @param value input value from which to calculate the scaled
  38      *              value.
  39      *
  40      * @return scaled value based on a predefined scaling rule.
  41      */
  42     double doScaling( [in] double value );
  43
  44     /**
  45      * Get an interface object that conforms to a scaling rule that
  46      * is the reverse of the original scaling rule.
  47      *
  48      * @return internface object that represents the reversed
  49      *         scaling rule.
  50      */
  51     com::sun::star::chart2::XScaling getInverseScaling();
  52 };
  53
  54
  55 }; }; }; };
  56
  57 #endif
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */