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