1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __offapi_com_sun_star_awt_ListItemEvent_idl__
25#define __offapi_com_sun_star_awt_ListItemEvent_idl__
26
27#include <com/sun/star/lang/EventObject.idl>
28#include <com/sun/star/beans/Optional.idl>
29
30//==================================================================================================================
31
32module com { module sun { module star { module awt {
33
34//==================================================================================================================
35
36/** is the event broadcasted by a <type>XListItems</type> implementation for changes
37    in its item list.
38 */
39published struct ItemListEvent : ::com::sun::star::lang::EventObject
40{
41    /** specifies the position of the item which is affected by the event
42
43        <p>In case the event is not related to a single item, but to the complete list, the value of this
44        member is undefined.</p>
45    */
46    long    ItemPosition;
47
48    /** the text of the item.
49
50        <p>If the event being notified did not touch the text of an item, this member is empty. For instance, upon
51        invocation of <member>XItemList::setItemImage</member>, only <code>ItemImageURL</code> will be set, and
52        <code>ItemText</code> will be empty.</p>
53    */
54    ::com::sun::star::beans::Optional< string >
55            ItemText;
56
57    /** the URL of the image of the item
58
59        <p>If the event being notified did not touch the image of an item, this member is empty. For instance, upon
60        invocation of <member>XItemList::setItemText</member>, only <code>ItemText</code> will be set, and
61        <code>ItemImageURL</code> will be empty.</p>
62    */
63    ::com::sun::star::beans::Optional< string >
64            ItemImageURL;
65};
66
67//==================================================================================================================
68
69}; }; }; };
70
71//==================================================================================================================
72
73#endif
74