LibreOffice
LibreOffice 7.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 #ifndef __com_sun_star_awt_XItemList_idl__
21 #define __com_sun_star_awt_XItemList_idl__
22 
25 
26 
27 module com { module sun { module star { module awt {
28 
29 interface XItemListListener;
30 
31 
34 interface XItemList
35 {
38  [attribute, readonly] long ItemCount;
39 
55  void insertItem(
56  [in] long Position,
57  [in] string ItemText,
58  [in] string ItemImageURL
59  )
61 
75  [in] long Position,
76  [in] string ItemText
77  )
79 
93  [in] long Position,
94  [in] string ItemImageURL
95  )
97 
108  [in] long Position
109  )
111 
115 
129  [in] long Position,
130  [in] string ItemText
131  )
133 
147  [in] long Position,
148  [in] string ItemImageURL
149  )
151 
168  [in] long Position,
169  [in] string ItemText,
170  [in] string ItemImageURL
171  )
173 
192  [in] long Position,
193  [in] any ItemData
194  )
196 
206  string getItemText(
207  [in] long Position
208  )
210 
220  string getItemImage(
221  [in] long Position
222  )
224 
234  ::com::sun::star::beans::Pair< string, string >
236  [in] long Position
237  )
239 
251  [in] long Position
252  )
254 
257  sequence< ::com::sun::star::beans::Pair< string, string > >
259 
262  void addItemListListener( [in] XItemListListener Listener );
263 
267 };
268 
269 
270 }; }; }; };
271 
272 
273 #endif
274 
275 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
This exception is thrown to indicate that a container has been accessed with an illegal index.
Definition: IndexOutOfBoundsException.idl:35
describes a listener for changes in an item list
Definition: XItemListListener.idl:34
provides convenient access to the list of items in a list box
Definition: XItemList.idl:35
void removeItemListListener([in] XItemListListener Listener)
revokes a listener which is notified about changes in the item list.
void removeAllItems()
removes all items from the list
void insertItemText([in] long Position, [in] string ItemText)
inserts an item which has only a text, but no image
string getItemText([in] long Position)
retrieves the text of an existing item
sequence< ::com::sun::star::beans::Pair< string, string > > getAllItems()
retrieves the texts and images of all items in the list
any getItemData([in] long Position)
retrieves the implementation dependent value associated with the given list item.
::com::sun::star::beans::Pair< string, string > getItemTextAndImage([in] long Position)
retrieves both the text and the image URL of an existing item
void setItemData([in] long Position, [in] any ItemData)
associates an implementation dependent value with the given list item.
void insertItem([in] long Position, [in] string ItemText, [in] string ItemImageURL)
inserts a new item into the list
void setItemText([in] long Position, [in] string ItemText)
sets a new text for an existing item
void insertItemImage([in] long Position, [in] string ItemImageURL)
inserts an item which has only an image, but no text
long ItemCount
is the number of items in the list
Definition: XItemList.idl:38
void removeItem([in] long Position)
removes an item from the list
void setItemImage([in] long Position, [in] string ItemImageURL)
sets a new image for an existing item
string getItemImage([in] long Position)
retrieves the URL of the image of an existing item
void addItemListListener([in] XItemListListener Listener)
registers a listener which is notified about changes in the item list.
void setItemTextAndImage([in] long Position, [in] string ItemText, [in] string ItemImageURL)
sets both a new position and text for an existing item
Definition: Ambiguous.idl:22