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

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