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 23#ifndef __com_sun_star_awt_UnoControlSpinButtonModel_idl__ 24#define __com_sun_star_awt_UnoControlSpinButtonModel_idl__ 25 26#ifndef __com_sun_star_awt_UnoControlModel_idl__ 27#include <com/sun/star/awt/UnoControlModel.idl> 28#endif 29 30#ifndef __com_sun_star_util_Color_idl__ 31#include <com/sun/star/util/Color.idl> 32#endif 33 34 35//============================================================================= 36 37 module com { module sun { module star { module awt { 38 39//============================================================================= 40 41/** specifies the standard model of an <type>UnoControlSpinButton</type>. 42 43 <p>A spin button is a control which has a numeric value associated with it, 44 and allows to change this value using two spin buttons.</p> 45 46 <p>A spin button is similar to a scroll bar, but it usually has no 47 (own) visual representation of the associated value, but is used to propagate 48 it's value to other controls.</p> 49 50 @see UnoControlScrollBarModel 51 */ 52service UnoControlSpinButtonModel 53{ 54 service com::sun::star::awt::UnoControlModel; 55 56 //------------------------------------------------------------------------- 57 58 /** specifies the border style of the control. 59 60 <pre> 61 0: No border 62 1: 3D border 63 2: simple border 64 </pre> 65 */ 66 [property] short Border; 67 68 //------------------------------------------------------------------------- 69 70 /** specifies the color of the border, if present 71 72 <p>Not every border style (see <member>Border</member>) may support coloring. 73 For instance, usually a border with 3D effect will ignore the BorderColor setting.</p> 74 75 @since OpenOffice 2.0 76 */ 77 [optional, property] long BorderColor; 78 79 //------------------------------------------------------------------------- 80 81 /** determines whether the control is enabled or disabled. 82 */ 83 [property] boolean Enabled; 84 85 //------------------------------------------------------------------------- 86 87 /** specifies the help text of the control. 88 */ 89 [property] string HelpText; 90 91 //------------------------------------------------------------------------- 92 93 /** specifies the help URL of the control. 94 */ 95 [property] string HelpURL; 96 97 //------------------------------------------------------------------------- 98 99 /** specifies the increment by which the value is changed when using operating 100 the spin button. 101 */ 102 [property] long SpinIncrement; 103 104 //------------------------------------------------------------------------- 105 106 /** specifies the <type>ScrollBarOrientation</type> of the control. 107 */ 108 [property] long Orientation; 109 110 //------------------------------------------------------------------------- 111 112 /** specifies whether the control will be printed with the document. 113 */ 114 [property] boolean Printable; 115 116 //------------------------------------------------------------------------- 117 118 /** specifies the current value of the control. 119 */ 120 [property] long SpinValue; 121 122 //------------------------------------------------------------------------- 123 124 /** specifies the minimum value of the control. 125 */ 126 [property] long SpinValueMin; 127 128 //------------------------------------------------------------------------- 129 130 /** specifies the maximum value of the control. 131 */ 132 [property] long SpinValueMax; 133 134 //------------------------------------------------------------------------- 135 136 /** specifies the RGB color to be used for the control 137 */ 138 [property] com::sun::star::util::Color BackgroundColor; 139 140 //------------------------------------------------------------------------- 141 142 /** specifies the RGB color to be used when painting symbols which are 143 part of the control's appearance, such as the arrow buttons. 144 */ 145 [property] com::sun::star::util::Color SymbolColor; 146 147 //------------------------------------------------------------------------- 148 149 /** specifies whether the mouse should show repeating behaviour, i.e. 150 repeatedly trigger an action when keeping pressed. 151 */ 152 [property] boolean Repeat; 153 154 //------------------------------------------------------------------------- 155 156 /** specifies the mouse repeat delay, in milliseconds. 157 158 <p>When the user presses a mouse in a control area where this triggers 159 an action (such as spinning the value), then usual control implementations 160 allow to repeatedly trigger this action, without the need to release the 161 mouse button and to press it again. The delay between two such triggers 162 is specified with this property.</p> 163 */ 164 [property] long RepeatDelay; 165 166 /** defines how the mouse wheel can be used to scroll through the control's content. 167 168 <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property, 169 and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances 170 this is possible.</p> 171 */ 172 [optional, property] short MouseWheelBehavior; 173}; 174 175//============================================================================= 176 177}; }; }; }; 178 179#endif 180