offapi/com/sun/star/mozilla/XMenuProxy.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: XMenuProxy.idl,v $
  10  * $Revision: 1.9 $
  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
  31
  32 #ifndef __com_sun_star_mozilla_XMenuProxy_idl__
  33 #define __com_sun_star_mozilla_XMenuProxy_idl__
  34
  35 #ifndef __com_sun_star_lang_XComponent_idl__
  36 #include <com/sun/star/lang/XComponent.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_mozilla_XMenuProxyListener_idl__
  40 #include <com/sun/star/mozilla/XMenuProxyListener.idl>
  41 #endif
  42
  43 //=============================================================================
  44
  45  module com {  module sun {  module star {  module mozilla {
  46
  47 //=============================================================================
  48
  49
  50 // DocMerge from xml: interface com::sun::star::mozilla::XMenuProxy
  51 /** Allows to execute dispatch for a menu item
  52     and handles listeners for changes in menu items.
  53  */
  54 published interface XMenuProxy: com::sun::star::lang::XComponent
  55 {
  56     //-------------------------------------------------------------------------
  57
  58     // DocMerge from xml: method com::sun::star::mozilla::XMenuProxy::executeMenuItem
  59     /** Executes dispatch for the given menu id
  60
  61         @param ID       [in]:   the menu item
  62
  63      */
  64     void executeMenuItem([in] short ID);
  65
  66     //-------------------------------------------------------------------------
  67
  68     // DocMerge from xml: method com::sun::star::mozilla::XMenuProxy::addMenuProxyListener
  69     /** Registers an event listener, which will be called when the menu changes
  70
  71         @param xListener        [in]:   the listener to be set
  72
  73      */
  74     [oneway] void addMenuProxyListener([in] XMenuProxyListener xListener );
  75
  76     //-------------------------------------------------------------------------
  77
  78     // DocMerge from xml: method com::sun::star::mozilla::XMenuProxy::removeMenuProxyListener
  79     /** Unregisters an event listener which was registered with
  80         <member>XMenuProxy::addMenuProxyListener()</member>.
  81
  82         @param xListener        [in]:   the listener to be removed
  83
  84      */
  85     [oneway] void removeMenuProxyListener([in] XMenuProxyListener xListener );
  86 };
  87
  88 //=============================================================================
  89
  90 }; }; }; };
  91
  92
  93
  94 #endif