xref: /AOO41X/main/offapi/com/sun/star/ui/UICategoryDescription.idl (revision f431c8060e57f5f39cf4ff58c984501d9a857b36)
1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_ui_UICategoryDescription_idl__
24cdf0e10cSrcweir#define __com_sun_star_ui_UICategoryDescription_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_container_XNameAccess_idl__
27cdf0e10cSrcweir#include <com/sun/star/container/XNameAccess.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweirmodule com {  module sun {  module star {  module ui {
31cdf0e10cSrcweir
32cdf0e10cSrcweir//=============================================================================
33cdf0e10cSrcweir
34cdf0e10cSrcweir/** a service which provides information about user interface command
35cdf0e10cSrcweir    categories.
36cdf0e10cSrcweir
37cdf0e10cSrcweir    <p>
38cdf0e10cSrcweir    OpenOffice.org has an amount of commands that can be used by user
39cdf0e10cSrcweir    interface elements. Every command is member of a single category.
40cdf0e10cSrcweir    Categories makes it easier to handle to huge amount of commands
41cdf0e10cSrcweir    provided by OpenOffice.org. This service is normally used by UI
42cdf0e10cSrcweir    implementations which provides all commands to a user.
43cdf0e10cSrcweir    </p>
44cdf0e10cSrcweir
45*f431c806SJürgen Schmidt    @since OpenOffice 2.0
46cdf0e10cSrcweir*/
47cdf0e10cSrcweir
48cdf0e10cSrcweir//=============================================================================
49cdf0e10cSrcweir
50cdf0e10cSrcweirservice UICategoryDescription
51cdf0e10cSrcweir{
52cdf0e10cSrcweir    /** provides access to user interface command categories of the installed
53cdf0e10cSrcweir        modules.
54cdf0e10cSrcweir
55cdf0e10cSrcweir        <p>
56cdf0e10cSrcweir        To access the user interface command categories of a module, a unique
57cdf0e10cSrcweir        module specifier must be provided to
58cdf0e10cSrcweir        <member scope="com::sun::star::container">XNameAccess::getByName()</member>
59cdf0e10cSrcweir        function. The module specifier can be retrieved from the
60cdf0e10cSrcweir        <type scope="com::sun::star::frame">ModuleManager</type>
61cdf0e10cSrcweir        service. The interface provides references to
62cdf0e10cSrcweir        <type scope="com::sun:star::ui">ModuleUICommandDescription</type>.
63cdf0e10cSrcweir        </p>
64cdf0e10cSrcweir
65cdf0e10cSrcweir        @see com::sun::star::frame::ModuleManager
66cdf0e10cSrcweir    */
67cdf0e10cSrcweir
68cdf0e10cSrcweir    interface com::sun::star::container::XNameAccess;
69cdf0e10cSrcweir};
70cdf0e10cSrcweir
71cdf0e10cSrcweir}; }; }; }; // com.sun.star.ui
72cdf0e10cSrcweir
73cdf0e10cSrcweir#endif
74