offapi/com/sun/star/ui/ModuleUICommandDescription.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: ModuleUICommandDescription.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_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 commands of
  45     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 commands
  50     that are part of a single OpenOffice.org module, like Writer or Calc.
  51     </p>
  52
  53     @since OOo 2.0.0
  54 */
  55
  56 service ModuleUICommandDescription
  57 {
  58     /** provides access to user interface commands of an installed module.
  59
  60         <p>
  61         An implementation must provide a <type scope="com::sun::star::uno">Sequence</type> which
  62         has <type scope="com::sun::star::beans">PropertyValue</type> as entries. The following
  63         entries a defined:
  64         <ul>
  65             <li><b>Label</b><br>a string which specifies the short name of the user interface command with
  66             mnemonic and optional subsequent ... if the command needs additional user input. This string
  67             can directly be used to set the text of a menu item.</li>
  68             <li><b>Name</b><br>a string which specifies the short name of the user interface command without
  69             any additional information. It can be used for the bubble help.</li>
  70             <li><b>Popup</b><br>a boolean which specifies if the user interface command is a unique
  71             identifer for a popup menu. A popup menu has a label, but is not bound to a command.</li>
  72         </ul>
  73         The key to a user interface command description is the user interface command itself which has
  74         the following syntax ".uno:$Command". For example ".uno:Open" shows the file open dialog.
  75         A complete list of user interface commands can be found inside the latest OpenOffice Developers Guide
  76         or online at http://framework.openoffice.org.
  77         </p>
  78
  79         @see com::sun::star::frame::ModuleManager
  80     */
  81
  82     interface com::sun::star::container::XNameAccess;
  83 };
  84
  85 }; }; }; };
  86
  87 #endif