LibreOffice
LibreOffice 6.2 SDK API Reference
XMap.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 
20 #ifndef __com_sun_star_container_XMap_idl__
21 #define __com_sun_star_container_XMap_idl__
22 
28 
29 
30 module com { module sun { module star { module container {
31 
32 
44 interface XMap
45 {
46  interface XElementAccess;
47 
52  [attribute, readonly] type KeyType;
53 
58  [attribute, readonly] type ValueType;
59 
65  void clear()
66  raises( ::com::sun::star::lang::NoSupportException );
67 
84  boolean containsKey( [in] any Key )
85  raises( ::com::sun::star::beans::IllegalTypeException,
86  ::com::sun::star::lang::IllegalArgumentException );
87 
103  boolean containsValue( [in] any Value )
104  raises( ::com::sun::star::beans::IllegalTypeException,
105  ::com::sun::star::lang::IllegalArgumentException );
106 
125  any get( [in] any Key )
126  raises( ::com::sun::star::beans::IllegalTypeException,
127  ::com::sun::star::lang::IllegalArgumentException,
128  ::com::sun::star::container::NoSuchElementException );
129 
155  any put( [in] any Key, [in] any Value )
156  raises( ::com::sun::star::lang::NoSupportException,
157  ::com::sun::star::beans::IllegalTypeException,
158  ::com::sun::star::lang::IllegalArgumentException );
159 
180  any remove( [in] any Key )
181  raises( ::com::sun::star::lang::NoSupportException,
182  ::com::sun::star::beans::IllegalTypeException,
183  ::com::sun::star::lang::IllegalArgumentException,
184  ::com::sun::star::container::NoSuchElementException );
185 };
186 
187 
188 }; }; }; };
189 
190 
191 #endif
192 
193 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
describes a map between keys and values.
Definition: XMap.idl:44
Definition: Ambiguous.idl:22
type ValueType
denotes the type of the values in the map.
Definition: XMap.idl:58
This is the base interface of all collection interfaces.
Definition: XElementAccess.idl:33
is thrown by child access methods of collections, if the addressed child does not exist...
Definition: NoSuchElementException.idl:34