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