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

represents something that can be rendered. More...

import"XRenderable.idl";

Inheritance diagram for XRenderable:
XInterface

Public Member Functions

long getRendererCount ([in] any aSelection, [in] sequence< com::sun::star::beans::PropertyValue > xOptions) raises ( com::sun::star::lang::IllegalArgumentException )
 
sequence< com::sun::star::beans::PropertyValuegetRenderer ([in] long nRenderer, [in] any aSelection, [in] sequence< com::sun::star::beans::PropertyValue > xOptions) raises ( com::sun::star::lang::IllegalArgumentException )
 
void render ([in] long nRenderer, [in] any aSelection, [in] sequence< com::sun::star::beans::PropertyValue > xOptions) raises ( com::sun::star::lang::IllegalArgumentException )
 renders the object. 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...
 

Detailed Description

represents something that can be rendered.

Since
OOo 1.1.2

Member Function Documentation

sequence<com::sun::star::beans::PropertyValue> getRenderer ( [in] long  nRenderer,
[in] any  aSelection,
[in] sequence< com::sun::star::beans::PropertyValue xOptions 
)
raises (com::sun::star::lang::IllegalArgumentException
)
Returns
a descriptor of the specific renderer.

returns the specific renderer properties based on the given selection.

If the selection contains a valid XModel interface, it is assumed that the whole document should be rendered. If the selection is empty, nothing should be rendered.

See also
RenderDescriptor
RenderOptions
long getRendererCount ( [in] any  aSelection,
[in] sequence< com::sun::star::beans::PropertyValue xOptions 
)
raises (com::sun::star::lang::IllegalArgumentException
)
Returns
the count of renderers (based on paper count of a document, for example).

If a selection is given, the count has to be calculated based on this selection. The other methods of this interface will rely on this value if called.

If the selection contains a valid XModel interface, it is assumed that the whole document should be rendered. If the selection is empty, nothing should be rendered.

See also
RenderOptions
void render ( [in] long  nRenderer,
[in] any  aSelection,
[in] sequence< com::sun::star::beans::PropertyValue xOptions 
)
raises (com::sun::star::lang::IllegalArgumentException
)

renders the object.

renders the object with the specific renderer based on the given selection.

If the selection contains a valid XModel interface, it is assumed that the whole document should be rendered. If the selection is empty, nothing should be rendered.

See also
RenderOptions

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