xref: /aoo42x/main/offapi/com/sun/star/frame/XDispatchInformationProvider.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_XDispatchInformationProvider_idl__
#define __com_sun_star_frame_XDispatchInformationProvider_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_frame_DispatchInformation_idl__
#include <com/sun/star/frame/DispatchInformation.idl>
#endif

#ifndef __com_sun_star_container_NoSuchElementException_idl__
#include <com/sun/star/container/NoSuchElementException.idl>
#endif

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

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

//=============================================================================
/** provides information about supported commands

    <p>
    This interface can be used to retrieve additional information about
    supported commands. This interface is normally used by configuration
    implementations to retrieve all supported commands.
    A dispatch information provider is normally supported by a
    <type>Frame</type> service.
    </p>

    @see Frame

    @since OpenOffice 2.0
 */
published interface XDispatchInformationProvider: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** returns all supported command groups.

        @returns
            a sequence of supported command groups.

        @see CommandGroup
	*/
    sequence < short > getSupportedCommandGroups();

    //-------------------------------------------------------------------------
    /** returns additional information about supported commands of a
        given command group.

        @param CommandGroup
            specifies a command group.

        @returns
            name and group name of every command supported. A group ID which is
            not supported returns an empty <type scope="com::sun::star::uno">Sequence</type>.
	*/
    sequence < DispatchInformation > getConfigurableDispatchInformation( [in] short CommandGroup );
};

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

}; }; }; };

#endif