1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_ui_ItemDescriptor_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_ui_ItemDescriptor_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_container_XIndexAccess_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/container/XIndexAccess.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski//============================================================================= 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module ui { 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski/** 36*b1cdbd2cSJim Jagielski describes a user interface item that is part of a user interface 37*b1cdbd2cSJim Jagielski element. 38*b1cdbd2cSJim Jagielski <p>Common examples for such elements are: 39*b1cdbd2cSJim Jagielski <ul> 40*b1cdbd2cSJim Jagielski <li>menus</li> 41*b1cdbd2cSJim Jagielski <li>tool bars</li> 42*b1cdbd2cSJim Jagielski <li>status bars</li> 43*b1cdbd2cSJim Jagielski </ul> 44*b1cdbd2cSJim Jagielski No assumption is made about any graphical representation: 45*b1cdbd2cSJim Jagielski You could have a menu or a toolbox working with the same item descriptor. 46*b1cdbd2cSJim Jagielski </p> 47*b1cdbd2cSJim Jagielski 48*b1cdbd2cSJim Jagielski @since OpenOffice 2.0 49*b1cdbd2cSJim Jagielski*/ 50*b1cdbd2cSJim Jagielskiservice ItemDescriptor 51*b1cdbd2cSJim Jagielski{ 52*b1cdbd2cSJim Jagielski /** specifies which type this item descriptor belongs to.<p>See constant definition 53*b1cdbd2cSJim Jagielski <type>ItemType</type>.</p> 54*b1cdbd2cSJim Jagielski */ 55*b1cdbd2cSJim Jagielski [property] short Type; 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski /** the text of the user interface item. 58*b1cdbd2cSJim Jagielski */ 59*b1cdbd2cSJim Jagielski [property] string Label; 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski /** contains the command URL which specifies which action should be accomplished. 62*b1cdbd2cSJim Jagielski */ 63*b1cdbd2cSJim Jagielski [property] string CommandURL; 64*b1cdbd2cSJim Jagielski 65*b1cdbd2cSJim Jagielski /** contains the a URL that points to a help text. 66*b1cdbd2cSJim Jagielski */ 67*b1cdbd2cSJim Jagielski [property] string HelpURL; 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski /** different styles which influence the appearance of the item and its behavior. 70*b1cdbd2cSJim Jagielski <p>This property is only valid if the item describes a toolbar or statusbar 71*b1cdbd2cSJim Jagielski item. See <type>ItemStyle</type> for more information about possible styles.</p> 72*b1cdbd2cSJim Jagielski */ 73*b1cdbd2cSJim Jagielski [optional, property] short Style; 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski /** specifies the pixel distance by which the text of the item is shifted on the x-axis. 76*b1cdbd2cSJim Jagielski <p>This property is only valid if the item describes a statusbar item.</p> 77*b1cdbd2cSJim Jagielski */ 78*b1cdbd2cSJim Jagielski [optional, property] short Offset; 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski /** specifies an optional sub container. 81*b1cdbd2cSJim Jagielski <p>This property is valid for menus only. It can be used to define sub menus.</p> 82*b1cdbd2cSJim Jagielski */ 83*b1cdbd2cSJim Jagielski [optional, property] com::sun::star::container::XIndexAccess ItemDescriptorContainer; 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski /** specifies if this item is visible or not. 86*b1cdbd2cSJim Jagielski <p>This property is only valid if the item describes a toolbar or statusbar item.</p> 87*b1cdbd2cSJim Jagielski */ 88*b1cdbd2cSJim Jagielski [optional, property] boolean IsVisible; 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski /** specifies a pixel width for this item inside the user interface element. 91*b1cdbd2cSJim Jagielski <p>This property is only valid if the item describes a toolbar or statusbar item.</p> 92*b1cdbd2cSJim Jagielski */ 93*b1cdbd2cSJim Jagielski [optional, property] short Width; 94*b1cdbd2cSJim Jagielski}; 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski}; }; }; }; 97*b1cdbd2cSJim Jagielski 98*b1cdbd2cSJim Jagielski#endif 99