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