AOO410/main/offapi/com/sun/star/form/binding/XListEntryListener.idl

/**************************************************************
 * 
 * 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 __com_sun_star_form_binding_XListEntryListener_idl__
#define __com_sun_star_form_binding_XListEntryListener_idl__

#ifndef __com_sun_star_lang_XEventListener_idl__
#include <com/sun/star/lang/XEventListener.idl>
#endif
#ifndef __com_sun_star_form_binding_ListEntryEvent_idl__
#include <com/sun/star/form/binding/ListEntryEvent.idl>
#endif

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

module com {  module sun {  module star {  module form { module binding {

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

/** specifies a listener for changes in a string entry list
*/
interface XListEntryListener : com::sun::star::lang::XEventListener
{
    /** notifies the listener that a single entry in the list has change

        @param Source
            is the event describing the change. The <member>ListEntryEvent::Position</member>
            member denotes the position of the changed entry, the first (and only) element
            of the <member>ListEntryEvent::Entries</member> member denotes the new string
    */
    void    entryChanged( [in] ListEntryEvent Source );

    /** notifies the listener that a range of entries has been inserted into the list

        @param Source
            is the event describing the change. The <member>ListEntryEvent::Position</member>
            member denotes the position of the first inserted entry, the
            <member>ListEntryEvent::Entries</member> member contains the strings which have
            been inserted.
    */
    void    entryRangeInserted( [in] ListEntryEvent Source );

    /** notifies the listener that a range of entries has been removed from the list

        @param Source
            is the event describing the change. The <member>ListEntryEvent::Position</member>
            member denotes the position of the first removed entry, the
            <member>ListEntryEvent::Count</member> member the number of removed entries.
    */
    void    entryRangeRemoved( [in] ListEntryEvent Source );

    /** notifies the listener that all entries of the list have changed.

        <p>The listener should retrieve the complete new list by calling the
        <member>XListEntrySource::getAllListEntries</member> method of the event source
        (which is denoted by <member scope="com::sun::star::lang">EventObject::Source</member>).
    */
    void    allEntriesChanged( [in] com::sun::star::lang::EventObject Source );
};

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

}; }; }; }; };

#endif