summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/datatransfer/dnd/XAutoscroll.idl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
commited5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch)
tree7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/datatransfer/dnd/XAutoscroll.idl
parentInitial commit. (diff)
downloadlibreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.tar.xz
libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.zip
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/datatransfer/dnd/XAutoscroll.idl')
-rw-r--r--offapi/com/sun/star/datatransfer/dnd/XAutoscroll.idl77
1 files changed, 77 insertions, 0 deletions
diff --git a/offapi/com/sun/star/datatransfer/dnd/XAutoscroll.idl b/offapi/com/sun/star/datatransfer/dnd/XAutoscroll.idl
new file mode 100644
index 000000000..22f57420b
--- /dev/null
+++ b/offapi/com/sun/star/datatransfer/dnd/XAutoscroll.idl
@@ -0,0 +1,77 @@
+/* -*- 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_datatransfer_dnd_XAutoscroll_idl__
+#define __com_sun_star_datatransfer_dnd_XAutoscroll_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+
+module com { module sun { module star { module datatransfer { module dnd {
+
+/** Interface for autoscroll support.
+
+ <p>During Drag and Drop operations it is possible that a user may wish to drop the
+ subject of the operation on a region of a scrollable GUI control that is
+ not currently visible to the user.</p>
+
+ <p>In such situations it is desirable that the GUI control detect this and
+ institute a scroll operation in order to make obscured region(s) visible to
+ the user. This feature is known as autoscrolling.</p>
+
+ <p>If a GUI control is both an active DropTarget and is also scrollable,
+ it can receive notifications of autoscrolling gestures by the user from
+ the Drag and Drop system by implementing this interface.</p>
+
+ <p>An autoscrolling gesture is initiated by the user by keeping the drag
+ cursor motionless with a border region of the Component, referred to as
+ the "autoscrolling region", for a predefined period of time, this will
+ result in repeated scroll requests to the Component until the drag Cursor
+ resumes its motion. </p>
+*/
+
+published interface XAutoscroll: com::sun::star::uno::XInterface
+{
+ /** Notify the component to autoscroll.
+
+ @param cursorLocationX
+ X location of the cursor in pixel.
+
+ @param cursorLocationY
+ Y location of the cursor in pixel.
+ */
+
+ void autoscroll( [in] long cursorLocationX, [in] long cursorLocationY );
+
+ /** Returns the regions describing the autoscrolling region.
+
+ @returns
+ The regions describing the autoscrolling region or border
+ relative to the geometry of the implementing component.
+ */
+
+ any getAutoscrollRegion();
+};
+
+
+}; }; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */