offapi/com/sun/star/ui/XStatusbarItem.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 module com {  module sun {  module star {  module ui {
  21
  22 /** Represents an item in a status bar
  23
  24     @see com::sun::star::frame::XStatusbarController
  25
  26     @since LibreOffice 4.1
  27 */
  28 interface XStatusbarItem
  29 {
  30     /** the command of the status bar item
  31      */
  32     [attribute, readonly] string Command;
  33
  34     /** the unique ID of the control within the status bar
  35      */
  36     [attribute, readonly] unsigned short ItemId;
  37
  38     /** the width of the status bar item
  39      */
  40     [attribute, readonly] unsigned long Width;
  41
  42     /** the style of the status bar item
  43
  44         <p>The following values apply for a status bar item:</p>
  45         <ul>
  46             <li>Alignment
  47                 <ul>
  48                     <li>com::sun::star::ui::ItemStyle::ALIGN_LEFT</li>
  49                     <li>com::sun::star::ui::ItemStyle::ALIGN_CENTER</li>
  50                     <li>com::sun::star::ui::ItemStyle::ALIGN_RIGHT</li>
  51                 </ul>
  52             </li>
  53             <li>Drawing
  54                 <ul>
  55                     <li>com::sun::star::ui::ItemStyle::DRAW_OUT3D</li>
  56                     <li>com::sun::star::ui::ItemStyle::DRAW_IN3D</li>
  57                     <li>com::sun::star::ui::ItemStyle::DRAW_FLAT</li>
  58                 </ul>
  59             </li>
  60             <li>com::sun::star::ui::ItemStyle::AUTO_SIZE</li>
  61             <li>com::sun::star::ui::ItemStyle::OWNER_DRAW</li>
  62             <li>com::sun::star::ui::ItemStyle::MANDATORY (@since LibreOffice 6.1)</li>
  63         </ul>
  64
  65         @see com::sun::star::ui::ItemStyle
  66      */
  67     [attribute, readonly] unsigned short Style;
  68
  69     /** the offset between this status bar item and the following
  70      */
  71     [attribute, readonly] long Offset;
  72
  73     /** the rectangle on the status bar device onto which the item is drawn
  74
  75         @see com::sun::star::frame::XStatusbarController::paint()
  76      */
  77     [attribute, readonly] com::sun::star::awt::Rectangle ItemRect;
  78
  79     /** the text of status bar item
  80      */
  81     [attribute] string Text;
  82
  83     /** the help text of the status bar item when extended help tips are on
  84      */
  85     [attribute] string HelpText;
  86
  87     /** the help text of the status bar item when help tips are on
  88      */
  89     [attribute] string QuickHelpText;
  90
  91     /** the accessible name of the status bar item
  92      */
  93     [attribute] string AccessibleName;
  94
  95     /** whether the item is visible or not
  96      */
  97     [attribute] boolean Visible;
  98
  99     /** forces repainting the item onto the status bar device
 100
 101         @see com::sun::star::frame::XStatusbarController::paint()
 102      */
 103     void repaint();
 104 };
 105
 106 }; }; }; };
 107
 108 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */