offapi/com/sun/star/frame/XMenuBarMergingAcceptor.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: XMenuBarMergingAcceptor.idl,v $
  10  * $Revision: 1.5 $
  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 #ifndef __com_sun_star_frame_XMenuBarMergingAcceptor_idl__
  32 #define __com_sun_star_frame_XMenuBarMergingAcceptor_idl__
  33
  34 #ifndef __com_sun_star_container_XIndexAccess_idl__
  35 #include <com/sun/star/container/XIndexAccess.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_frame_XDispatchProvider_idl__
  39 #include <com/sun/star/frame/XDispatchProvider.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com { module sun { module star { module frame {
  45
  46 //=============================================================================
  47
  48 /** provides functions to set and remove a merged menu bar for inplace
  49     editing.
  50
  51     @since OOo 2.0.0
  52 */
  53
  54 interface XMenuBarMergingAcceptor : com::sun::star::uno::XInterface
  55 {
  56     /** allows to set a merged menu bar.
  57
  58         @param xMergedMenuBar
  59             specifies the merged menu bar.
  60
  61         <p>
  62         This function is normally used to provide inplace editing where
  63         functions from two application parts, container application and
  64         embedded object, are available to the user simultaneously. A menu
  65         bar which is set by this method has a higher priority than others
  66         created by <type scope="com::sun::star::frame">XLayoutManager</type>
  67         interface. Settings of a merged menu bar cannot be retrieved.
  68         </p>
  69
  70         @see com::sun::star::ui::UIElementSettings
  71         @see com::sun::star::frame::XDispatchProvider
  72         @see com::sun::star::frame::XLayoutManager
  73     */
  74     boolean setMergedMenuBar(
  75         [in] ::com::sun::star::container::XIndexAccess xMergedMenuBar );
  76
  77     /** removes a previously set merged menu bar and sets a previously created
  78         menu bar back.
  79     */
  80     void    removeMergedMenuBar();
  81 };
  82
  83 }; }; }; };
  84
  85 #endif