| LibreOffice
    LibreOffice 24.8 SDK API Reference | 
maps strings to anys. More...
import "XStringKeyMap.idl";
| Public Member Functions | |
| any | getValue ([in] string aKey) raises ( com::sun::star::container::NoSuchElementException ) | 
| reads data from the map. | |
| boolean | hasValue ([in] string aKey) | 
| checks for element existence. | |
| void | insertValue ([in] string aKey, [in] any aValue) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::container::ElementExistException ) | 
| writes data to the map. | |
| string | getKeyByIndex ([in] long nIndex) raises ( com::sun::star::lang::IndexOutOfBoundsException ) | 
| obtains the key of an element by index. | |
| any | getValueByIndex ([in] long nIndex) raises ( com::sun::star::lang::IndexOutOfBoundsException ) | 
| obtains the value of an element by index. | |
| Public Attributes | |
| long | Count | 
| the number of elements in the map. | |
maps strings to anys.
| string getKeyByIndex | ( | [in] long | nIndex | ) | ||
| raises | ( | com::sun::star::lang::IndexOutOfBoundsException ) | ||||
obtains the key of an element by index.
| nIndex | is the index of the element. | 
| com::sun::star::lang::IndexOutOfBoundsException | if the specified index is greater than the number of elements | 
| any getValue | ( | [in] string | aKey | ) | ||
| raises | ( | com::sun::star::container::NoSuchElementException ) | ||||
reads data from the map.
| aKey | The key string which should be searched for. | 
| com::sun::star::container::NoSuchElementException | if an element under aKey does not exist. | 
| any getValueByIndex | ( | [in] long | nIndex | ) | ||
| raises | ( | com::sun::star::lang::IndexOutOfBoundsException ) | ||||
obtains the value of an element by index.
| nIndex | is the index of the key. | 
| com::sun::star::lang::IndexOutOfBoundsException | if the specified index is greater than the number of elements | 
| boolean hasValue | ( | [in] string | aKey | ) | 
checks for element existence.
| aKey | The key string which should be searched for. | 
| void insertValue | ( | [in] string | aKey, | |||
| [in] any | aValue ) | |||||
| raises | ( | com::sun::star::lang::IllegalArgumentException, | ||||
| com::sun::star::container::ElementExistException ) | ||||||
writes data to the map.
| aKey | The key string which should be used to store the value. | 
| aValue | The value that should be stored. | 
| com::sun::star::lang::IllegalArgumentException | if the element could not be inserted. | 
| com::sun::star::container::ElementExistException | if there is already a value stored under the key aKey. | 
| 
 | attributereadonly | 
the number of elements in the map.