LibreOffice: com/sun/star/container/XNameContainer.idl Source File

LibreOffice LibreOffice 7.3 SDK API Reference

XNameContainer.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_container_XNameContainer_idl__
20#define __com_sun_star_container_XNameContainer_idl__
21
22#include <com/sun/star/container/XNameReplace.idl>
23
24#include <com/sun/star/lang/IllegalArgumentException.idl>
25
26#include <com/sun/star/container/ElementExistException.idl>
27
28#include <com/sun/star/lang/WrappedTargetException.idl>
29
30#include <com/sun/star/container/NoSuchElementException.idl>
31
32
33module com { module sun { module star { module container {
34
35
40published interface XNameContainer: com::sun::star::container::XNameReplace
41{
42
45 void insertByName( [in] string aName,
46 [in] any aElement )
47 raises( com::sun::star::lang::IllegalArgumentException,
48 com::sun::star::container::ElementExistException,
49 com::sun::star::lang::WrappedTargetException );
50
51
54 void removeByName( [in] string Name )
55 raises( com::sun::star::container::NoSuchElementException,
56 com::sun::star::lang::WrappedTargetException );
57
58};
59
60
61}; }; }; };
62
63#endif
64
65/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
ElementExistException.idl
IllegalArgumentException.idl
NoSuchElementException.idl
WrappedTargetException.idl
XNameReplace.idl
com::sun::star::container::ElementExistException
is thrown by container methods, if an element is added which is already a child of the container.
Definition: ElementExistException.idl:39
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::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
com::sun::star::lang::WrappedTargetException
This is a checked exception that wraps an exception thrown by the original target.
Definition: WrappedTargetException.idl:38
com::sun::star::container::XNameContainer
This is the generic interface for supporting the insertion and removal of named elements.
Definition: XNameContainer.idl:41
com::sun::star::container::XNameContainer::removeByName
void removeByName([in] string Name)
removes the element with the specified name.
com::sun::star::container::XNameContainer::insertByName
void insertByName([in] string aName, [in] any aElement)
inserts the given element at the specified name.
com::sun::star::container::XNameReplace
This is the generic interface for supporting the replacement of named elements.
Definition: XNameReplace.idl:39
com
Definition: Ambiguous.idl:22