offapi/com/sun/star/chart2/XAnyDescriptionAccess.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_chart2_XAnyDescriptionAccess_idl__
  20 #define __com_sun_star_chart2_XAnyDescriptionAccess_idl__
  21
  22 #include <com/sun/star/chart/XComplexDescriptionAccess.idl>
  23
  24
  25  module com {  module sun {  module star {  module chart2 {
  26
  27
  28 /** Offers any access to column and row descriptions.
  29 This allows to set date values as categories.
  30
  31 <p>Can be obtained from interface XChartDocument via method getData().</p>
  32
  33 @since OOo 3.4
  34 */
  35
  36 interface XAnyDescriptionAccess : ::com::sun::star::chart::XComplexDescriptionAccess
  37 {
  38
  39     /** retrieves the descriptions for all rows.
  40
  41         @returns
  42             a sequence of sequences of anys representing the descriptions
  43             of all rows. The outer index represents different rows.
  44             The inner index represents the different levels (usually there is only one).
  45             The any might be strings for category text axis or doubles for date axis.
  46      */
  47     sequence< sequence< any > > getAnyRowDescriptions();
  48
  49
  50     /** sets the descriptions for all rows.
  51
  52         @param rRowDescriptions
  53             a sequence of sequences of anys representing the descriptions of all
  54             rows. The outer index represents different rows.
  55             The inner index represents the different levels (usually there is only one).
  56             The any might be strings for category text axis or doubles for date axis.
  57     */
  58     void setAnyRowDescriptions( [in] sequence< sequence< any > > rRowDescriptions );
  59
  60
  61     /** retrieves the descriptions for all columns.
  62
  63         @returns
  64             a sequence of sequences of anys representing the descriptions
  65             of all columns. The outer index represents different columns.
  66             The inner index represents the different levels (usually there is only one).
  67             The any might be strings for category text axis or doubles for date axis.
  68      */
  69     sequence< sequence< any > > getAnyColumnDescriptions();
  70
  71
  72     /** sets the descriptions for all columns.
  73
  74         @param rColumnDescriptions
  75             a sequence of sequences of anys which represent the descriptions of
  76             all columns. The outer index represents different columns.
  77             The inner index represents the different levels (usually there is only one).
  78             The any might be strings for category text axis or doubles for date axis.
  79      */
  80     void setAnyColumnDescriptions( [in] sequence< sequence< any > > rColumnDescriptions );
  81 };
  82
  83
  84 }; }; }; };
  85
  86 #endif
  87
  88 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */