offapi/com/sun/star/ui/ItemDescriptor.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ItemDescriptor.idl,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_ui_ItemDescriptor_idl__
  32 #define __com_sun_star_ui_ItemDescriptor_idl__
  33
  34 #ifndef __com_sun_star_container_XIndexAccess_idl__
  35 #include <com/sun/star/container/XIndexAccess.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module ui {
  41
  42 /**
  43     describes a user interface item that is part of a user interface
  44     element.
  45     <p>Common examples for such elements are:
  46         <ul>
  47             <li>menus</li>
  48             <li>tool bars</li>
  49             <li>status bars</li>
  50         </ul>
  51        No assumption is made about any graphical representation:
  52        You could have a menu or a toolbox working with the same item descriptor.
  53     </p>
  54
  55     @since OOo 2.0.0
  56 */
  57 service ItemDescriptor
  58 {
  59     /** specifies which type this item descriptor belongs to.<p>See constant definition
  60         <type>ItemType</type>.</p>
  61     */
  62     [property] short Type;
  63
  64     /** the text of the user interface item.
  65     */
  66     [property] string Label;
  67
  68     /** contains the command URL which specifies which action should be accomplished.
  69      */
  70     [property] string CommandURL;
  71
  72     /** contains the a URL that points to a help text.
  73      */
  74     [property] string HelpURL;
  75
  76     /** different styles which influence the appearance of the item and its behavior.
  77         <p>This property is only valid if the item describes a toolbar or statusbar
  78         item. See <type>ItemStyle</type> for more information about possible styles.</p>
  79     */
  80     [optional, property] short Style;
  81
  82     /** specifies the pixel distance by which the text of the item is shifted on the x-axis.
  83         <p>This property is only valid if the item describes a statusbar item.</p>
  84     */
  85     [optional, property] short Offset;
  86
  87     /** specifies an optional sub container.
  88         <p>This property is valid for menus only. It can be used to define sub menus.</p>
  89     */
  90     [optional, property] com::sun::star::container::XIndexAccess ItemDescriptorContainer;
  91
  92     /** specifies if this item is visible or not.
  93         <p>This property is only valid if the item describes a toolbar or statusbar item.</p>
  94     */
  95     [optional, property] boolean IsVisible;
  96
  97     /** specifies a pixel width for this item inside the user interface element.
  98         <p>This property is only valid if the item describes a toolbar or statusbar item.</p>
  99     */
 100     [optional, property] short Width;
 101 };
 102
 103 }; }; }; };
 104
 105 #endif