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
28#ifndef __com_sun_star_ui_ModuleUICommandDescription_idl__
29#define __com_sun_star_ui_ModuleUICommandDescription_idl__
30
31#ifndef __com_sun_star_container_XNameAccess_idl__
32#include <com/sun/star/container/XNameAccess.idl>
33#endif
34
35//=============================================================================
36
37module com { module sun { module star { module ui {
38
39//=============================================================================
40
41/** a service which provides information about the user interface commands of
42    a single module.
43
44    <p>
45    Every OpenOffice.org module has an amount of commands that can be used by
46    user interface elements. This service provides access to the user interface commands
47    that are part of a single OpenOffice.org module, like Writer or Calc.
48    </p>
49
50    @since OOo 2.0
51*/
52
53service ModuleUICommandDescription
54{
55    /** provides access to user interface commands of an installed module.
56
57        <p>
58        An implementation must provide a <type scope="com::sun::star::uno">Sequence</type> which
59        has <type scope="com::sun::star::beans">PropertyValue</type> as entries. The following
60        entries a defined:
61        <ul>
62            <li><b>Label</b><br>a string which specifies the short name of the user interface command with
63            mnemonic and optional subsequent ... if the command needs additional user input. This string
64            can directly be used to set the text of a menu item.</li>
65            <li><b>Name</b><br>a string which specifies the short name of the user interface command without
66            any additional information. It can be used for the bubble help.</li>
67            <li><b>Popup</b><br>a boolean which specifies if the user interface command is a unique
68            identifer for a popup menu. A popup menu has a label, but is not bound to a command.</li>
69        </ul>
70        The key to a user interface command description is the user interface command itself which has
71        the following syntax ".uno:$Command". For example ".uno:Open" shows the file open dialog.
72        A complete list of user interface commands can be found inside the latest OpenOffice Developers Guide
73        or online at http://framework.openoffice.org.
74        </p>
75
76        @see com::sun::star::frame::ModuleManager
77    */
78
79    interface com::sun::star::container::XNameAccess;
80};
81
82}; }; }; };
83
84#endif
85