LibreOffice LibreOffice 25.2 SDK API Reference

XItemList.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 awt {
22
23 interface XItemListListener;
24
25
28 interface XItemList
29{
32 [attribute, readonly] long ItemCount;
33
49 void insertItem(
50 [in] long Position,
51 [in] string ItemText,
52 [in] string ItemImageURL
53 )
54 raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
55
68 void insertItemText(
69 [in] long Position,
70 [in] string ItemText
71 )
72 raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
73
86 void insertItemImage(
87 [in] long Position,
88 [in] string ItemImageURL
89 )
90 raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
91
101 void removeItem(
102 [in] long Position
103 )
104 raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
105
108 void removeAllItems();
109
122 void setItemText(
123 [in] long Position,
124 [in] string ItemText
125 )
126 raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
127
140 void setItemImage(
141 [in] long Position,
142 [in] string ItemImageURL
143 )
144 raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
145
161 void setItemTextAndImage(
162 [in] long Position,
163 [in] string ItemText,
164 [in] string ItemImageURL
165 )
166 raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
167
185 void setItemData(
186 [in] long Position,
187 [in] any ItemData
188 )
189 raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
190
200 string getItemText(
201 [in] long Position
202 )
203 raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
204
214 string getItemImage(
215 [in] long Position
216 )
217 raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
218
228 ::com::sun::star::beans::Pair< string, string >
229 getItemTextAndImage(
230 [in] long Position
231 )
232 raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
233
244 any getItemData(
245 [in] long Position
246 )
247 raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
248
251 sequence< ::com::sun::star::beans::Pair< string, string > >
252 getAllItems();
253
256 void addItemListListener( [in] XItemListListener Listener );
257
260 void removeItemListListener( [in] XItemListListener Listener );
261};
262
263
264}; }; }; };
265
266
267/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
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::awt::XItemListListener
describes a listener for changes in an item list
Definition: XItemListListener.idl:28
com::sun::star::awt::XItemList
provides convenient access to the list of items in a list box
Definition: XItemList.idl:29
com::sun::star::awt::XItemList::removeItemListListener
void removeItemListListener([in] XItemListListener Listener)
revokes a listener which is notified about changes in the item list.
com::sun::star::awt::XItemList::removeAllItems
void removeAllItems()
removes all items from the list
com::sun::star::awt::XItemList::insertItemText
void insertItemText([in] long Position, [in] string ItemText)
inserts an item which has only a text, but no image
com::sun::star::awt::XItemList::getItemText
string getItemText([in] long Position)
retrieves the text of an existing item
com::sun::star::awt::XItemList::getAllItems
sequence< ::com::sun::star::beans::Pair< string, string > > getAllItems()
retrieves the texts and images of all items in the list
com::sun::star::awt::XItemList::getItemData
any getItemData([in] long Position)
retrieves the implementation dependent value associated with the given list item.
com::sun::star::awt::XItemList::getItemTextAndImage
::com::sun::star::beans::Pair< string, string > getItemTextAndImage([in] long Position)
retrieves both the text and the image URL of an existing item
com::sun::star::awt::XItemList::setItemData
void setItemData([in] long Position, [in] any ItemData)
associates an implementation dependent value with the given list item.
com::sun::star::awt::XItemList::insertItem
void insertItem([in] long Position, [in] string ItemText, [in] string ItemImageURL)
inserts a new item into the list
com::sun::star::awt::XItemList::setItemText
void setItemText([in] long Position, [in] string ItemText)
sets a new text for an existing item
com::sun::star::awt::XItemList::insertItemImage
void insertItemImage([in] long Position, [in] string ItemImageURL)
inserts an item which has only an image, but no text
com::sun::star::awt::XItemList::ItemCount
long ItemCount
is the number of items in the list
Definition: XItemList.idl:32
com::sun::star::awt::XItemList::removeItem
void removeItem([in] long Position)
removes an item from the list
com::sun::star::awt::XItemList::setItemImage
void setItemImage([in] long Position, [in] string ItemImageURL)
sets a new image for an existing item
com::sun::star::awt::XItemList::getItemImage
string getItemImage([in] long Position)
retrieves the URL of the image of an existing item
com::sun::star::awt::XItemList::addItemListListener
void addItemListListener([in] XItemListListener Listener)
registers a listener which is notified about changes in the item list.
com::sun::star::awt::XItemList::setItemTextAndImage
void setItemTextAndImage([in] long Position, [in] string ItemText, [in] string ItemImageURL)
sets both a new position and text for an existing item
com
Definition: Ambiguous.idl:20