1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_awt_UnoControlScrollBarModel_idl__ 28#define __com_sun_star_awt_UnoControlScrollBarModel_idl__ 29 30#ifndef __com_sun_star_awt_UnoControlModel_idl__ 31#include <com/sun/star/awt/UnoControlModel.idl> 32#endif 33 34#ifndef __com_sun_star_util_Color_idl__ 35#include <com/sun/star/util/Color.idl> 36#endif 37 38 39//============================================================================= 40 41 module com { module sun { module star { module awt { 42 43//============================================================================= 44 45/** specifies the standard model of an <type>UnoControlScrollBar</type>. 46 */ 47published service UnoControlScrollBarModel 48{ 49 service com::sun::star::awt::UnoControlModel; 50 51 //------------------------------------------------------------------------- 52 53 /** specifies the RGB color to be used for the control. 54 55 @since OOo 2.0 56 */ 57 [optional, property] com::sun::star::util::Color BackgroundColor; 58 59 //------------------------------------------------------------------------- 60 61 /** specifies the increment for a block move. 62 */ 63 [property] long BlockIncrement; 64 65 //------------------------------------------------------------------------- 66 67 /** specifies the border style of the control. 68 69 <pre> 70 0: No border 71 1: 3D border 72 2: simple border 73 </pre> 74 */ 75 [property] short Border; 76 77 //------------------------------------------------------------------------- 78 79 /** specifies the color of the border, if present 80 81 <p>Not every border style (see <member>Border</member>) may support coloring. 82 For instance, usually a border with 3D effect will ignore the BorderColor setting.</p> 83 84 @since OOo 2.0 85 */ 86 [optional, property] long BorderColor; 87 88 //------------------------------------------------------------------------- 89 90 /** determines whether the control is enabled or disabled. 91 */ 92 [property] boolean Enabled; 93 94 //------------------------------------------------------------------------- 95 96 /** specifies the help text of the control. 97 */ 98 [property] string HelpText; 99 100 //------------------------------------------------------------------------- 101 102 /** specifies the help URL of the control. 103 */ 104 [property] string HelpURL; 105 106 //------------------------------------------------------------------------- 107 108 /** specifies the increment for a single line move. 109 */ 110 [property] long LineIncrement; 111 112 //------------------------------------------------------------------------- 113 114 /** specifies the scrolling behaviour of the control. 115 116 <p><TRUE/> means, that when the user moves the slider in the scroll bar, 117 the content of the window is updated immediately. 118 <FALSE/> means, that the window is only updated after the user has 119 released the mouse button.</p> 120 121 @since OOo 2.0 122 */ 123 [optional, property] boolean LiveScroll; 124 125 //------------------------------------------------------------------------- 126 127 /** specifies the <type>ScrollBarOrientation</type> of the control. 128 */ 129 [property] long Orientation; 130 131 //------------------------------------------------------------------------- 132 133 /** specifies that the control will be printed with the document. 134 */ 135 [property] boolean Printable; 136 137 //------------------------------------------------------------------------- 138 139 /** specifies the mouse repeat delay, in milliseconds. 140 141 <p>When the user presses a mouse in a control area where this triggers 142 an action (such as scrolling the scrollbar), then usual control implementations 143 allow to repeatedly trigger this action, without the need to release the 144 mouse button and to press it again. The delay between two such triggers 145 is specified with this property.</p> 146 147 @since OOo 2.0 148 */ 149 [optional, property] long RepeatDelay; 150 151 //------------------------------------------------------------------------- 152 153 /** specifies the scroll value of the control. 154 */ 155 [property] long ScrollValue; 156 157 //------------------------------------------------------------------------- 158 159 /** specifies the minimum scroll value of the control. 160 161 <p>If this optional property is not present, clients of the component should assume 162 a minimal scroll value of 0.</p> 163 */ 164 [optional, property] long ScrollValueMin; 165 166 //------------------------------------------------------------------------- 167 168 /** specifies the maximum scroll value of the control. 169 */ 170 [property] long ScrollValueMax; 171 172 //------------------------------------------------------------------------- 173 174 /** specifies the RGB color to be used when painting symbols which are 175 part of the control's appearance, such as the arrow buttons. 176 177 @since OOo 2.0 178 */ 179 [optional, property] com::sun::star::util::Color SymbolColor; 180 181 //------------------------------------------------------------------------- 182 183 /** specifies that the control can be reached with the TAB key. 184 185 @since OOo 2.0 186 */ 187 [optional, property] boolean Tabstop; 188 189 //------------------------------------------------------------------------- 190 191 /** specifies the visible size of the scroll bar. 192 */ 193 [property] long VisibleSize; 194 195}; 196 197//============================================================================= 198 199}; }; }; }; 200 201#endif 202