1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_awt_UnoControlButtonModel_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_awt_UnoControlButtonModel_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_awt_FontDescriptor_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/awt/FontDescriptor.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_awt_UnoControlModel_idl__ 30*b1cdbd2cSJim Jagielski#include <com/sun/star/awt/UnoControlModel.idl> 31*b1cdbd2cSJim Jagielski#endif 32*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_style_VerticalAlignment_idl__ 33*b1cdbd2cSJim Jagielski#include <com/sun/star/style/VerticalAlignment.idl> 34*b1cdbd2cSJim Jagielski#endif 35*b1cdbd2cSJim Jagielski#ifndef com_sun_star_graphic_XGraphic_idl 36*b1cdbd2cSJim Jagielski#include <com/sun/star/graphic/XGraphic.idl> 37*b1cdbd2cSJim Jagielski#endif 38*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_util_Color_idl__ 39*b1cdbd2cSJim Jagielski#include <com/sun/star/util/Color.idl> 40*b1cdbd2cSJim Jagielski#endif 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski//============================================================================= 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski module com { module sun { module star { module awt { 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski//============================================================================= 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski/** specifies the standard model of an <type>UnoControlButton</type>. 50*b1cdbd2cSJim Jagielski */ 51*b1cdbd2cSJim Jagielskipublished service UnoControlButtonModel 52*b1cdbd2cSJim Jagielski{ 53*b1cdbd2cSJim Jagielski service com::sun::star::awt::UnoControlModel; 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski /** specifies the horizontal alignment of the text in the control. 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski <pre> 60*b1cdbd2cSJim Jagielski 0: left 61*b1cdbd2cSJim Jagielski 1: center 62*b1cdbd2cSJim Jagielski 2: right 63*b1cdbd2cSJim Jagielski </pre> 64*b1cdbd2cSJim Jagielski */ 65*b1cdbd2cSJim Jagielski [optional, property] short Align; 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski /** specifies the background color (RGB) of the control. 70*b1cdbd2cSJim Jagielski */ 71*b1cdbd2cSJim Jagielski [property] com::sun::star::util::Color BackgroundColor; 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski /** specifies that the button is the default button on the document. 76*b1cdbd2cSJim Jagielski */ 77*b1cdbd2cSJim Jagielski [property] boolean DefaultButton; 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski /** determines whether the control is enabled or disabled. 82*b1cdbd2cSJim Jagielski */ 83*b1cdbd2cSJim Jagielski [property] boolean Enabled; 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski /** specifies whether the button control should grab the focus when clicked. 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski <p>If set to <TRUE/> (which is the default), the button control automatically grabs the 90*b1cdbd2cSJim Jagielski focus when the user clicks onto it with the mouse.<br/> 91*b1cdbd2cSJim Jagielski If set to <FALSE/>, the focus is preserved when the user operates the button control with 92*b1cdbd2cSJim Jagielski the mouse.</p> 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski @since OpenOffice 2.0 95*b1cdbd2cSJim Jagielski */ 96*b1cdbd2cSJim Jagielski [optional, property] boolean FocusOnClick; 97*b1cdbd2cSJim Jagielski 98*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski /** specifies the font attributes of the text in the control. 101*b1cdbd2cSJim Jagielski */ 102*b1cdbd2cSJim Jagielski [property] com::sun::star::awt::FontDescriptor FontDescriptor; 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 105*b1cdbd2cSJim Jagielski 106*b1cdbd2cSJim Jagielski /** specifies the <type scope="com::sun::star::text">FontEmphasis</type> 107*b1cdbd2cSJim Jagielski value of the text in the control. 108*b1cdbd2cSJim Jagielski */ 109*b1cdbd2cSJim Jagielski [property] short FontEmphasisMark; 110*b1cdbd2cSJim Jagielski 111*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 112*b1cdbd2cSJim Jagielski 113*b1cdbd2cSJim Jagielski /** specifies the <type scope="com::sun::star::text">FontRelief</type> 114*b1cdbd2cSJim Jagielski value of the text in the control. 115*b1cdbd2cSJim Jagielski */ 116*b1cdbd2cSJim Jagielski [property] short FontRelief; 117*b1cdbd2cSJim Jagielski 118*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 119*b1cdbd2cSJim Jagielski 120*b1cdbd2cSJim Jagielski /** specifies the help text of the control. 121*b1cdbd2cSJim Jagielski */ 122*b1cdbd2cSJim Jagielski [property] string HelpText; 123*b1cdbd2cSJim Jagielski 124*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 125*b1cdbd2cSJim Jagielski 126*b1cdbd2cSJim Jagielski /** specifies the help URL of the control. 127*b1cdbd2cSJim Jagielski */ 128*b1cdbd2cSJim Jagielski [property] string HelpURL; 129*b1cdbd2cSJim Jagielski 130*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 131*b1cdbd2cSJim Jagielski 132*b1cdbd2cSJim Jagielski /** specifies the alignment of the image inside the button as 133*b1cdbd2cSJim Jagielski <type>ImageAlign</type> value. 134*b1cdbd2cSJim Jagielski */ 135*b1cdbd2cSJim Jagielski [property] short ImageAlign; 136*b1cdbd2cSJim Jagielski 137*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 138*b1cdbd2cSJim Jagielski 139*b1cdbd2cSJim Jagielski /** specifies the position of the image, if any, relative to the text, if any 140*b1cdbd2cSJim Jagielski 141*b1cdbd2cSJim Jagielski <p>Valid values of this property are specified with <type>ImagePosition</type>.</p> 142*b1cdbd2cSJim Jagielski 143*b1cdbd2cSJim Jagielski <p>If this property is present, it supersedes the <member>ImageAlign</member> property - setting 144*b1cdbd2cSJim Jagielski one of both properties sets the other one to the best possible match.</p> 145*b1cdbd2cSJim Jagielski */ 146*b1cdbd2cSJim Jagielski [optional, property] short ImagePosition; 147*b1cdbd2cSJim Jagielski 148*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 149*b1cdbd2cSJim Jagielski 150*b1cdbd2cSJim Jagielski /** specifies an URL to an image to use for the button. 151*b1cdbd2cSJim Jagielski @see Graphic 152*b1cdbd2cSJim Jagielski */ 153*b1cdbd2cSJim Jagielski [property] string ImageURL; 154*b1cdbd2cSJim Jagielski 155*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 156*b1cdbd2cSJim Jagielski 157*b1cdbd2cSJim Jagielski /** specifies a graphic to be displayed at the button 158*b1cdbd2cSJim Jagielski 159*b1cdbd2cSJim Jagielski <p>If this property is present, it interacts with the <member>ImageURL</member>in the 160*b1cdbd2cSJim Jagielski following way: 161*b1cdbd2cSJim Jagielski <ul><li>If <member>ImageURL</member> is set, <member>Graphic</member> will be reset 162*b1cdbd2cSJim Jagielski to an object as loaded from the given image URL, or <NULL/> if <member>ImageURL</member> 163*b1cdbd2cSJim Jagielski does not point to a valid image file.</li> 164*b1cdbd2cSJim Jagielski <li>If <member>Graphic</member> is set, <member>ImageURL</member> will be reset 165*b1cdbd2cSJim Jagielski to an empty string.</li> 166*b1cdbd2cSJim Jagielski </ul></p> 167*b1cdbd2cSJim Jagielski 168*b1cdbd2cSJim Jagielski @since OpenOffice 2.1 169*b1cdbd2cSJim Jagielski */ 170*b1cdbd2cSJim Jagielski [optional, property, transient] com::sun::star::graphic::XGraphic Graphic; 171*b1cdbd2cSJim Jagielski 172*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 173*b1cdbd2cSJim Jagielski 174*b1cdbd2cSJim Jagielski /** specifies the label of the control. 175*b1cdbd2cSJim Jagielski */ 176*b1cdbd2cSJim Jagielski [property] string Label; 177*b1cdbd2cSJim Jagielski 178*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 179*b1cdbd2cSJim Jagielski 180*b1cdbd2cSJim Jagielski /** specifies that the text may be displayed on more than one line. 181*b1cdbd2cSJim Jagielski 182*b1cdbd2cSJim Jagielski @since OpenOffice 2.0 183*b1cdbd2cSJim Jagielski */ 184*b1cdbd2cSJim Jagielski [optional, property] boolean MultiLine; 185*b1cdbd2cSJim Jagielski 186*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 187*b1cdbd2cSJim Jagielski 188*b1cdbd2cSJim Jagielski /** specifies that the control will be printed with the document. 189*b1cdbd2cSJim Jagielski */ 190*b1cdbd2cSJim Jagielski [property] boolean Printable; 191*b1cdbd2cSJim Jagielski 192*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 193*b1cdbd2cSJim Jagielski 194*b1cdbd2cSJim Jagielski /** specifies the default action of the button as <type>PushButtonType</type> value. 195*b1cdbd2cSJim Jagielski */ 196*b1cdbd2cSJim Jagielski [property] short PushButtonType; 197*b1cdbd2cSJim Jagielski 198*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 199*b1cdbd2cSJim Jagielski 200*b1cdbd2cSJim Jagielski /** specifies whether the control should show repeating behaviour. 201*b1cdbd2cSJim Jagielski 202*b1cdbd2cSJim Jagielski <p>Normally, when you click a button with the mouse, you need to 203*b1cdbd2cSJim Jagielski release the mouse button, and press it again. With this property 204*b1cdbd2cSJim Jagielski set to <TRUE/>, the button is repeatedly pressed while you hold 205*b1cdbd2cSJim Jagielski down the mouse button.</p> 206*b1cdbd2cSJim Jagielski 207*b1cdbd2cSJim Jagielski @since OpenOffice 2.0 208*b1cdbd2cSJim Jagielski */ 209*b1cdbd2cSJim Jagielski [optional, property] boolean Repeat; 210*b1cdbd2cSJim Jagielski 211*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 212*b1cdbd2cSJim Jagielski 213*b1cdbd2cSJim Jagielski /** specifies the mouse repeat delay, in milliseconds. 214*b1cdbd2cSJim Jagielski 215*b1cdbd2cSJim Jagielski <p>When the user presses a mouse in a control area where this triggers 216*b1cdbd2cSJim Jagielski an action (such as pressing the button), then usual control implementations 217*b1cdbd2cSJim Jagielski allow to repeatedly trigger this action, without the need to release the 218*b1cdbd2cSJim Jagielski mouse button and to press it again. The delay between two such triggers 219*b1cdbd2cSJim Jagielski is specified with this property.</p> 220*b1cdbd2cSJim Jagielski 221*b1cdbd2cSJim Jagielski @since OpenOffice 2.0 222*b1cdbd2cSJim Jagielski */ 223*b1cdbd2cSJim Jagielski [optional, property] long RepeatDelay; 224*b1cdbd2cSJim Jagielski 225*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 226*b1cdbd2cSJim Jagielski 227*b1cdbd2cSJim Jagielski /** specifies the state of the control. 228*b1cdbd2cSJim Jagielski */ 229*b1cdbd2cSJim Jagielski [property] short State; 230*b1cdbd2cSJim Jagielski 231*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 232*b1cdbd2cSJim Jagielski 233*b1cdbd2cSJim Jagielski /** specifies that the control can be reached with the TAB key. 234*b1cdbd2cSJim Jagielski */ 235*b1cdbd2cSJim Jagielski [property] boolean Tabstop; 236*b1cdbd2cSJim Jagielski 237*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 238*b1cdbd2cSJim Jagielski 239*b1cdbd2cSJim Jagielski /** specifies the text color (RGB) of the control. 240*b1cdbd2cSJim Jagielski */ 241*b1cdbd2cSJim Jagielski [property] com::sun::star::util::Color TextColor; 242*b1cdbd2cSJim Jagielski 243*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 244*b1cdbd2cSJim Jagielski 245*b1cdbd2cSJim Jagielski /** specifies the text line color (RGB) of the control. 246*b1cdbd2cSJim Jagielski */ 247*b1cdbd2cSJim Jagielski [property] com::sun::star::util::Color TextLineColor; 248*b1cdbd2cSJim Jagielski 249*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 250*b1cdbd2cSJim Jagielski 251*b1cdbd2cSJim Jagielski /** specifies whether the button should toggle on a single operation. 252*b1cdbd2cSJim Jagielski 253*b1cdbd2cSJim Jagielski <p>If this property is set to <TRUE/>, a single operation of the button control (pressing space 254*b1cdbd2cSJim Jagielski while it is focused, or clicking onto it) toggles it between a <em>pressed</em> and a <em>not 255*b1cdbd2cSJim Jagielski pressed</em> state.</p> 256*b1cdbd2cSJim Jagielski 257*b1cdbd2cSJim Jagielski <p>The default for this property is <FALSE/>, which means the button behaves like a usual 258*b1cdbd2cSJim Jagielski push button.</p> 259*b1cdbd2cSJim Jagielski 260*b1cdbd2cSJim Jagielski @since OpenOffice 2.0 261*b1cdbd2cSJim Jagielski */ 262*b1cdbd2cSJim Jagielski [optional, property] boolean Toggle; 263*b1cdbd2cSJim Jagielski 264*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 265*b1cdbd2cSJim Jagielski 266*b1cdbd2cSJim Jagielski /** specifies the vertical alignment of the text in the control. 267*b1cdbd2cSJim Jagielski 268*b1cdbd2cSJim Jagielski @since OpenOffice 2.0 269*b1cdbd2cSJim Jagielski */ 270*b1cdbd2cSJim Jagielski [optional, property] com::sun::star::style::VerticalAlignment VerticalAlign; 271*b1cdbd2cSJim Jagielski 272*b1cdbd2cSJim Jagielski}; 273*b1cdbd2cSJim Jagielski 274*b1cdbd2cSJim Jagielski//============================================================================= 275*b1cdbd2cSJim Jagielski 276*b1cdbd2cSJim Jagielski}; }; }; }; 277*b1cdbd2cSJim Jagielski 278*b1cdbd2cSJim Jagielski#endif 279