1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_frame_XMenuBarMergingAcceptor_idl__
29#define __com_sun_star_frame_XMenuBarMergingAcceptor_idl__
30
31#ifndef __com_sun_star_container_XIndexAccess_idl__
32#include <com/sun/star/container/XIndexAccess.idl>
33#endif
34
35#ifndef __com_sun_star_frame_XDispatchProvider_idl__
36#include <com/sun/star/frame/XDispatchProvider.idl>
37#endif
38
39//=============================================================================
40
41module com { module sun { module star { module frame {
42
43//=============================================================================
44
45/** provides functions to set and remove a merged menu bar for inplace
46    editing.
47
48    @since OOo 2.0
49*/
50
51interface XMenuBarMergingAcceptor : com::sun::star::uno::XInterface
52{
53    /** allows to set a merged menu bar.
54
55        @param xMergedMenuBar
56            specifies the merged menu bar.
57
58        <p>
59        This function is normally used to provide inplace editing where
60        functions from two application parts, container application and
61        embedded object, are available to the user simultaneously. A menu
62        bar which is set by this method has a higher priority than others
63        created by <type scope="com::sun::star::frame">XLayoutManager</type>
64        interface. Settings of a merged menu bar cannot be retrieved.
65        </p>
66
67        @see com::sun::star::ui::UIElementSettings
68        @see com::sun::star::frame::XDispatchProvider
69        @see com::sun::star::frame::XLayoutManager
70    */
71    boolean setMergedMenuBar(
72        [in] ::com::sun::star::container::XIndexAccess xMergedMenuBar );
73
74    /** removes a previously set merged menu bar and sets a previously created
75        menu bar back.
76    */
77    void    removeMergedMenuBar();
78};
79
80}; }; }; };
81
82#endif
83