Interface XLayerManager

Attributes' Summary

Attributes' Details

interface XLayerManager

Base Interfaces

XLayerManager
┗ ::com::sun::star::container::XIndexAccess
   ┗ ::com::sun::star::container::XElementAccess

::com::sun::star::container::XIndexAccess

(referenced interface's summary:): provides access to the elements of a collection through an index.

Description: This interface makes it possible to access and manage the Layers of a document.
See also: LayerManager

Developers Guide: Drawings - Layer Handling

Methods' Summary
insertNewByIndex	creates a new Layer
remove	removes a Layer and all Shapes on this Layer.
attachShapeToLayer	attaches a Shape to the given Layer.
getLayerForShape	queries the Layer that a Shape is attached to

Methods' Details

insertNewByIndex

XLayer
insertNewByIndex(	[in] long	nIndex );

Description: creates a new Layer
Parameter nIndex: the index at which the new layer is inserted
Returns: the new created Layer

remove

void
remove(	[in] XLayer	xLayer )
raises(	::com::sun::star::container::NoSuchElementException );

Description: removes a Layer and all Shapes on this Layer.
Parameter xLayer: this Layer will be removed and disposed

attachShapeToLayer

void
attachShapeToLayer(	[in] XShape	xShape,
	[in] XLayer	xLayer );

Description: attaches a Shape to the given Layer.
Parameter xShape: this is the Shape that will be attached to a Layer
Parameter xLayer: this is the Layer that will be attached to a Shape

getLayerForShape

XLayer
getLayerForShape(	[in] XShape	xShape );

Description: queries the Layer that a Shape is attached to
Parameter xShape: specifies the Shape for which the layer is requested.
Returns: the Layer to which the Shape is attached.

Top of Page

Copyright © 2012, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.