offapi/com/sun/star/chart2/data/XRangeXMLConversion.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_data_XRangeXMLConversion_idl
  20 #define com_sun_star_chart2_data_XRangeXMLConversion_idl
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/lang/IllegalArgumentException.idl>
  24
  25 module com
  26 {
  27 module sun
  28 {
  29 module star
  30 {
  31 module chart2
  32 {
  33 module data
  34 {
  35
  36 /** An application that provides data for a chart must implement this
  37     interface.
  38  */
  39 interface XRangeXMLConversion : ::com::sun::star::uno::XInterface
  40 {
  41     /** converts the range to a valid XML syntax.
  42
  43         <p>For example spreadsheet ranges consisting of more than one
  44         consecutive region are usually separated by a semicolon
  45         whereas in XML you separate multiple regions by a space.</p>
  46      */
  47     string convertRangeToXML( [in] string aRangeRepresentation )
  48         raises( com::sun::star::lang::IllegalArgumentException );
  49
  50     /** converts an XML-style range into the internal
  51         DataProvider's format.
  52      */
  53     string convertRangeFromXML( [in] string aXMLRange )
  54         raises( com::sun::star::lang::IllegalArgumentException );
  55 };
  56
  57 } ; // data
  58 } ; // chart2
  59 } ; // com
  60 } ; // sun
  61 } ; // star
  62
  63
  64 #endif
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */