LibreOffice LibreOffice 25.2 SDK API Reference

XDataProvider.idl
Go to the documentation of this file.
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
20module com
21{
22module sun
23{
24module star
25{
26module chart2
27{
28module data
29{
30
34 interface XDataProvider : ::com::sun::star::uno::XInterface
35{
40 boolean createDataSourcePossible( [in] sequence< com::sun::star::beans::PropertyValue > aArguments );
41
67 XDataSource createDataSource(
68 [in] sequence< com::sun::star::beans::PropertyValue > aArguments )
69 raises( com::sun::star::lang::IllegalArgumentException );
70
94 sequence< com::sun::star::beans::PropertyValue > detectArguments(
95 [in] XDataSource xDataSource );
96
102 boolean createDataSequenceByRangeRepresentationPossible( [in] string aRangeRepresentation );
103
117 XDataSequence createDataSequenceByRangeRepresentation(
118 [in] string aRangeRepresentation )
119 raises( com::sun::star::lang::IllegalArgumentException );
120
141 XDataSequence createDataSequenceByValueArray( [in] string aRole, [in] string aValueArray,
142 [in] string aRoleQualifier )
143 raises( com::sun::star::lang::IllegalArgumentException );
144
159 com::sun::star::sheet::XRangeSelection getRangeSelection();
160};
161
162} ; // data
163} ; // chart2
164} ; // com
165} ; // sun
166} ; // star
167
168
169/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:27
com::sun::star::chart2::data::XDataProvider
An application that provides data for a chart must implement this interface.
Definition: XDataProvider.idl:35
com::sun::star::chart2::data::XDataProvider::createDataSequenceByRangeRepresentationPossible
boolean createDataSequenceByRangeRepresentationPossible([in] string aRangeRepresentation)
If TRUE is returned, a call to createDataSequenceByRangeRepresentation with the same argument must re...
com::sun::star::chart2::data::XDataProvider::detectArguments
sequence< com::sun::star::beans::PropertyValue > detectArguments([in] XDataSource xDataSource)
Tries to find out with what parameters the passed DataSource most probably was created.
com::sun::star::chart2::data::XDataProvider::createDataSequenceByValueArray
XDataSequence createDataSequenceByValueArray([in] string aRole, [in] string aValueArray, [in] string aRoleQualifier)
Creates a single data sequence from the string value array representation.
com::sun::star::chart2::data::XDataProvider::createDataSequenceByRangeRepresentation
XDataSequence createDataSequenceByRangeRepresentation([in] string aRangeRepresentation)
creates a single data sequence for the given data range.
com::sun::star::chart2::data::XDataProvider::createDataSourcePossible
boolean createDataSourcePossible([in] sequence< com::sun::star::beans::PropertyValue > aArguments)
If TRUE is returned, a call to createDataSource with the same arguments must return a valid XDataSequ...
com::sun::star::chart2::data::XDataProvider::getRangeSelection
com::sun::star::sheet::XRangeSelection getRangeSelection()
Returns a component that is able to change a given range representation to another one.
com::sun::star::chart2::data::XDataProvider::createDataSource
XDataSource createDataSource([in] sequence< com::sun::star::beans::PropertyValue > aArguments)
Creates a data source object that matches the given range representation string.
com::sun::star::chart2::data::XDataSequence
allows access to a one-dimensional sequence of data.
Definition: XDataSequence.idl:37
com::sun::star::chart2::data::XDataSource
provides access to sequences of data.
Definition: XDataSource.idl:45
com::sun::star::sheet::XRangeSelection
allows to let the user to select a cell range.
Definition: XRangeSelection.idl:32
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com
Definition: Ambiguous.idl:20