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

LibreOffice LibreOffice 7.3 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
23#include <com/sun/star/beans/IllegalTypeException.idl>
24#include <com/sun/star/lang/IllegalArgumentException.idl>
25#include <com/sun/star/container/NoSuchElementException.idl>
26#include <com/sun/star/lang/NoSupportException.idl>
27#include <com/sun/star/container/XElementAccess.idl>
28
29
30module 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: */
IllegalArgumentException.idl
IllegalTypeException.idl
NoSuchElementException.idl
NoSupportException.idl
XElementAccess.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::XElementAccess
This is the base interface of all collection interfaces.
Definition: XElementAccess.idl:34
com::sun::star::container::XMap
describes a map between keys and values.
Definition: XMap.idl:45
com::sun::star::container::XMap::KeyType
type KeyType
denotes the type of the keys in the map.
Definition: XMap.idl:46
com::sun::star::container::XMap::ValueType
type ValueType
denotes the type of the values in the map.
Definition: XMap.idl:58
com::sun::star::container::XMap::clear
void clear()
clears the map, removing all key-value pairs from it.
com
Definition: Accessible.idl:22