LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XDataReceiver Interface Reference

import"XDataReceiver.idl";

Inheritance diagram for XDataReceiver:
XInterface ChartDocument

Public Member Functions

void attachDataProvider ([in] XDataProvider xProvider)
 attaches a component that provides data for the document. More...
 
void setArguments ([in] sequence< com::sun::star::beans::PropertyValue > aArguments) raises ( com::sun::star::lang::IllegalArgumentException )
 
sequence< string > getUsedRangeRepresentations ()
 returns a list of all range strings for which data has been requested by the most recently attached data provider, and which is still used. More...
 
XDataSource getUsedData ()
 Returns the data requested by the most recently attached data provider, that is still used. More...
 
void attachNumberFormatsSupplier ([in] com::sun::star::util::XNumberFormatsSupplier xSupplier)
 attaches an XNumberFormatsSupplier to this XDataReceiver. More...
 
XRangeHighlighter getRangeHighlighter ()
 Returns a component at which a view representing the data of the attached data provider may listen for highlighting the data ranges used by the currently selected objects in the data receiver component. More...
 
com::sun::star::awt::XRequestCallback getPopupRequest ()
 A callback object to execute a foreign popup menu window. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Member Function Documentation

void attachDataProvider ( [in] XDataProvider  xProvider)

attaches a component that provides data for the document.

The previously set data provider will be released.

Parameters
xProviderThe new DataProvider. If it is an empty reference, the ChartDocument will have no data.
void attachNumberFormatsSupplier ( [in] com::sun::star::util::XNumberFormatsSupplier  xSupplier)

attaches an XNumberFormatsSupplier to this XDataReceiver.

The given number formats will be used for display purposes.

A callback object to execute a foreign popup menu window.

Since
LibreOffice 5.4
XRangeHighlighter getRangeHighlighter ( )

Returns a component at which a view representing the data of the attached data provider may listen for highlighting the data ranges used by the currently selected objects in the data receiver component.

This is typically used by a spreadsheet to highlight the ranges used by the currently selected object in a chart.

The range highlighter is optional, i.e., this method may return an empty object.

XDataSource getUsedData ( )

Returns the data requested by the most recently attached data provider, that is still used.

sequence< string > getUsedRangeRepresentations ( )

returns a list of all range strings for which data has been requested by the most recently attached data provider, and which is still used.

This list may be used by the data provider to swap charts out of memory, but still get informed by changes of ranges while the chart is not loaded.

Returns
a list of used range strings.
void setArguments ( [in] sequence< com::sun::star::beans::PropertyValue aArguments)
raises (com::sun::star::lang::IllegalArgumentException
)

The documentation for this interface was generated from the following file: