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_ItemDescriptor_idl__ 29#define __com_sun_star_ui_ItemDescriptor_idl__ 30 31#ifndef __com_sun_star_container_XIndexAccess_idl__ 32#include <com/sun/star/container/XIndexAccess.idl> 33#endif 34 35//============================================================================= 36 37module com { module sun { module star { module ui { 38 39/** 40 describes a user interface item that is part of a user interface 41 element. 42 <p>Common examples for such elements are: 43 <ul> 44 <li>menus</li> 45 <li>tool bars</li> 46 <li>status bars</li> 47 </ul> 48 No assumption is made about any graphical representation: 49 You could have a menu or a toolbox working with the same item descriptor. 50 </p> 51 52 @since OOo 2.0 53*/ 54service ItemDescriptor 55{ 56 /** specifies which type this item descriptor belongs to.<p>See constant definition 57 <type>ItemType</type>.</p> 58 */ 59 [property] short Type; 60 61 /** the text of the user interface item. 62 */ 63 [property] string Label; 64 65 /** contains the command URL which specifies which action should be accomplished. 66 */ 67 [property] string CommandURL; 68 69 /** contains the a URL that points to a help text. 70 */ 71 [property] string HelpURL; 72 73 /** different styles which influence the appearance of the item and its behavior. 74 <p>This property is only valid if the item describes a toolbar or statusbar 75 item. See <type>ItemStyle</type> for more information about possible styles.</p> 76 */ 77 [optional, property] short Style; 78 79 /** specifies the pixel distance by which the text of the item is shifted on the x-axis. 80 <p>This property is only valid if the item describes a statusbar item.</p> 81 */ 82 [optional, property] short Offset; 83 84 /** specifies an optional sub container. 85 <p>This property is valid for menus only. It can be used to define sub menus.</p> 86 */ 87 [optional, property] com::sun::star::container::XIndexAccess ItemDescriptorContainer; 88 89 /** specifies if this item is visible or not. 90 <p>This property is only valid if the item describes a toolbar or statusbar item.</p> 91 */ 92 [optional, property] boolean IsVisible; 93 94 /** specifies a pixel width for this item inside the user interface element. 95 <p>This property is only valid if the item describes a toolbar or statusbar item.</p> 96 */ 97 [optional, property] short Width; 98}; 99 100}; }; }; }; 101 102#endif 103