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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com {  module sun {  module star {  module ui {
  22
  23 /**
  24     describes a user interface item that is part of a user interface
  25     element.
  26     <p>Common examples for such elements are:
  27         <ul>
  28             <li>menus</li>
  29             <li>tool bars</li>
  30             <li>status bars</li>
  31         </ul>
  32        No assumption is made about any graphical representation:
  33        You could have a menu or a toolbox working with the same item descriptor.
  34     </p>
  35
  36     @since OOo 2.0
  37 */
  38 service ItemDescriptor
  39 {
  40     /** specifies which type this item descriptor belongs to.<p>See constant definition
  41         ItemType.</p>
  42     */
  43     [property] short Type;
  44
  45     /** the text of the user interface item.
  46     */
  47     [property] string Label;
  48
  49     /** contains the command URL which specifies which action should be accomplished.
  50      */
  51     [property] string CommandURL;
  52
  53     /** contains the a URL that points to a help text.
  54      */
  55     [property] string HelpURL;
  56
  57     /** different styles which influence the appearance of the item and its behavior.
  58         <p>This property is only valid if the item describes a toolbar or statusbar
  59         item. See ItemStyle for more information about possible styles.</p>
  60     */
  61     [optional, property] short Style;
  62
  63     /** specifies the pixel distance by which the text of the item is shifted on the x-axis.
  64         <p>This property is only valid if the item describes a statusbar item.</p>
  65     */
  66     [optional, property] short Offset;
  67
  68     /** specifies an optional sub container.
  69         <p>This property is valid for menus only. It can be used to define sub menus.</p>
  70     */
  71     [optional, property] com::sun::star::container::XIndexAccess ItemDescriptorContainer;
  72
  73     /** specifies if this item is visible or not.
  74         <p>This property is only valid if the item describes a toolbar or statusbar item.</p>
  75     */
  76     [optional, property] boolean IsVisible;
  77
  78     /** specifies a pixel width for this item inside the user interface element.
  79         <p>This property is only valid if the item describes a toolbar or statusbar item.</p>
  80     */
  81     [optional, property] short Width;
  82 };
  83
  84 }; }; }; };
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */