offapi/com/sun/star/chart/XStatisticDisplay.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 #ifndef __com_sun_star_chart_XStatisticDisplay_idl__
  20 #define __com_sun_star_chart_XStatisticDisplay_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/beans/XPropertySet.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module chart {
  29
  30
  31 /** gives access to statistical elements for the chart.
  32
  33     <p>Statistical elements are used by a
  34     StockDiagram.</p>
  35
  36     @see XChartDocument
  37     @see StockDiagram
  38  */
  39 published interface XStatisticDisplay: com::sun::star::uno::XInterface
  40 {
  41
  42     /** @returns
  43             the properties of the up bars of a stock chart which has
  44             StockDiagram::UpDown set to `TRUE`.
  45
  46         <p>The <em>UpBar</em> is the box that is drawn between the
  47         open and close value of a stock, when the closing value is
  48         above the opening value, i.e., the stock price rose.</p>
  49
  50         @see ChartArea
  51      */
  52     com::sun::star::beans::XPropertySet getUpBar();
  53
  54
  55     /** @returns
  56             the properties of the down bars of a stock chart which has
  57             StockDiagram::UpDown set to `TRUE`.
  58
  59         <p>The <em>DownBar</em> is the box that is drawn between the
  60         open and close value of a stock, when the closing value is
  61         below the opening value, i.e., the stock price fell.</p>
  62
  63         @see ChartArea
  64      */
  65     com::sun::star::beans::XPropertySet getDownBar();
  66
  67
  68     /** @returns
  69             the properties of the lines that are drawn between the
  70             lowest and highest stock value during a day.
  71
  72         @see ChartLine
  73      */
  74     com::sun::star::beans::XPropertySet getMinMaxLine();
  75
  76 };
  77
  78
  79 }; }; }; };
  80
  81 #endif
  82
  83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */