offapi/com/sun/star/ui/UICategoryDescription.idl

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