1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22#ifndef __com_sun_star_ui_XStatusbarItem_idl__
23#define __com_sun_star_ui_XStatusbarItem_idl__
24
25#include <com/sun/star/uno/XInterface.idl>
26#include <com/sun/star/awt/Rectangle.idl>
27
28module com {  module sun {  module star {  module ui {
29
30/** Represents an item in a status bar
31
32    @see <type scope="com::sun::star::frame">XStatusbarController</type>
33
34    @since OpenOffice 4.0
35*/
36interface XStatusbarItem
37{
38    /** the command of the status bar item
39     */
40    [attribute, readonly] string Command;
41
42    /** the unique ID of the control within the status bar
43     */
44    [attribute, readonly] unsigned short ItemId;
45
46    /** the width of the status bar item
47     */
48    [attribute, readonly] unsigned long Width;
49
50    /** the style of the status bar item
51
52        <p>The following values apply for a status bar item:</p>
53        <ul>
54            <li>Alignment
55                <ul>
56                    <li><member scope="com::sun::star::ui">ItemStyle::ALIGN_LEFT</member></li>
57                    <li><member scope="com::sun::star::ui">ItemStyle::ALIGN_CENTER</member></li>
58                    <li><member scope="com::sun::star::ui">ItemStyle::ALIGN_RIGHT</member></li>
59                </ul>
60            </li>
61            <li>Drawing
62                <ul>
63                    <li><member scope="com::sun::star::ui">ItemStyle::DRAW_OUT3D</member></li>
64                    <li><member scope="com::sun::star::ui">ItemStyle::DRAW_IN3D</member></li>
65                    <li><member scope="com::sun::star::ui">ItemStyle::DRAW_FLAT</member></li>
66                </ul>
67            </li>
68            <li><member scope="com::sun::star::ui">ItemStyle::AUTO_SIZE</member></li>
69            <li><member scope="com::sun::star::ui">ItemStyle::OWNER_DRAW</member></li>
70        </ul>
71
72        @see <type scope="com::sun::star::ui">ItemStyle</type>
73     */
74    [attribute, readonly] unsigned short Style;
75
76    /** the offset between this status bar item and the following
77     */
78    [attribute, readonly] long Offset;
79
80    /** the rectangle on the status bar device onto which the item is drawn
81
82        @see <member scope="com::sun::star::frame">XStatusbarController::paint()</member>
83     */
84    [attribute, readonly] com::sun::star::awt::Rectangle ItemRect;
85
86    /** the text of status bar item
87     */
88    [attribute] string Text;
89
90    /** the help text of the status bar item when extended help tips are on
91     */
92    [attribute] string HelpText;
93
94    /** the help text of the status bar item when help tips are on
95     */
96    [attribute] string QuickHelpText;
97
98    /** the accesible name of the status bar item
99     */
100    [attribute] string AccessibleName;
101
102    /** whether the item is visible or not
103     */
104    [attribute] boolean Visible;
105
106    /** forces repainting the item onto the status bar device
107
108        @see <member scope="com::sun::star::frame">XStatusbarController::paint()</member>
109     */
110    void repaint();
111};
112
113}; }; }; };
114
115#endif
116