xref: /trunk/main/offapi/com/sun/star/ui/XUIFunctionListener.idl (revision f431c806)

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

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

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

 module com {  module sun {  module star {  module ui {

//=============================================================================
/** special interface to receive notification that a user interface
    element will execute a function.

    @since OpenOffice 2.0
 */
interface XUIFunctionListener : com::sun::star::lang::XEventListener
{
    //=============================================================================
    /** gets called to notify a component that a user interface element
        wants to execute a function.

        @param aUIElementName
            a string which identifies the user interface element that wants
            to execute a function.

        @param aCommand
            a string which identifies the function that has been selected by
            a user.
    */
    void functionExecute( [in] string aUIElementName, [in] string aCommand );

};

}; }; }; };

#endif