summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/frame/XDispatchInformationProvider.idl
blob: a40b5e923c4a88e93f9d6ac91137edc677c65b29 (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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 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 OOo 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