offapi/com/sun/star/mozilla/XMenuProxy.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28
  29 #ifndef __com_sun_star_mozilla_XMenuProxy_idl__
  30 #define __com_sun_star_mozilla_XMenuProxy_idl__
  31
  32 #ifndef __com_sun_star_lang_XComponent_idl__
  33 #include <com/sun/star/lang/XComponent.idl>
  34 #endif
  35
  36 #ifndef __com_sun_star_mozilla_XMenuProxyListener_idl__
  37 #include <com/sun/star/mozilla/XMenuProxyListener.idl>
  38 #endif
  39
  40 //=============================================================================
  41
  42  module com {  module sun {  module star {  module mozilla {
  43
  44 //=============================================================================
  45
  46
  47 // DocMerge from xml: interface com::sun::star::mozilla::XMenuProxy
  48 /** Allows to execute dispatch for a menu item
  49     and handles listeners for changes in menu items.
  50  */
  51 published interface XMenuProxy: com::sun::star::lang::XComponent
  52 {
  53     //-------------------------------------------------------------------------
  54
  55     // DocMerge from xml: method com::sun::star::mozilla::XMenuProxy::executeMenuItem
  56     /** Executes dispatch for the given menu id
  57
  58         @param ID   [in]:   the menu item
  59
  60      */
  61     void executeMenuItem([in] short ID);
  62
  63     //-------------------------------------------------------------------------
  64
  65     // DocMerge from xml: method com::sun::star::mozilla::XMenuProxy::addMenuProxyListener
  66     /** Registers an event listener, which will be called when the menu changes
  67
  68         @param xListener    [in]:   the listener to be set
  69
  70      */
  71     [oneway] void addMenuProxyListener([in] XMenuProxyListener xListener );
  72
  73     //-------------------------------------------------------------------------
  74
  75     // DocMerge from xml: method com::sun::star::mozilla::XMenuProxy::removeMenuProxyListener
  76     /** Unregisters an event listener which was registered with
  77         <member>XMenuProxy::addMenuProxyListener()</member>.
  78
  79         @param xListener    [in]:   the listener to be removed
  80
  81      */
  82     [oneway] void removeMenuProxyListener([in] XMenuProxyListener xListener );
  83 };
  84
  85 //=============================================================================
  86
  87 }; }; }; };
  88
  89
  90
  91 #endif