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