offapi/com/sun/star/chart2/data/XRangeXMLConversion.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef com_sun_star_chart2_data_XRangeXMLConversion_idl
  28 #define com_sun_star_chart2_data_XRangeXMLConversion_idl
  29
  30 #include <com/sun/star/uno/XInterface.idl>
  31 #include <com/sun/star/lang/IllegalArgumentException.idl>
  32
  33 module com
  34 {
  35 module sun
  36 {
  37 module star
  38 {
  39 module chart2
  40 {
  41 module data
  42 {
  43
  44 /** An application that provides data for a chart must implement this
  45     interface.
  46  */
  47 interface XRangeXMLConversion : ::com::sun::star::uno::XInterface
  48 {
  49     /** converts the range to a valid XML syntax.
  50
  51         <p>For example spreadsheet ranges consisting of more than one
  52         consecutive region are usually separated by a semicolon
  53         whereas in XML you separate multiple regions by a spacce.</p>
  54      */
  55     string convertRangeToXML( [in] string aRangeRepresentation )
  56         raises( com::sun::star::lang::IllegalArgumentException );
  57
  58     /** converts an XML-style range into the internal
  59         <type>DataProvider</type>'s format.
  60      */
  61     string convertRangeFromXML( [in] string aXMLRange )
  62         raises( com::sun::star::lang::IllegalArgumentException );
  63 };
  64
  65 } ; // data
  66 } ; // chart2
  67 } ; // com
  68 } ; // sun
  69 } ; // star
  70
  71
  72 #endif