offapi/com/sun/star/chart2/data/LabelOrigin.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: LabelOrigin.idl,v $
  10  * $Revision: 1.3 $
  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
  31 #ifndef com_sun_star_chart2_data_LabelOrigin_idl
  32 #define com_sun_star_chart2_data_LabelOrigin_idl
  33
  34 //=============================================================================
  35
  36 module com {  module sun {  module star {  module chart2 { module data {
  37
  38 //=============================================================================
  39
  40 /** is used to specify how the labels have to be created.
  41
  42     @see <member>XDataSequence::generateLabel</member>.
  43  */
  44 enum LabelOrigin
  45 {
  46     //-------------------------------------------------------------------------
  47
  48     /** If a range spans a single row over more than one column, this
  49         parameter has the same effect as ROW.  If the range spans a
  50         single column over more than one row, this is the same as
  51         COLUMN.
  52
  53         <p>In case of a range spanning more than one column and row,
  54         the shorter range of both should be used (e.g. a spreadsheet
  55         range A1:B10 should treat columns as short side).</p>
  56
  57         <p>In case of a rectangular range, or a range that is composed
  58         of more than one contiguous sub-regions, the short side cannot
  59         be determined, thus
  60         <member>XDataSequence::generateLabel</member> will return an
  61         empty sequence.</p>
  62      */
  63     SHORT_SIDE,
  64
  65     //-------------------------------------------------------------------------
  66
  67     /** This is exactly the opposite of SHORT_SIDE.  I.e., if
  68         SHORT_SIDE has the same effect as ROW, LONG_SIDE will have the
  69         same effect as COLUMN and the other way round.
  70
  71         @see <member>LabelOrigin::SHORT_SIDE</member>
  72      */
  73     LONG_SIDE,
  74
  75     //-------------------------------------------------------------------------
  76
  77     /** Uses the column name for label generation.  A spreadsheet
  78         range A1:A6 could, e.g., result in "Column A".
  79
  80         <p>If a range consists of more than one column the result of
  81         label generation may be empty.  Of course, it could also
  82         succeed with a string like "Columns A to B".
  83      */
  84     COLUMN,
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** Uses the column name for label generation.  A spreadsheet
  89         range A2:D2 could, e.g., result in "Row 2".
  90
  91         <p>If a range consists of more than one row the result of
  92         label generation may be empty.  Of course, it could also
  93         succeed with a string like "Rows 1-3".
  94      */
  95     ROW
  96 };
  97
  98 //=============================================================================
  99
 100 }; }; }; }; };
 101
 102 #endif
 103