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#ifndef __com_sun_star_ui_UICategoryDescription_idl__
24#define __com_sun_star_ui_UICategoryDescription_idl__
25
26#ifndef __com_sun_star_container_XNameAccess_idl__
27#include <com/sun/star/container/XNameAccess.idl>
28#endif
29
30module com {  module sun {  module star {  module ui {
31
32//=============================================================================
33
34/** a service which provides information about user interface command
35    categories.
36
37    <p>
38    OpenOffice.org has an amount of commands that can be used by user
39    interface elements. Every command is member of a single category.
40    Categories makes it easier to handle to huge amount of commands
41    provided by OpenOffice.org. This service is normally used by UI
42    implementations which provides all commands to a user.
43    </p>
44
45    @since OpenOffice 2.0
46*/
47
48//=============================================================================
49
50service UICategoryDescription
51{
52    /** provides access to user interface command categories of the installed
53        modules.
54
55        <p>
56        To access the user interface command categories of a module, a unique
57        module specifier must be provided to
58        <member scope="com::sun::star::container">XNameAccess::getByName()</member>
59        function. The module specifier can be retrieved from the
60        <type scope="com::sun::star::frame">ModuleManager</type>
61        service. The interface provides references to
62        <type scope="com::sun:star::ui">ModuleUICommandDescription</type>.
63        </p>
64
65        @see com::sun::star::frame::ModuleManager
66    */
67
68    interface com::sun::star::container::XNameAccess;
69};
70
71}; }; }; }; // com.sun.star.ui
72
73#endif
74