offapi/com/sun/star/ui/UICommandDescription.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: UICommandDescription.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
  31 #ifndef __com_sun_star_ui_UICommandDescription_idl__
  32 #define __com_sun_star_ui_UICommandDescription_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 user interface commands of modules.
  45
  46     <p>
  47     OpenOffice.org has an amount of commands that can be used by user interface
  48     elements. This service provides access to the user interface commands that
  49     are part of OpenOffice.org modules, like Writer or Calc.
  50     </p>
  51
  52     @since OOo 2.0.0
  53 */
  54
  55 service UICommandDescription
  56 {
  57     /** provides access to user interface commands of the installed modules.
  58
  59         <p>
  60         To access the user interface command description of a module, a unique module specifier
  61         must be provided to <member scope="com::sun::star::container">XNameAccess::getByName()</member> function.
  62         The module specifier can be retrieved from the <type scope="com::sun::star::frame">ModuleManager</type>
  63         service. The interface provides references to <type scope="com::sun:star::ui">ModuleUICommandDescription</type>.
  64         </p>
  65
  66         @see com::sun::star::frame::ModuleManager
  67     */
  68
  69     interface com::sun::star::container::XNameAccess;
  70 };
  71
  72 }; }; }; };
  73
  74 #endif