LibreOffice LibreOffice 25.2 SDK API Reference

XStringKeyMap.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
21module com { module sun { module star { module container {
22
23
29 interface XStringKeyMap
30{
42 any getValue( [in] string aKey )
43 raises( com::sun::star::container::NoSuchElementException );
44
45
54 boolean hasValue( [in] string aKey );
55
56
71 void insertValue( [in] string aKey, [in] any aValue )
72 raises( com::sun::star::lang::IllegalArgumentException,
73 com::sun::star::container::ElementExistException );
74
75
78 [attribute, readonly] long Count;
79
80
93 string getKeyByIndex( [in] long nIndex )
94 raises( com::sun::star::lang::IndexOutOfBoundsException );
95
96
109 any getValueByIndex( [in] long nIndex )
110 raises( com::sun::star::lang::IndexOutOfBoundsException );
111};
112
113}; }; }; };
114
115/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
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:35
com::sun::star::container::NoSuchElementException
is thrown by child access methods of collections, if the addressed child does not exist.
Definition: NoSuchElementException.idl:31
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:27
com::sun::star::lang::IndexOutOfBoundsException
This exception is thrown to indicate that a container has been accessed with an illegal index.
Definition: IndexOutOfBoundsException.idl:31
com::sun::star::container::XStringKeyMap
maps strings to anys.
Definition: XStringKeyMap.idl:30
com::sun::star::container::XStringKeyMap::Count
long Count
the number of elements in the map.
Definition: XStringKeyMap.idl:78
com::sun::star::container::XStringKeyMap::getKeyByIndex
string getKeyByIndex([in] long nIndex)
obtains the key of an element by index.
com::sun::star::container::XStringKeyMap::getValueByIndex
any getValueByIndex([in] long nIndex)
obtains the value of an element by index.
com::sun::star::container::XStringKeyMap::getValue
any getValue([in] string aKey)
reads data from the map.
com::sun::star::container::XStringKeyMap::hasValue
boolean hasValue([in] string aKey)
checks for element existence.
com::sun::star::container::XStringKeyMap::insertValue
void insertValue([in] string aKey, [in] any aValue)
writes data to the map.
com
Definition: Ambiguous.idl:20