1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir#ifndef __com_sun_star_ui_ModuleUICommandDescription_idl__ 29*cdf0e10cSrcweir#define __com_sun_star_ui_ModuleUICommandDescription_idl__ 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir#ifndef __com_sun_star_container_XNameAccess_idl__ 32*cdf0e10cSrcweir#include <com/sun/star/container/XNameAccess.idl> 33*cdf0e10cSrcweir#endif 34*cdf0e10cSrcweir 35*cdf0e10cSrcweir//============================================================================= 36*cdf0e10cSrcweir 37*cdf0e10cSrcweirmodule com { module sun { module star { module ui { 38*cdf0e10cSrcweir 39*cdf0e10cSrcweir//============================================================================= 40*cdf0e10cSrcweir 41*cdf0e10cSrcweir/** a service which provides information about the user interface commands of 42*cdf0e10cSrcweir a single module. 43*cdf0e10cSrcweir 44*cdf0e10cSrcweir <p> 45*cdf0e10cSrcweir Every OpenOffice.org module has an amount of commands that can be used by 46*cdf0e10cSrcweir user interface elements. This service provides access to the user interface commands 47*cdf0e10cSrcweir that are part of a single OpenOffice.org module, like Writer or Calc. 48*cdf0e10cSrcweir </p> 49*cdf0e10cSrcweir 50*cdf0e10cSrcweir @since OOo 2.0 51*cdf0e10cSrcweir*/ 52*cdf0e10cSrcweir 53*cdf0e10cSrcweirservice ModuleUICommandDescription 54*cdf0e10cSrcweir{ 55*cdf0e10cSrcweir /** provides access to user interface commands of an installed module. 56*cdf0e10cSrcweir 57*cdf0e10cSrcweir <p> 58*cdf0e10cSrcweir An implementation must provide a <type scope="com::sun::star::uno">Sequence</type> which 59*cdf0e10cSrcweir has <type scope="com::sun::star::beans">PropertyValue</type> as entries. The following 60*cdf0e10cSrcweir entries a defined: 61*cdf0e10cSrcweir <ul> 62*cdf0e10cSrcweir <li><b>Label</b><br>a string which specifies the short name of the user interface command with 63*cdf0e10cSrcweir mnemonic and optional subsequent ... if the command needs additional user input. This string 64*cdf0e10cSrcweir can directly be used to set the text of a menu item.</li> 65*cdf0e10cSrcweir <li><b>Name</b><br>a string which specifies the short name of the user interface command without 66*cdf0e10cSrcweir any additional information. It can be used for the bubble help.</li> 67*cdf0e10cSrcweir <li><b>Popup</b><br>a boolean which specifies if the user interface command is a unique 68*cdf0e10cSrcweir identifer for a popup menu. A popup menu has a label, but is not bound to a command.</li> 69*cdf0e10cSrcweir </ul> 70*cdf0e10cSrcweir The key to a user interface command description is the user interface command itself which has 71*cdf0e10cSrcweir the following syntax ".uno:$Command". For example ".uno:Open" shows the file open dialog. 72*cdf0e10cSrcweir A complete list of user interface commands can be found inside the latest OpenOffice Developers Guide 73*cdf0e10cSrcweir or online at http://framework.openoffice.org. 74*cdf0e10cSrcweir </p> 75*cdf0e10cSrcweir 76*cdf0e10cSrcweir @see com::sun::star::frame::ModuleManager 77*cdf0e10cSrcweir */ 78*cdf0e10cSrcweir 79*cdf0e10cSrcweir interface com::sun::star::container::XNameAccess; 80*cdf0e10cSrcweir}; 81*cdf0e10cSrcweir 82*cdf0e10cSrcweir}; }; }; }; 83*cdf0e10cSrcweir 84*cdf0e10cSrcweir#endif 85