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