LibreOffice
LibreOffice 24.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 
21 module com { module sun { module star { module container {
22 
23 
35 interface XMap
36 {
37  interface XElementAccess;
38 
43  [attribute, readonly] type KeyType;
44 
49  [attribute, readonly] type ValueType;
50 
56  void clear()
57  raises( ::com::sun::star::lang::NoSupportException );
58 
75  boolean containsKey( [in] any Key )
76  raises( ::com::sun::star::beans::IllegalTypeException,
77  ::com::sun::star::lang::IllegalArgumentException );
78 
94  boolean containsValue( [in] any Value )
95  raises( ::com::sun::star::beans::IllegalTypeException,
96  ::com::sun::star::lang::IllegalArgumentException );
97 
116  any get( [in] any Key )
117  raises( ::com::sun::star::beans::IllegalTypeException,
118  ::com::sun::star::lang::IllegalArgumentException,
119  ::com::sun::star::container::NoSuchElementException );
120 
146  any put( [in] any Key, [in] any Value )
147  raises( ::com::sun::star::lang::NoSupportException,
148  ::com::sun::star::beans::IllegalTypeException,
149  ::com::sun::star::lang::IllegalArgumentException );
150 
171  any remove( [in] any Key )
172  raises( ::com::sun::star::lang::NoSupportException,
173  ::com::sun::star::beans::IllegalTypeException,
174  ::com::sun::star::lang::IllegalArgumentException,
175  ::com::sun::star::container::NoSuchElementException );
176 };
177 
178 
179 }; }; }; };
180 
181 
182 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
describes a map between keys and values.
Definition: XMap.idl:35
Definition: Ambiguous.idl:20
type ValueType
denotes the type of the values in the map.
Definition: XMap.idl:49
This is the base interface of all collection interfaces.
Definition: XElementAccess.idl:27
is thrown by child access methods of collections, if the addressed child does not exist...
Definition: NoSuchElementException.idl:30