LibreOffice: com/sun/star/drawing/XLayerManager.idl Source File

LibreOffice LibreOffice 7.3 SDK API Reference

XLayerManager.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#ifndef __com_sun_star_drawing_XLayerManager_idl__
20#define __com_sun_star_drawing_XLayerManager_idl__
21
22#include <com/sun/star/container/XIndexAccess.idl>
23
24#include <com/sun/star/drawing/XLayer.idl>
25
26#include <com/sun/star/container/NoSuchElementException.idl>
27
28#include <com/sun/star/drawing/XShape.idl>
29
30
31
32 module com { module sun { module star { module drawing {
33
34
40published interface XLayerManager: com::sun::star::container::XIndexAccess
41{
42
51 com::sun::star::drawing::XLayer insertNewByIndex( [in] long nIndex );
52
53
60 void remove( [in] com::sun::star::drawing::XLayer xLayer )
61 raises( com::sun::star::container::NoSuchElementException );
62
63
72 void attachShapeToLayer( [in] com::sun::star::drawing::XShape xShape,
73 [in] com::sun::star::drawing::XLayer xLayer );
74
75
86 com::sun::star::drawing::XLayer getLayerForShape( [in] com::sun::star::drawing::XShape xShape );
87
88};
89
90
91}; }; }; };
92
93#endif
94
95/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
NoSuchElementException.idl
XIndexAccess.idl
XLayer.idl
XShape.idl
com::sun::star::container::NoSuchElementException
is thrown by child access methods of collections, if the addressed child does not exist.
Definition: NoSuchElementException.idl:35
com::sun::star::container::XIndexAccess
provides access to the elements of a collection through an index.
Definition: XIndexAccess.idl:40
com::sun::star::drawing::XLayerManager
This interface makes it possible to access and manage the Layers of a document.
Definition: XLayerManager.idl:41
com::sun::star::drawing::XLayerManager::attachShapeToLayer
void attachShapeToLayer([in] com::sun::star::drawing::XShape xShape, [in] com::sun::star::drawing::XLayer xLayer)
attaches a Shape to the given Layer.
com::sun::star::drawing::XLayerManager::insertNewByIndex
com::sun::star::drawing::XLayer insertNewByIndex([in] long nIndex)
creates a new Layer
com::sun::star::drawing::XLayerManager::getLayerForShape
com::sun::star::drawing::XLayer getLayerForShape([in] com::sun::star::drawing::XShape xShape)
queries the Layer that a Shape is attached to
com::sun::star::drawing::XLayer
identifies the object as a Layer.
Definition: XLayer.idl:32
com::sun::star::drawing::XShape
lets you do a basic transformation on a Shape and get its type.
Definition: XShape.idl:39
com
Definition: Accessible.idl:22