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