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

This interface makes it possible to access and manage the Layers of a document. More...

import"XLayerManager.idl";

Inheritance diagram for XLayerManager:
XIndexAccess XElementAccess XInterface LayerManager

Public Member Functions

com::sun::star::drawing::XLayer insertNewByIndex ([in] long nIndex)
 creates a new Layer More...
 
void remove ([in] com::sun::star::drawing::XLayer xLayer) raises ( com::sun::star::container::NoSuchElementException )
 removes a Layer and all Shapes on this Layer. More...
 
void attachShapeToLayer ([in] com::sun::star::drawing::XShape xShape, [in] com::sun::star::drawing::XLayer xLayer)
 attaches a Shape to the given Layer. More...
 
com::sun::star::drawing::XLayer getLayerForShape ([in] com::sun::star::drawing::XShape xShape)
 queries the Layer that a Shape is attached to More...
 
- Public Member Functions inherited from XIndexAccess
long getCount ()
 
any getByIndex ([in] long Index) raises ( com::sun::star::lang::IndexOutOfBoundsException, com::sun::star::lang::WrappedTargetException )
 
- Public Member Functions inherited from XElementAccess
type getElementType ()
 
boolean hasElements ()
 
- 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

This interface makes it possible to access and manage the Layers of a document.

See also
LayerManager
Developers Guide
Drawings - Layer Handling

Member Function Documentation

void attachShapeToLayer ( [in] com::sun::star::drawing::XShape  xShape,
[in] com::sun::star::drawing::XLayer  xLayer 
)

attaches a Shape to the given Layer.

Parameters
xShapethis is the Shape that will be attached to a Layer
xLayerthis is the Layer that will be attached to a Shape

queries the Layer that a Shape is attached to

Parameters
xShapespecifies the Shape for which the layer is requested.
Returns
the Layer to which the Shape is attached.
com::sun::star::drawing::XLayer insertNewByIndex ( [in] long  nIndex)

creates a new Layer

Parameters
nIndexthe index at which the new layer is inserted
Returns
the new created Layer

removes a Layer and all Shapes on this Layer.

Parameters
xLayerthis Layer will be removed and disposed

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