offapi/com/sun/star/chart/XAxisXSupplier.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
  22  module com {  module sun {  module star {  module chart {
  23
  24
  25 /** gives access to the <i>x</i>-axis of a chart.
  26
  27     <p>Note that not all diagrams are capable of displaying an
  28     <i>x</i>-axis, e.g., the PieDiagram.</p>
  29
  30     @see XDiagram
  31  */
  32 published interface XAxisXSupplier: com::sun::star::uno::XInterface
  33 {
  34
  35     /** @returns
  36             the <i>x</i>-axis title shape.
  37
  38         @see ChartTitle
  39      */
  40     com::sun::star::drawing::XShape getXAxisTitle();
  41
  42
  43     /** @returns
  44             the properties of the <i>x</i>-axis of the diagram.
  45
  46         <p>The returned property set contains scaling properties as
  47         well as formatting properties.</p>
  48
  49         @see ChartAxis
  50      */
  51     com::sun::star::beans::XPropertySet getXAxis();
  52
  53
  54     /** @returns
  55             the properties of the main grid (major grid) of the
  56             <i>x</i>-axis of the diagram.
  57
  58         @see ChartGrid
  59      */
  60     com::sun::star::beans::XPropertySet getXMainGrid();
  61
  62
  63     /** @returns
  64             the properties of the help grid (minor grid) of the
  65             <i>x</i>-axis of the diagram.
  66
  67         @see ChartGrid
  68      */
  69     com::sun::star::beans::XPropertySet getXHelpGrid();
  70
  71 };
  72
  73
  74 }; }; }; };
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */