offapi/com/sun/star/frame/XMenuBarMergingAcceptor.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 #ifndef __com_sun_star_frame_XMenuBarMergingAcceptor_idl__
  21 #define __com_sun_star_frame_XMenuBarMergingAcceptor_idl__
  22
  23 #include <com/sun/star/container/XIndexAccess.idl>
  24 #include <com/sun/star/frame/XDispatchProvider.idl>
  25
  26
  27 module com { module sun { module star { module frame {
  28
  29
  30 /** provides functions to set and remove a merged menu bar for inplace
  31     editing.
  32
  33     @since OOo 2.0
  34 */
  35
  36 interface XMenuBarMergingAcceptor : com::sun::star::uno::XInterface
  37 {
  38     /** allows to set a merged menu bar.
  39
  40         @param xMergedMenuBar
  41             specifies the merged menu bar.
  42
  43         <p>
  44         This function is normally used to provide inplace editing where
  45         functions from two application parts, container application and
  46         embedded object, are available to the user simultaneously. A menu
  47         bar which is set by this method has a higher priority than others
  48         created by com::sun::star::frame::XLayoutManager
  49         interface. Settings of a merged menu bar cannot be retrieved.
  50         </p>
  51
  52         @see com::sun::star::ui::UIElementSettings
  53         @see com::sun::star::frame::XDispatchProvider
  54         @see com::sun::star::frame::XLayoutManager
  55     */
  56     boolean setMergedMenuBar(
  57         [in] ::com::sun::star::container::XIndexAccess xMergedMenuBar );
  58
  59     /** removes a previously set merged menu bar and sets a previously created
  60         menu bar back.
  61     */
  62     void    removeMergedMenuBar();
  63 };
  64
  65 }; }; }; };
  66
  67 #endif
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */