174c4339dSAriel Constenla-Haile/**************************************************************
274c4339dSAriel Constenla-Haile *
374c4339dSAriel Constenla-Haile * Licensed to the Apache Software Foundation (ASF) under one
474c4339dSAriel Constenla-Haile * or more contributor license agreements.  See the NOTICE file
574c4339dSAriel Constenla-Haile * distributed with this work for additional information
674c4339dSAriel Constenla-Haile * regarding copyright ownership.  The ASF licenses this file
774c4339dSAriel Constenla-Haile * to you under the Apache License, Version 2.0 (the
874c4339dSAriel Constenla-Haile * "License"); you may not use this file except in compliance
974c4339dSAriel Constenla-Haile * with the License.  You may obtain a copy of the License at
1074c4339dSAriel Constenla-Haile *
1174c4339dSAriel Constenla-Haile *   http://www.apache.org/licenses/LICENSE-2.0
1274c4339dSAriel Constenla-Haile *
1374c4339dSAriel Constenla-Haile * Unless required by applicable law or agreed to in writing,
1474c4339dSAriel Constenla-Haile * software distributed under the License is distributed on an
1574c4339dSAriel Constenla-Haile * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
1674c4339dSAriel Constenla-Haile * KIND, either express or implied.  See the License for the
1774c4339dSAriel Constenla-Haile * specific language governing permissions and limitations
1874c4339dSAriel Constenla-Haile * under the License.
1974c4339dSAriel Constenla-Haile *
2074c4339dSAriel Constenla-Haile *************************************************************/
2174c4339dSAriel Constenla-Haile
2274c4339dSAriel Constenla-Haile#ifndef __com_sun_star_ui_XStatusbarItem_idl__
2374c4339dSAriel Constenla-Haile#define __com_sun_star_ui_XStatusbarItem_idl__
2474c4339dSAriel Constenla-Haile
25*af1681acSAriel Constenla-Haile#include <com/sun/star/uno/XInterface.idl>
2674c4339dSAriel Constenla-Haile#include <com/sun/star/awt/Rectangle.idl>
2774c4339dSAriel Constenla-Haile
2874c4339dSAriel Constenla-Hailemodule com {  module sun {  module star {  module ui {
2974c4339dSAriel Constenla-Haile
3074c4339dSAriel Constenla-Haile/** Represents an item in a status bar
3174c4339dSAriel Constenla-Haile
3274c4339dSAriel Constenla-Haile    @see <type scope="com::sun::star::frame">XStatusbarController</type>
3374c4339dSAriel Constenla-Haile
3474c4339dSAriel Constenla-Haile    @since Apache OpenOffice 3.5
3574c4339dSAriel Constenla-Haile*/
3674c4339dSAriel Constenla-Haileinterface XStatusbarItem
3774c4339dSAriel Constenla-Haile{
3874c4339dSAriel Constenla-Haile    /** the command of the status bar item
3974c4339dSAriel Constenla-Haile     */
4074c4339dSAriel Constenla-Haile    [attribute, readonly] string Command;
4174c4339dSAriel Constenla-Haile
4274c4339dSAriel Constenla-Haile    /** the unique ID of the control within the status bar
4374c4339dSAriel Constenla-Haile     */
4474c4339dSAriel Constenla-Haile    [attribute, readonly] unsigned short ItemId;
4574c4339dSAriel Constenla-Haile
4674c4339dSAriel Constenla-Haile    /** the width of the status bar item
4774c4339dSAriel Constenla-Haile     */
4874c4339dSAriel Constenla-Haile    [attribute, readonly] unsigned long Width;
4974c4339dSAriel Constenla-Haile
5074c4339dSAriel Constenla-Haile    /** the style of the status bar item
5174c4339dSAriel Constenla-Haile
5274c4339dSAriel Constenla-Haile        <p>The following values apply for a status bar item:</p>
5374c4339dSAriel Constenla-Haile        <ul>
5474c4339dSAriel Constenla-Haile            <li>Alignment
5574c4339dSAriel Constenla-Haile                <ul>
5674c4339dSAriel Constenla-Haile                    <li><member scope="com::sun::star::ui">ItemStyle::ALIGN_LEFT</member></li>
5774c4339dSAriel Constenla-Haile                    <li><member scope="com::sun::star::ui">ItemStyle::ALIGN_CENTER</member></li>
5874c4339dSAriel Constenla-Haile                    <li><member scope="com::sun::star::ui">ItemStyle::ALIGN_RIGHT</member></li>
5974c4339dSAriel Constenla-Haile                </ul>
6074c4339dSAriel Constenla-Haile            </li>
6174c4339dSAriel Constenla-Haile            <li>Drawing
6274c4339dSAriel Constenla-Haile                <ul>
6374c4339dSAriel Constenla-Haile                    <li><member scope="com::sun::star::ui">ItemStyle::DRAW_OUT3D</member></li>
6474c4339dSAriel Constenla-Haile                    <li><member scope="com::sun::star::ui">ItemStyle::DRAW_IN3D</member></li>
6574c4339dSAriel Constenla-Haile                    <li><member scope="com::sun::star::ui">ItemStyle::DRAW_FLAT</member></li>
6674c4339dSAriel Constenla-Haile                </ul>
6774c4339dSAriel Constenla-Haile            </li>
6874c4339dSAriel Constenla-Haile            <li><member scope="com::sun::star::ui">ItemStyle::AUTO_SIZE</member></li>
6974c4339dSAriel Constenla-Haile            <li><member scope="com::sun::star::ui">ItemStyle::OWNER_DRAW</member></li>
7074c4339dSAriel Constenla-Haile        </ul>
7174c4339dSAriel Constenla-Haile
7274c4339dSAriel Constenla-Haile        @see <type scope="com::sun::star::ui">ItemStyle</type>
7374c4339dSAriel Constenla-Haile     */
7474c4339dSAriel Constenla-Haile    [attribute, readonly] unsigned short Style;
7574c4339dSAriel Constenla-Haile
7674c4339dSAriel Constenla-Haile    /** the offset between this status bar item and the following
7774c4339dSAriel Constenla-Haile     */
7874c4339dSAriel Constenla-Haile    [attribute, readonly] long Offset;
7974c4339dSAriel Constenla-Haile
8074c4339dSAriel Constenla-Haile    /** the rectangle on the status bar device onto which the item is drawn
8174c4339dSAriel Constenla-Haile
8274c4339dSAriel Constenla-Haile        @see <member scope="com::sun::star::frame">XStatusbarController::paint()</member>
8374c4339dSAriel Constenla-Haile     */
8474c4339dSAriel Constenla-Haile    [attribute, readonly] com::sun::star::awt::Rectangle ItemRect;
8574c4339dSAriel Constenla-Haile
8674c4339dSAriel Constenla-Haile    /** the text of status bar item
8774c4339dSAriel Constenla-Haile     */
8874c4339dSAriel Constenla-Haile    [attribute] string Text;
8974c4339dSAriel Constenla-Haile
9074c4339dSAriel Constenla-Haile    /** the help text of the status bar item when extended help tips are on
9174c4339dSAriel Constenla-Haile     */
9274c4339dSAriel Constenla-Haile    [attribute] string HelpText;
9374c4339dSAriel Constenla-Haile
9474c4339dSAriel Constenla-Haile    /** the help text of the status bar item when help tips are on
9574c4339dSAriel Constenla-Haile     */
9674c4339dSAriel Constenla-Haile    [attribute] string QuickHelpText;
9774c4339dSAriel Constenla-Haile
9874c4339dSAriel Constenla-Haile    /** the accesible name of the status bar item
9974c4339dSAriel Constenla-Haile     */
10074c4339dSAriel Constenla-Haile    [attribute] string AccessibleName;
10174c4339dSAriel Constenla-Haile
10274c4339dSAriel Constenla-Haile    /** whether the item is visible or not
10374c4339dSAriel Constenla-Haile     */
10474c4339dSAriel Constenla-Haile    [attribute] boolean Visible;
10574c4339dSAriel Constenla-Haile
10674c4339dSAriel Constenla-Haile    /** forces repainting the item onto the status bar device
10774c4339dSAriel Constenla-Haile
10874c4339dSAriel Constenla-Haile        @see <member scope="com::sun::star::frame">XStatusbarController::paint()</member>
10974c4339dSAriel Constenla-Haile     */
11074c4339dSAriel Constenla-Haile    void repaint();
11174c4339dSAriel Constenla-Haile};
11274c4339dSAriel Constenla-Haile
11374c4339dSAriel Constenla-Haile}; }; }; };
11474c4339dSAriel Constenla-Haile
11574c4339dSAriel Constenla-Haile#endif
116