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 command
38    categories of 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
43    commands that are part of a single OpenOffice.org module, like Writer
44    or Calc.
45    </p>
46
47    @since OpenOffice 2.0
48*/
49
50service ModuleUICategoryDescription
51{
52    /** provides access to user interface command categories of an installed
53        module.
54
55        <p>
56        An implementation must provide a language dependent string which
57        can be used by a UI to display the category name.
58        The key to a user interface command category depends on the specific
59        implementation. OpenOffice.org uses a pre-defined number of
60        identifiers defined in <type scope="::com::sun:star::frame">
61        CommandGroup</type>.
62        </p>
63
64        @see ::com::sun::star::frame::ModuleManager
65        @see ::com::sun::star::frame::CommandGroup
66    */
67
68    interface com::sun::star::container::XNameAccess;
69};
70
71}; }; }; };
72
73#endif
74