xref: /AOO41X/main/offapi/com/sun/star/ui/ModuleUICategoryDescription.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
24cdf0e10cSrcweir#ifndef __com_sun_star_ui_ModuleUICommandDescription_idl__
25cdf0e10cSrcweir#define __com_sun_star_ui_ModuleUICommandDescription_idl__
26cdf0e10cSrcweir
27cdf0e10cSrcweir#ifndef __com_sun_star_container_XNameAccess_idl__
28cdf0e10cSrcweir#include <com/sun/star/container/XNameAccess.idl>
29cdf0e10cSrcweir#endif
30cdf0e10cSrcweir
31cdf0e10cSrcweir//=============================================================================
32cdf0e10cSrcweir
33cdf0e10cSrcweirmodule com { module sun { module star { module ui {
34cdf0e10cSrcweir
35cdf0e10cSrcweir//=============================================================================
36cdf0e10cSrcweir
37cdf0e10cSrcweir/** a service which provides information about the user interface command
38cdf0e10cSrcweir    categories of a single module.
39cdf0e10cSrcweir
40cdf0e10cSrcweir    <p>
41cdf0e10cSrcweir    Every OpenOffice.org module has an amount of commands that can be used by
42cdf0e10cSrcweir    user interface elements. This service provides access to the user interface
43cdf0e10cSrcweir    commands that are part of a single OpenOffice.org module, like Writer
44cdf0e10cSrcweir    or Calc.
45cdf0e10cSrcweir    </p>
46cdf0e10cSrcweir
47*f431c806SJürgen Schmidt    @since OpenOffice 2.0
48cdf0e10cSrcweir*/
49cdf0e10cSrcweir
50cdf0e10cSrcweirservice ModuleUICategoryDescription
51cdf0e10cSrcweir{
52cdf0e10cSrcweir    /** provides access to user interface command categories of an installed
53cdf0e10cSrcweir        module.
54cdf0e10cSrcweir
55cdf0e10cSrcweir        <p>
56cdf0e10cSrcweir        An implementation must provide a language dependent string which
57cdf0e10cSrcweir        can be used by a UI to display the category name.
58cdf0e10cSrcweir        The key to a user interface command category depends on the specific
59cdf0e10cSrcweir        implementation. OpenOffice.org uses a pre-defined number of
60cdf0e10cSrcweir        identifiers defined in <type scope="::com::sun:star::frame">
61cdf0e10cSrcweir        CommandGroup</type>.
62cdf0e10cSrcweir        </p>
63cdf0e10cSrcweir
64cdf0e10cSrcweir        @see ::com::sun::star::frame::ModuleManager
65cdf0e10cSrcweir        @see ::com::sun::star::frame::CommandGroup
66cdf0e10cSrcweir    */
67cdf0e10cSrcweir
68cdf0e10cSrcweir    interface com::sun::star::container::XNameAccess;
69cdf0e10cSrcweir};
70cdf0e10cSrcweir
71cdf0e10cSrcweir}; }; }; };
72cdf0e10cSrcweir
73cdf0e10cSrcweir#endif
74