offapi/com/sun/star/awt/UnoControlScrollBarModel.idl

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