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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /**
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_awt_UnoControlScrollBarModel_idl__
  20 #define __com_sun_star_awt_UnoControlScrollBarModel_idl__
  21
  22 #include <com/sun/star/awt/UnoControlModel.idl>
  23 #include <com/sun/star/util/Color.idl>
  24
  25
  26
  27  module com {  module sun {  module star {  module awt {
  28
  29
  30 /** specifies the standard model of an <type>UnoControlScrollBar</type>.
  31  */
  32 published service UnoControlScrollBarModel
  33 {
  34     service com::sun::star::awt::UnoControlModel;
  35
  36
  37     /** specifies the RGB color to be used for the control.
  38
  39         @since OOo 2.0
  40      */
  41     [optional, property] com::sun::star::util::Color BackgroundColor;
  42
  43
  44     /** specifies the increment for a block move.
  45      */
  46     [property] long BlockIncrement;
  47
  48
  49     /** specifies the border style of the control.
  50
  51         <pre>
  52         0: No border
  53         1: 3D border
  54         2: simple border
  55         </pre>
  56      */
  57     [property] short Border;
  58
  59
  60     /** specifies the color of the border, if present
  61
  62         <p>Not every border style (see <member>Border</member>) may support coloring.
  63         For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
  64
  65         @since OOo 2.0
  66      */
  67     [optional, property] long BorderColor;
  68
  69
  70     /** determines whether the control is enabled or disabled.
  71      */
  72     [property] boolean Enabled;
  73
  74
  75     /** specifies the help text of the control.
  76      */
  77     [property] string HelpText;
  78
  79
  80     /** specifies the help URL of the control.
  81      */
  82     [property] string HelpURL;
  83
  84
  85     /** specifies the increment for a single line move.
  86      */
  87     [property] long LineIncrement;
  88
  89
  90     /** specifies the scrolling behavior of the control.
  91
  92         <p><TRUE/> means, that when the user moves the slider in the scroll bar,
  93         the content of the window is updated immediately.
  94         <FALSE/> means, that the window is only updated after the user has
  95         released the mouse button.</p>
  96
  97         @since OOo 2.0
  98      */
  99     [optional, property] boolean LiveScroll;
 100
 101
 102     /** specifies the <type>ScrollBarOrientation</type> of the control.
 103      */
 104     [property] long Orientation;
 105
 106
 107     /** specifies that the control will be printed with the document.
 108      */
 109     [property] boolean Printable;
 110
 111
 112     /** specifies the mouse repeat delay, in milliseconds.
 113
 114         <p>When the user presses a mouse in a control area where this triggers
 115         an action (such as scrolling the scrollbar), then usual control implementations
 116         allow to repeatedly trigger this action, without the need to release the
 117         mouse button and to press it again. The delay between two such triggers
 118         is specified with this property.</p>
 119
 120         @since OOo 2.0
 121      */
 122     [optional, property] long RepeatDelay;
 123
 124
 125     /** specifies the scroll value of the control.
 126      */
 127     [property] long ScrollValue;
 128
 129
 130     /** specifies the minimum scroll value of the control.
 131
 132         <p>If this optional property is not present, clients of the component should assume
 133         a minimal scroll value of 0.</p>
 134     */
 135     [optional, property] long ScrollValueMin;
 136
 137
 138     /** specifies the maximum scroll value of the control.
 139      */
 140     [property] long ScrollValueMax;
 141
 142
 143     /** specifies the RGB color to be used when painting symbols which are
 144         part of the control's appearance, such as the arrow buttons.
 145
 146         @since OOo 2.0
 147      */
 148     [optional, property] com::sun::star::util::Color SymbolColor;
 149
 150
 151     /** specifies that the control can be reached with the TAB key.
 152
 153         @since OOo 2.0
 154      */
 155     [optional, property] boolean Tabstop;
 156
 157
 158     /** specifies the visible size of the scroll bar.
 159      */
 160     [property] long VisibleSize;
 161
 162 };
 163
 164
 165 }; }; }; };
 166
 167 #endif
 168
 169 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */