xref: /AOO42X/main/offapi/com/sun/star/ui/XContextMenuInterceptor.idl (revision d0db74eec9c1bc4522fc3fd441059b5db589c492)

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

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

#ifndef __com_sun_star_ui_ContextMenuInterceptorAction_idl__
#include <com/sun/star/ui/ContextMenuInterceptorAction.idl>
#endif
#ifndef __com_sun_star_ui_ContextMenuExecuteEvent_idl__
#include <com/sun/star/ui/ContextMenuExecuteEvent.idl>
#endif

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

/** This interface enables the object to be registered as interceptor to
 change context menus or prevent them from being executed.
 */
published interface XContextMenuInterceptor : ::com::sun::star::uno::XInterface
{
    /** notifies the interceptor about the request to execute a ContextMenu.
     The interceptor has to decide whether the menu should be executed with or without
     being modified or may ignore the call.
    */
    ContextMenuInterceptorAction notifyContextMenuExecute([in]ContextMenuExecuteEvent aEvent);
};

}; }; }; };

#endif