summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/awt/UnoControlScrollBarModel.idl
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--offapi/com/sun/star/awt/UnoControlScrollBarModel.idl169
1 files changed, 169 insertions, 0 deletions
diff --git a/offapi/com/sun/star/awt/UnoControlScrollBarModel.idl b/offapi/com/sun/star/awt/UnoControlScrollBarModel.idl
new file mode 100644
index 000000000..662bf368c
--- /dev/null
+++ b/offapi/com/sun/star/awt/UnoControlScrollBarModel.idl
@@ -0,0 +1,169 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_awt_UnoControlScrollBarModel_idl__
+#define __com_sun_star_awt_UnoControlScrollBarModel_idl__
+
+#include <com/sun/star/awt/UnoControlModel.idl>
+#include <com/sun/star/util/Color.idl>
+
+
+
+ module com { module sun { module star { module awt {
+
+
+/** specifies the standard model of a UnoControlScrollBar.
+ */
+published service UnoControlScrollBarModel
+{
+ service com::sun::star::awt::UnoControlModel;
+
+
+ /** specifies the RGB color to be used for the control.
+
+ @since OOo 2.0
+ */
+ [optional, property] com::sun::star::util::Color BackgroundColor;
+
+
+ /** specifies the increment for a block move.
+ */
+ [property] long BlockIncrement;
+
+
+ /** specifies the border style of the control.
+
+ <pre>
+ 0: No border
+ 1: 3D border
+ 2: simple border
+ </pre>
+ */
+ [property] short Border;
+
+
+ /** specifies the color of the border, if present
+
+ <p>Not every border style (see #Border) may support coloring.
+ For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
+
+ @since OOo 2.0
+ */
+ [optional, property] long BorderColor;
+
+
+ /** determines whether the control is enabled or disabled.
+ */
+ [property] boolean Enabled;
+
+
+ /** specifies the help text of the control.
+ */
+ [property] string HelpText;
+
+
+ /** specifies the help URL of the control.
+ */
+ [property] string HelpURL;
+
+
+ /** specifies the increment for a single line move.
+ */
+ [property] long LineIncrement;
+
+
+ /** specifies the scrolling behavior of the control.
+
+ <p>`TRUE` means, that when the user moves the slider in the scroll bar,
+ the content of the window is updated immediately.
+ `FALSE` means, that the window is only updated after the user has
+ released the mouse button.</p>
+
+ @since OOo 2.0
+ */
+ [optional, property] boolean LiveScroll;
+
+
+ /** specifies the ScrollBarOrientation of the control.
+ */
+ [property] long Orientation;
+
+
+ /** specifies that the control will be printed with the document.
+ */
+ [property] boolean Printable;
+
+
+ /** specifies the mouse repeat delay, in milliseconds.
+
+ <p>When the user presses a mouse in a control area where this triggers
+ an action (such as scrolling the scrollbar), then usual control implementations
+ allow to repeatedly trigger this action, without the need to release the
+ mouse button and to press it again. The delay between two such triggers
+ is specified with this property.</p>
+
+ @since OOo 2.0
+ */
+ [optional, property] long RepeatDelay;
+
+
+ /** specifies the scroll value of the control.
+ */
+ [property] long ScrollValue;
+
+
+ /** specifies the minimum scroll value of the control.
+
+ <p>If this optional property is not present, clients of the component should assume
+ a minimal scroll value of 0.</p>
+ */
+ [optional, property] long ScrollValueMin;
+
+
+ /** specifies the maximum scroll value of the control.
+ */
+ [property] long ScrollValueMax;
+
+
+ /** specifies the RGB color to be used when painting symbols which are
+ part of the control's appearance, such as the arrow buttons.
+
+ @since OOo 2.0
+ */
+ [optional, property] com::sun::star::util::Color SymbolColor;
+
+
+ /** specifies that the control can be reached with the TAB key.
+
+ @since OOo 2.0
+ */
+ [optional, property] boolean Tabstop;
+
+
+ /** specifies the visible size of the scroll bar.
+ */
+ [property] long VisibleSize;
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */