xref: /aoo41x/main/offapi/com/sun/star/awt/ItemListEvent.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __offapi_com_sun_star_awt_ListItemEvent_idl__
#define __offapi_com_sun_star_awt_ListItemEvent_idl__

#include <com/sun/star/lang/EventObject.idl>
#include <com/sun/star/beans/Optional.idl>

//==================================================================================================================

module com { module sun { module star { module awt {

//==================================================================================================================

/** is the event broadcasted by a <type>XListItems</type> implementation for changes
    in its item list.
 */
published struct ItemListEvent : ::com::sun::star::lang::EventObject
{
    /** specifies the position of the item which is affected by the event

        <p>In case the event is not related to a single item, but to the complete list, the value of this
        member is undefined.</p>
    */
    long    ItemPosition;

    /** the text of the item.

        <p>If the event being notified did not touch the text of an item, this member is empty. For instance, upon
        invocation of <member>XItemList::setItemImage</member>, only <code>ItemImageURL</code> will be set, and
        <code>ItemText</code> will be empty.</p>
    */
    ::com::sun::star::beans::Optional< string >
            ItemText;

    /** the URL of the image of the item

        <p>If the event being notified did not touch the image of an item, this member is empty. For instance, upon
        invocation of <member>XItemList::setItemText</member>, only <code>ItemText</code> will be set, and
        <code>ItemImageURL</code> will be empty.</p>
    */
    ::com::sun::star::beans::Optional< string >
            ItemImageURL;
};

//==================================================================================================================

}; }; }; };

//==================================================================================================================

#endif