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
  20
  21
  22  module com {  module sun {  module star {  module awt {
  23
  24
  25 /** specifies the standard model of a UnoControlScrollBar.
  26  */
  27 published service UnoControlScrollBarModel
  28 {
  29     service com::sun::star::awt::UnoControlModel;
  30
  31
  32     /** specifies the RGB color to be used for the control.
  33
  34         @since OOo 2.0
  35      */
  36     [optional, property] com::sun::star::util::Color BackgroundColor;
  37
  38
  39     /** specifies the increment for a block move.
  40      */
  41     [property] long BlockIncrement;
  42
  43
  44     /** specifies the border style of the control.
  45
  46         <pre>
  47         0: No border
  48         1: 3D border
  49         2: simple border
  50         </pre>
  51      */
  52     [property] short Border;
  53
  54
  55     /** specifies the color of the border, if present
  56
  57         <p>Not every border style (see #Border) may support coloring.
  58         For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
  59
  60         @since OOo 2.0
  61      */
  62     [optional, property] long BorderColor;
  63
  64
  65     /** determines whether the control is enabled or disabled.
  66      */
  67     [property] boolean Enabled;
  68
  69
  70     /** specifies the help text of the control.
  71      */
  72     [property] string HelpText;
  73
  74
  75     /** specifies the help URL of the control.
  76      */
  77     [property] string HelpURL;
  78
  79
  80     /** specifies the increment for a single line move.
  81      */
  82     [property] long LineIncrement;
  83
  84
  85     /** specifies the scrolling behavior of the control.
  86
  87         <p>`TRUE` means, that when the user moves the slider in the scroll bar,
  88         the content of the window is updated immediately.
  89         `FALSE` means, that the window is only updated after the user has
  90         released the mouse button.</p>
  91
  92         @since OOo 2.0
  93      */
  94     [optional, property] boolean LiveScroll;
  95
  96
  97     /** specifies the ScrollBarOrientation of the control.
  98      */
  99     [property] long Orientation;
 100
 101
 102     /** specifies that the control will be printed with the document.
 103      */
 104     [property] boolean Printable;
 105
 106
 107     /** specifies the mouse repeat delay, in milliseconds.
 108
 109         <p>When the user presses a mouse in a control area where this triggers
 110         an action (such as scrolling the scrollbar), then usual control implementations
 111         allow to repeatedly trigger this action, without the need to release the
 112         mouse button and to press it again. The delay between two such triggers
 113         is specified with this property.</p>
 114
 115         @since OOo 2.0
 116      */
 117     [optional, property] long RepeatDelay;
 118
 119
 120     /** specifies the scroll value of the control.
 121      */
 122     [property] long ScrollValue;
 123
 124
 125     /** specifies the minimum scroll value of the control.
 126
 127         <p>If this optional property is not present, clients of the component should assume
 128         a minimal scroll value of 0.</p>
 129     */
 130     [optional, property] long ScrollValueMin;
 131
 132
 133     /** specifies the maximum scroll value of the control.
 134      */
 135     [property] long ScrollValueMax;
 136
 137
 138     /** specifies the RGB color to be used when painting symbols which are
 139         part of the control's appearance, such as the arrow buttons.
 140
 141         @since OOo 2.0
 142      */
 143     [optional, property] com::sun::star::util::Color SymbolColor;
 144
 145
 146     /** specifies that the control can be reached with the TAB key.
 147
 148         @since OOo 2.0
 149      */
 150     [optional, property] boolean Tabstop;
 151
 152
 153     /** specifies the visible size of the scroll bar.
 154      */
 155     [property] long VisibleSize;
 156
 157 };
 158
 159
 160 }; }; }; };
 161
 162 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */