offapi/com/sun/star/chart/XComplexDescriptionAccess.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_chart_XComplexDescriptionAccess_idl__
  20 #define __com_sun_star_chart_XComplexDescriptionAccess_idl__
  21
  22 #include <com/sun/star/chart/XChartDataArray.idl>
  23
  24
  25  module com {  module sun {  module star {  module chart {
  26
  27
  28 /** Offers access to complex column and row descriptions.
  29
  30 <p>Can be obtained from interface XChartDocument via method getData().</p>
  31
  32 @since OOo 3.3
  33 */
  34
  35 published interface XComplexDescriptionAccess : XChartDataArray
  36 {
  37
  38     /** retrieves the description texts for all rows.
  39
  40         @returns
  41             a sequence of sequences of strings representing the descriptions
  42             of all rows. The outer index represents different rows.
  43             The inner index represents the different levels (usually there is only one).
  44      */
  45     sequence< sequence< string > > getComplexRowDescriptions();
  46
  47
  48     /** sets the description texts for all rows.
  49
  50         @param rRowDescriptions
  51             a sequence of sequences of strings representing the descriptions of all
  52             rows. The outer index represents different rows.
  53             The inner index represents the different levels (usually there is only one).
  54     */
  55     void setComplexRowDescriptions( [in] sequence< sequence< string > > rRowDescriptions );
  56
  57
  58     /** retrieves the description texts for all columns.
  59
  60         @returns
  61             a sequence of sequences of strings representing the descriptions
  62             of all columns. The outer index represents different columns.
  63             The inner index represents the different levels (usually there is only one).
  64      */
  65     sequence< sequence< string > > getComplexColumnDescriptions();
  66
  67
  68     /** sets the description texts for all columns.
  69
  70         @param rColumnDescriptions
  71             a sequence of sequences of strings which represent the descriptions of
  72             all columns. The outer index represents different columns.
  73             The inner index represents the different levels (usually there is only one).
  74      */
  75     void setComplexColumnDescriptions( [in] sequence< sequence< string > > rColumnDescriptions );
  76 };
  77
  78
  79 }; }; }; };
  80
  81 #endif
  82
  83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */