offapi/com/sun/star/ui/XContextMenuInterceptor.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XContextMenuInterceptor.idl,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_ui_XContextMenuInterceptor_idl__
  31 #define __com_sun_star_ui_XContextMenuInterceptor_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_ui_ContextMenuInterceptorAction_idl__
  38 #include <com/sun/star/ui/ContextMenuInterceptorAction.idl>
  39 #endif
  40 #ifndef __com_sun_star_ui_ContextMenuExecuteEvent_idl__
  41 #include <com/sun/star/ui/ContextMenuExecuteEvent.idl>
  42 #endif
  43
  44 module com {  module sun {  module star {  module ui {
  45
  46 /** This interface enables the object to be registerd as interceptor to
  47  change context menues or prevent them from being executed.
  48  */
  49 published interface XContextMenuInterceptor : ::com::sun::star::uno::XInterface
  50 {
  51     /** notifies the interceptor about the request to execute a ContextMenu.
  52      The interceptor has to decide whether the menu should be executed with or without
  53      beeing modified or may ignore the call.
  54     */
  55     ContextMenuInterceptorAction notifyContextMenuExecute([in]ContextMenuExecuteEvent aEvent);
  56 };
  57
  58 }; }; }; };
  59
  60 #endif