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#ifndef __com_sun_star_frame_XDispatchInformationProvider_idl__
24#define __com_sun_star_frame_XDispatchInformationProvider_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_frame_DispatchInformation_idl__
31#include <com/sun/star/frame/DispatchInformation.idl>
32#endif
33
34#ifndef __com_sun_star_container_NoSuchElementException_idl__
35#include <com/sun/star/container/NoSuchElementException.idl>
36#endif
37
38//=============================================================================
39
40module com {  module sun {  module star {  module frame {
41
42//=============================================================================
43/** provides information about supported commands
44
45    <p>
46    This interface can be used to retrieve additional information about
47    supported commands. This interface is normally used by configuration
48    implementations to retrieve all supported commands.
49    A dispatch information provider is normally supported by a
50    <type>Frame</type> service.
51    </p>
52
53    @see Frame
54
55    @since OpenOffice 2.0
56 */
57published interface XDispatchInformationProvider: com::sun::star::uno::XInterface
58{
59    //-------------------------------------------------------------------------
60    /** returns all supported command groups.
61
62        @returns
63            a sequence of supported command groups.
64
65        @see CommandGroup
66	*/
67    sequence < short > getSupportedCommandGroups();
68
69    //-------------------------------------------------------------------------
70    /** returns additional information about supported commands of a
71        given command group.
72
73        @param CommandGroup
74            specifies a command group.
75
76        @returns
77            name and group name of every command supported. A group ID which is
78            not supported returns an empty <type scope="com::sun::star::uno">Sequence</type>.
79	*/
80    sequence < DispatchInformation > getConfigurableDispatchInformation( [in] short CommandGroup );
81};
82
83//=============================================================================
84
85}; }; }; };
86
87#endif
88