1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_ui_ModuleUICommandDescription_idl__ 25cdf0e10cSrcweir#define __com_sun_star_ui_ModuleUICommandDescription_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_container_XNameAccess_idl__ 28cdf0e10cSrcweir#include <com/sun/star/container/XNameAccess.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir 31cdf0e10cSrcweir//============================================================================= 32cdf0e10cSrcweir 33cdf0e10cSrcweirmodule com { module sun { module star { module ui { 34cdf0e10cSrcweir 35cdf0e10cSrcweir//============================================================================= 36cdf0e10cSrcweir 37cdf0e10cSrcweir/** a service which provides information about the user interface commands of 38cdf0e10cSrcweir a single module. 39cdf0e10cSrcweir 40cdf0e10cSrcweir <p> 41cdf0e10cSrcweir Every OpenOffice.org module has an amount of commands that can be used by 42cdf0e10cSrcweir user interface elements. This service provides access to the user interface commands 43cdf0e10cSrcweir that are part of a single OpenOffice.org module, like Writer or Calc. 44cdf0e10cSrcweir </p> 45cdf0e10cSrcweir 46*f431c806SJürgen Schmidt @since OpenOffice 2.0 47cdf0e10cSrcweir*/ 48cdf0e10cSrcweir 49cdf0e10cSrcweirservice ModuleUICommandDescription 50cdf0e10cSrcweir{ 51cdf0e10cSrcweir /** provides access to user interface commands of an installed module. 52cdf0e10cSrcweir 53cdf0e10cSrcweir <p> 54cdf0e10cSrcweir An implementation must provide a <type scope="com::sun::star::uno">Sequence</type> which 55cdf0e10cSrcweir has <type scope="com::sun::star::beans">PropertyValue</type> as entries. The following 56cdf0e10cSrcweir entries a defined: 57cdf0e10cSrcweir <ul> 58cdf0e10cSrcweir <li><b>Label</b><br>a string which specifies the short name of the user interface command with 59cdf0e10cSrcweir mnemonic and optional subsequent ... if the command needs additional user input. This string 60cdf0e10cSrcweir can directly be used to set the text of a menu item.</li> 61cdf0e10cSrcweir <li><b>Name</b><br>a string which specifies the short name of the user interface command without 62cdf0e10cSrcweir any additional information. It can be used for the bubble help.</li> 63cdf0e10cSrcweir <li><b>Popup</b><br>a boolean which specifies if the user interface command is a unique 64cdf0e10cSrcweir identifer for a popup menu. A popup menu has a label, but is not bound to a command.</li> 65cdf0e10cSrcweir </ul> 66cdf0e10cSrcweir The key to a user interface command description is the user interface command itself which has 67cdf0e10cSrcweir the following syntax ".uno:$Command". For example ".uno:Open" shows the file open dialog. 68cdf0e10cSrcweir A complete list of user interface commands can be found inside the latest OpenOffice Developers Guide 69cdf0e10cSrcweir or online at http://framework.openoffice.org. 70cdf0e10cSrcweir </p> 71cdf0e10cSrcweir 72cdf0e10cSrcweir @see com::sun::star::frame::ModuleManager 73cdf0e10cSrcweir */ 74cdf0e10cSrcweir 75cdf0e10cSrcweir interface com::sun::star::container::XNameAccess; 76cdf0e10cSrcweir}; 77cdf0e10cSrcweir 78cdf0e10cSrcweir}; }; }; }; 79cdf0e10cSrcweir 80cdf0e10cSrcweir#endif 81