AOO410/main/offapi/com/sun/star/awt/XTabListener.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_awt_XTabListener_idl__
#define __com_sun_star_awt_XTabListener_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_lang_XEventListener_idl__
#include <com/sun/star/lang/XEventListener.idl>
#endif

#ifndef __com_sun_star_beans_NamedValue_idl__
#include <com/sun/star/beans/NamedValue.idl>
#endif

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

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

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

/** such listener will be informed if tab's was inserted/removed from
    an XSimpleTabController instance or if the properties of a tab was changed.
 */
published interface XTabListener : com::sun::star::lang::XEventListener
{
    //-------------------------------------------------------------------------
    /** a new tab was inserted.

        @param  ID
                this is the unique ID of this new tab.
     */
    void inserted( [in] long ID );

    //-------------------------------------------------------------------------
    /** a tab was removed.

        @param  ID
                this was the unique ID of this tab.
     */
    void removed( [in] long ID );

    //-------------------------------------------------------------------------
    /** a tab was changed within it's properties.

        @param  ID
                the unique ID of the changed tab.

        @param  Properties
                the current set of properties for this tab.
     */
    void changed( [in] long                                          ID         ,
                  [in] sequence< com::sun::star::beans::NamedValue > Properties );

    //-------------------------------------------------------------------------
    /** a tab was activated (e.g. by using mouse/keyboard or
        method XSimpleTabController::activateTab()
     */
    void activated( [in] long ID );

    //-------------------------------------------------------------------------
    /** a tab was deactivated, because another tab becames the new active state.
     */
    void deactivated( [in] long ID );
};

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

}; }; }; };

#endif