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