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