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

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