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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 #ifndef __com_sun_star_mozilla_XMenuProxy_idl__
  22 #define __com_sun_star_mozilla_XMenuProxy_idl__
  23
  24 #include <com/sun/star/lang/XComponent.idl>
  25
  26 #include <com/sun/star/mozilla/XMenuProxyListener.idl>
  27
  28
  29  module com {  module sun {  module star {  module mozilla {
  30
  31
  32 /** Allows to execute dispatch for a menu item
  33     and handles listeners for changes in menu items.
  34  */
  35 published interface XMenuProxy: com::sun::star::lang::XComponent
  36 {
  37     /** Executes dispatch for the given menu id
  38
  39         @param ID   [in]:   the menu item
  40
  41      */
  42     void executeMenuItem([in] short ID);
  43
  44     /** Registers an event listener, which will be called when the menu changes
  45
  46         @param xListener    [in]:   the listener to be set
  47
  48      */
  49     void addMenuProxyListener([in] XMenuProxyListener xListener );
  50
  51     /** Unregisters an event listener which was registered with
  52         XMenuProxy::addMenuProxyListener().
  53
  54         @param xListener    [in]:   the listener to be removed
  55
  56      */
  57     void removeMenuProxyListener([in] XMenuProxyListener xListener );
  58 };
  59
  60
  61 }; }; }; };
  62
  63
  64
  65 #endif
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */