xref: /AOO41X/main/offapi/com/sun/star/ui/UICategoryDescription.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_ui_UICategoryDescription_idl__
28#define __com_sun_star_ui_UICategoryDescription_idl__
29
30#ifndef __com_sun_star_container_XNameAccess_idl__
31#include <com/sun/star/container/XNameAccess.idl>
32#endif
33
34module com {  module sun {  module star {  module ui {
35
36//=============================================================================
37
38/** a service which provides information about user interface command
39    categories.
40
41    <p>
42    OpenOffice.org has an amount of commands that can be used by user
43    interface elements. Every command is member of a single category.
44    Categories makes it easier to handle to huge amount of commands
45    provided by OpenOffice.org. This service is normally used by UI
46    implementations which provides all commands to a user.
47    </p>
48
49    @since OOo 2.0
50*/
51
52//=============================================================================
53
54service UICategoryDescription
55{
56    /** provides access to user interface command categories of the installed
57        modules.
58
59        <p>
60        To access the user interface command categories of a module, a unique
61        module specifier must be provided to
62        <member scope="com::sun::star::container">XNameAccess::getByName()</member>
63        function. The module specifier can be retrieved from the
64        <type scope="com::sun::star::frame">ModuleManager</type>
65        service. The interface provides references to
66        <type scope="com::sun:star::ui">ModuleUICommandDescription</type>.
67        </p>
68
69        @see com::sun::star::frame::ModuleManager
70    */
71
72    interface com::sun::star::container::XNameAccess;
73};
74
75}; }; }; }; // com.sun.star.ui
76
77#endif
78