1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_frame_XMenuBarMergingAcceptor_idl__
25#define __com_sun_star_frame_XMenuBarMergingAcceptor_idl__
26
27#ifndef __com_sun_star_container_XIndexAccess_idl__
28#include <com/sun/star/container/XIndexAccess.idl>
29#endif
30
31#ifndef __com_sun_star_frame_XDispatchProvider_idl__
32#include <com/sun/star/frame/XDispatchProvider.idl>
33#endif
34
35//=============================================================================
36
37module com { module sun { module star { module frame {
38
39//=============================================================================
40
41/** provides functions to set and remove a merged menu bar for inplace
42    editing.
43
44    @since OOo 2.0
45*/
46
47interface XMenuBarMergingAcceptor : com::sun::star::uno::XInterface
48{
49    /** allows to set a merged menu bar.
50
51        @param xMergedMenuBar
52            specifies the merged menu bar.
53
54        <p>
55        This function is normally used to provide inplace editing where
56        functions from two application parts, container application and
57        embedded object, are available to the user simultaneously. A menu
58        bar which is set by this method has a higher priority than others
59        created by <type scope="com::sun::star::frame">XLayoutManager</type>
60        interface. Settings of a merged menu bar cannot be retrieved.
61        </p>
62
63        @see com::sun::star::ui::UIElementSettings
64        @see com::sun::star::frame::XDispatchProvider
65        @see com::sun::star::frame::XLayoutManager
66    */
67    boolean setMergedMenuBar(
68        [in] ::com::sun::star::container::XIndexAccess xMergedMenuBar );
69
70    /** removes a previously set merged menu bar and sets a previously created
71        menu bar back.
72    */
73    void    removeMergedMenuBar();
74};
75
76}; }; }; };
77
78#endif
79