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_UICommandDescription_idl__
25#define __com_sun_star_ui_UICommandDescription_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 user interface commands of modules.
38
39    <p>
40    OpenOffice.org has an amount of commands that can be used by user interface
41    elements. This service provides access to the user interface commands that
42    are part of OpenOffice.org modules, like Writer or Calc.
43    </p>
44
45    @since OOo 2.0
46*/
47
48service UICommandDescription
49{
50    /** provides access to user interface commands of the installed modules.
51
52        <p>
53        To access the user interface command description of a module, a unique module specifier
54        must be provided to <member scope="com::sun::star::container">XNameAccess::getByName()</member> function.
55        The module specifier can be retrieved from the <type scope="com::sun::star::frame">ModuleManager</type>
56        service. The interface provides references to <type scope="com::sun:star::ui">ModuleUICommandDescription</type>.
57        </p>
58
59        @see com::sun::star::frame::ModuleManager
60    */
61
62    interface com::sun::star::container::XNameAccess;
63};
64
65}; }; }; };
66
67#endif
68