summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/frame/XMenuBarMergingAcceptor.idl
blob: 7079ba58ff04a20198e8cf0c5aa007a426b210c2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef __com_sun_star_frame_XMenuBarMergingAcceptor_idl__
#define __com_sun_star_frame_XMenuBarMergingAcceptor_idl__

#include <com/sun/star/container/XIndexAccess.idl>
#include <com/sun/star/frame/XDispatchProvider.idl>


module com { module sun { module star { module frame {


/** provides functions to set and remove a merged menu bar for inplace
    editing.

    @since OOo 2.0
*/

interface XMenuBarMergingAcceptor : com::sun::star::uno::XInterface
{
    /** allows to set a merged menu bar.

        @param xMergedMenuBar
            specifies the merged menu bar.

        <p>
        This function is normally used to provide inplace editing where
        functions from two application parts, container application and
        embedded object, are available to the user simultaneously. A menu
        bar which is set by this method has a higher priority than others
        created by com::sun::star::frame::XLayoutManager
        interface. Settings of a merged menu bar cannot be retrieved.
        </p>

        @see com::sun::star::ui::UIElementSettings
        @see com::sun::star::frame::XDispatchProvider
        @see com::sun::star::frame::XLayoutManager
    */
    boolean setMergedMenuBar(
        [in] ::com::sun::star::container::XIndexAccess xMergedMenuBar );

    /** removes a previously set merged menu bar and sets a previously created
        menu bar back.
    */
    void    removeMergedMenuBar();
};

}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */