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