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

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