xref: /aoo41x/main/offapi/com/sun/star/frame/XMenuBarMergingAcceptor.idl (revision c4dc0a1a)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_frame_XMenuBarMergingAcceptor_idl__
#define __com_sun_star_frame_XMenuBarMergingAcceptor_idl__

#ifndef __com_sun_star_container_XIndexAccess_idl__
#include <com/sun/star/container/XIndexAccess.idl>
#endif

#ifndef __com_sun_star_frame_XDispatchProvider_idl__
#include <com/sun/star/frame/XDispatchProvider.idl>
#endif

//=============================================================================

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

//=============================================================================

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

    @since OpenOffice 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 <type scope="com::sun::star::frame">XLayoutManager</type>
        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