offapi/com/sun/star/chart/ChartAxisLabelPosition.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ChartAxisLabelPosition.idl,v $
  10  * $Revision: 1.1.4.2 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_chart_ChartAxisLabelPosition_idl__
  31 #define __com_sun_star_chart_ChartAxisLabelPosition_idl__
  32
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module chart {
  37
  38 //=============================================================================
  39
  40 /** Specifies the position of the axis labels with respect to the axis on the scale of the crossing axis.
  41 */
  42
  43 published enum ChartAxisLabelPosition
  44 {
  45     //-------------------------------------------------------------------------
  46
  47     /** The labels are placed adjacent to the axis. When the axis itself is placed at the minimum or maximum of the scale ( that is when the property CrossoverPosition equals ChartAxisPosition_MINIMUM or ChartAxisPosition_MAXIMUM)
  48         the labels are placed outside the coordinate system. Otherwise the labels are placed adjacent to the axis on that side that belongs to the lower values on the crossing axis.
  49         E.g. when the ChartAxisLabelPosition is set to NEAR_AXIS for an y axis the labels are placed adjacent to the y axis on that side that belongs to the lower x values.
  50      */
  51     NEAR_AXIS,
  52
  53     //-------------------------------------------------------------------------
  54
  55     /** The labels are placed adjacent to the axis on the opposite side as for NEAR_AXIS.
  56      */
  57     NEAR_AXIS_OTHER_SIDE,
  58
  59     //-------------------------------------------------------------------------
  60
  61     /** The labels are placed outside the coordinate region on that side where the crossing axis has its minimum value.
  62         E.g. when this is set for an y axis the labels are placed outside the diagram on that side where to the x axis has its minimum value.
  63      */
  64     OUTSIDE_START,
  65
  66     //-------------------------------------------------------------------------
  67
  68     /** The labels are placed outside the coordinate region on that side where the crossing axis has its maximum value.
  69         E.g. when this is set for an y axis the labels are placed outside the diagram on that side where to the x axis has its maximum value.
  70      */
  71     OUTSIDE_END
  72 };
  73
  74 //=============================================================================
  75
  76 }; }; }; };
  77
  78 #endif