@itwin/appui-react 4.0.0-dev.8 → 4.0.0

package/lib/esm/appui-react/content/split-pane/SplitPane.js

@@ -1,239 +1,239 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module ContentView
- */
-import * as React from "react";
-import classnames from "classnames";
-import { Pane } from "./Pane";
-import { Resizer } from "./Resizer";
-function unFocus(ownerDoc) {
-    var _a;
-    // istanbul ignore next
-    if (!ownerDoc)
-        return;
-    const docSelection = ownerDoc.getSelection();
-    // istanbul ignore else
-    if (docSelection) {
-        docSelection.empty();
-    }
-    else {
-        // istanbul ignore next
-        try {
-            const winSelection = (_a = ownerDoc.defaultView) === null || _a === void 0 ? void 0 : _a.getSelection();
-            winSelection === null || winSelection === void 0 ? void 0 : winSelection.removeAllRanges();
-        }
-        catch (_e) { }
-    }
-}
-function getDefaultSize(defaultSize, minSize, maxSize, draggedSize) {
-    // istanbul ignore next
-    if (typeof draggedSize === "number") {
-        const min = typeof minSize === "number" ? minSize : 0;
-        const max = typeof maxSize === "number" && maxSize >= 0 ? maxSize : Infinity;
-        return Math.max(min, Math.min(max, draggedSize));
-    }
-    if (defaultSize !== undefined) {
-        return defaultSize;
-    }
-    return minSize;
-}
-function removeNullChildren(children) {
-    return React.Children.toArray(children).filter((c) => c);
-}
-/**
- * Local TypeScript implementation of `SplitPane` from `react-split-pane` package since that
- * package is not regularly maintained.
- * See https://github.com/tomkp/react-split-pane/blob/master/LICENSE.
- * @public
- */
-export function SplitPane(props) {
-    const { style, size, defaultSize, maxSize, children, paneStyle, pane1Style, pane2Style, className, paneClassName, pane1ClassName, pane2ClassName, onDragStarted, onDragFinished, step, onChange, onResizerClick, onResizerDoubleClick, } = props;
-    // honor same defaults as react-split-pane
-    const allowResize = React.useMemo(() => undefined !== props.allowResize ? props.allowResize : true, [props.allowResize]);
-    const minSize = React.useMemo(() => undefined !== props.minSize ? props.minSize : 50, [props.minSize]);
-    const primary = React.useMemo(() => undefined !== props.primary ? props.primary : "first", [props.primary]);
-    const split = React.useMemo(() => undefined !== props.split ? props.split : "vertical", [props.split]);
-    const initialSize = size !== undefined ? size : getDefaultSize(defaultSize, minSize, maxSize);
-    const [position, setPosition] = React.useState(0);
-    const [draggedSize, setDraggedSize] = React.useState();
-    const [active, setActive] = React.useState(false);
-    const [pane1Size, setPane1Size] = React.useState(() => primary === "first" ? initialSize : undefined);
-    const [pane2Size, setPane2Size] = React.useState(() => primary === "second" ? initialSize : undefined);
-    const splitPane = React.useRef(null);
-    const pane1 = React.useRef(null);
-    const pane2 = React.useRef(null);
-    const notNullChildren = React.useMemo(() => removeNullChildren(children), [children]);
-    React.useEffect(() => {
-        primary === "first" ? setPane1Size(initialSize) : setPane2Size(initialSize);
-        primary === "first" ? setPane2Size(undefined) : setPane1Size(undefined);
-    }, [initialSize, primary]);
-    const splitPaneStyle = React.useMemo(() => {
-        const directionSpecificParts = (split === "vertical") ? {
-            flexDirection: "row",
-            left: 0,
-            right: 0,
-        } : {
-            bottom: 0,
-            flexDirection: "column",
-            minHeight: "100%",
-            top: 0,
-            width: "100%",
-        };
-        return {
-            display: "flex",
-            flex: 1,
-            height: "100%",
-            position: "absolute",
-            outline: "none",
-            overflow: "hidden",
-            MozUserSelect: "text",
-            WebkitUserSelect: "text",
-            msUserSelect: "text",
-            userSelect: "text",
-            ...style,
-            ...directionSpecificParts,
-        };
-    }, [split, style]);
-    const pane1DivStyle = { ...paneStyle, ...pane1Style };
-    const pane2DivStyle = { ...paneStyle, ...pane2Style };
-    const resizerStyle = React.useMemo(() => { var _a; return (_a = props.resizerStyle) !== null && _a !== void 0 ? _a : {}; }, [props.resizerStyle]);
-    const resizerClasses = React.useMemo(() => classnames("Resizer", !allowResize && "disabled"), [allowResize]);
-    const splitPaneClasses = React.useMemo(() => classnames("SplitPane", className, split, !allowResize && "disabled"), [className, split, allowResize]);
-    const pane1Classes = React.useMemo(() => classnames("Pane1", paneClassName, pane1ClassName), [paneClassName, pane1ClassName]);
-    const pane2Classes = React.useMemo(() => classnames("Pane2", paneClassName, pane2ClassName), [paneClassName, pane2ClassName]);
-    const initializeDrag = React.useCallback((x, y) => {
-        var _a;
-        // istanbul ignore next
-        unFocus((_a = splitPane.current) === null || _a === void 0 ? void 0 : _a.ownerDocument);
-        const newPosition = split === "vertical" ? x : y;
-        onDragStarted && onDragStarted();
-        setActive(true);
-        setPosition(newPosition);
-    }, [onDragStarted, split]);
-    const onTouchStart = React.useCallback((event) => {
-        // istanbul ignore else
-        if (allowResize) {
-            initializeDrag(event.touches[0].clientX, event.touches[0].clientY);
-        }
-    }, [allowResize, initializeDrag]);
-    const processMove = React.useCallback((x, y) => {
-        var _a, _b, _c, _d, _f, _g, _h;
-        // istanbul ignore next
-        unFocus((_a = splitPane.current) === null || _a === void 0 ? void 0 : _a.ownerDocument);
-        const isPrimaryFirst = primary === "first";
-        const ref = isPrimaryFirst ? pane1.current : pane2.current;
-        const ref2 = isPrimaryFirst ? pane2.current : pane1.current;
-        const splitPaneDiv = splitPane.current;
-        // istanbul ignore else
-        if (ref && ref2 && splitPaneDiv) {
-            const node = ref;
-            const node2 = ref2;
-            // istanbul ignore else
-            if (node.getBoundingClientRect) {
-                const width = node.getBoundingClientRect().width;
-                const height = node.getBoundingClientRect().height;
-                // istanbul ignore next
-                const current = split === "vertical" ? x : y;
-                // istanbul ignore next
-                const oldSize = split === "vertical" ? width : height;
-                let positionDelta = position - current;
-                if (step) {
-                    // istanbul ignore next
-                    if (Math.abs(positionDelta) < step) {
-                        return;
-                    }
-                    // Integer division
-                    // eslint-disable-next-line no-bitwise
-                    positionDelta = ~~(positionDelta / step) * step;
-                }
-                let sizeDelta = isPrimaryFirst ? positionDelta : -positionDelta;
-                // istanbul ignore next
-                const pane1Order = parseInt((_d = (_c = (_b = node.ownerDocument) === null || _b === void 0 ? void 0 : _b.defaultView) === null || _c === void 0 ? void 0 : _c.getComputedStyle(node).order) !== null && _d !== void 0 ? _d : "0", 10);
-                // istanbul ignore next
-                const pane2Order = parseInt((_h = (_g = (_f = node2.ownerDocument) === null || _f === void 0 ? void 0 : _f.defaultView) === null || _g === void 0 ? void 0 : _g.getComputedStyle(node2).order) !== null && _h !== void 0 ? _h : "0", 10);
-                // istanbul ignore next
-                if (pane1Order > pane2Order) {
-                    sizeDelta = -sizeDelta;
-                }
-                let newMaxSize = maxSize;
-                // istanbul ignore next
-                if (typeof maxSize === "number" && maxSize !== undefined && maxSize <= 0) {
-                    if (split === "vertical") {
-                        newMaxSize = splitPaneDiv.getBoundingClientRect().width + maxSize;
-                    }
-                    else {
-                        newMaxSize = splitPaneDiv.getBoundingClientRect().height + maxSize;
-                    }
-                }
-                let newSize = oldSize - sizeDelta;
-                const newPosition = position - positionDelta;
-                // istanbul ignore next
-                if (typeof minSize === "number" && newSize < minSize) {
-                    newSize = minSize;
-                }
-                else if (typeof newMaxSize === "number" && newMaxSize !== undefined && newSize > newMaxSize) {
-                    newSize = newMaxSize;
-                }
-                else {
-                    setPosition(newPosition);
-                }
-                onChange && onChange(newSize);
-                setDraggedSize(newSize);
-                isPrimaryFirst ? setPane1Size(newSize) : setPane2Size(newSize);
-            }
-        }
-    }, [maxSize, minSize, onChange, position, primary, split, step]);
-    const onTouchMove = React.useCallback((event) => {
-        // istanbul ignore next
-        if (!allowResize || !active)
-            return;
-        processMove(event.touches[0].clientX, event.touches[0].clientY);
-    }, [active, allowResize, processMove]);
-    const onMouseMove = React.useCallback((event) => {
-        if (!allowResize || !active)
-            return;
-        processMove(event.clientX, event.clientY);
-    }, [active, allowResize, processMove]);
-    const onMouseDown = React.useCallback((event) => {
-        // istanbul ignore else
-        if (allowResize) {
-            event.preventDefault();
-            initializeDrag(event.clientX, event.clientY);
-        }
-    }, [allowResize, initializeDrag]);
-    const processResizeFinished = React.useCallback(() => {
-        // istanbul ignore else
-        if (undefined !== draggedSize && allowResize && active) {
-            onDragFinished && onDragFinished(draggedSize);
-        }
-        setActive(false);
-    }, [draggedSize, allowResize, active, onDragFinished]);
-    const onMouseUp = React.useCallback((event) => {
-        event.preventDefault();
-        processResizeFinished();
-    }, [processResizeFinished]);
-    React.useEffect(() => {
-        var _a;
-        // istanbul ignore next
-        const ownerDoc = (_a = splitPane.current) === null || _a === void 0 ? void 0 : _a.ownerDocument;
-        // istanbul ignore next
-        if (!ownerDoc)
-            return;
-        ownerDoc.addEventListener("mouseup", onMouseUp);
-        ownerDoc.addEventListener("mousemove", onMouseMove);
-        ownerDoc.addEventListener("touchmove", onTouchMove);
-        return () => {
-            ownerDoc.removeEventListener("mouseup", onMouseUp);
-            ownerDoc.removeEventListener("mousemove", onMouseMove);
-            ownerDoc.removeEventListener("touchmove", onTouchMove);
-        };
-    }, [onMouseMove, onMouseUp, onTouchMove]);
-    return (React.createElement("div", { className: splitPaneClasses, ref: splitPane, style: splitPaneStyle },
-        React.createElement(Pane, { className: pane1Classes, key: "pane1", eleRef: pane1, size: pane1Size, split: split, style: pane1DivStyle }, notNullChildren[0]),
-        React.createElement(Resizer, { className: resizerClasses, onClick: onResizerClick, onDoubleClick: onResizerDoubleClick, onMouseDown: onMouseDown, onTouchStart: onTouchStart, onTouchEnd: processResizeFinished, key: "resizer", split: split, style: resizerStyle }),
-        React.createElement(Pane, { className: pane2Classes, key: "pane2", eleRef: pane2, size: pane2Size, split: split, style: pane2DivStyle }, notNullChildren[1])));
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module ContentView
+ */
+import * as React from "react";
+import classnames from "classnames";
+import { Pane } from "./Pane";
+import { Resizer } from "./Resizer";
+function unFocus(ownerDoc) {
+    var _a;
+    // istanbul ignore next
+    if (!ownerDoc)
+        return;
+    const docSelection = ownerDoc.getSelection();
+    // istanbul ignore else
+    if (docSelection) {
+        docSelection.empty();
+    }
+    else {
+        // istanbul ignore next
+        try {
+            const winSelection = (_a = ownerDoc.defaultView) === null || _a === void 0 ? void 0 : _a.getSelection();
+            winSelection === null || winSelection === void 0 ? void 0 : winSelection.removeAllRanges();
+        }
+        catch (_e) { }
+    }
+}
+function getDefaultSize(defaultSize, minSize, maxSize, draggedSize) {
+    // istanbul ignore next
+    if (typeof draggedSize === "number") {
+        const min = typeof minSize === "number" ? minSize : 0;
+        const max = typeof maxSize === "number" && maxSize >= 0 ? maxSize : Infinity;
+        return Math.max(min, Math.min(max, draggedSize));
+    }
+    if (defaultSize !== undefined) {
+        return defaultSize;
+    }
+    return minSize;
+}
+function removeNullChildren(children) {
+    return React.Children.toArray(children).filter((c) => c);
+}
+/**
+ * Local TypeScript implementation of `SplitPane` from `react-split-pane` package since that
+ * package is not regularly maintained.
+ * See https://github.com/tomkp/react-split-pane/blob/master/LICENSE.
+ * @public
+ */
+export function SplitPane(props) {
+    const { style, size, defaultSize, maxSize, children, paneStyle, pane1Style, pane2Style, className, paneClassName, pane1ClassName, pane2ClassName, onDragStarted, onDragFinished, step, onChange, onResizerClick, onResizerDoubleClick, } = props;
+    // honor same defaults as react-split-pane
+    const allowResize = React.useMemo(() => undefined !== props.allowResize ? props.allowResize : true, [props.allowResize]);
+    const minSize = React.useMemo(() => undefined !== props.minSize ? props.minSize : 50, [props.minSize]);
+    const primary = React.useMemo(() => undefined !== props.primary ? props.primary : "first", [props.primary]);
+    const split = React.useMemo(() => undefined !== props.split ? props.split : "vertical", [props.split]);
+    const initialSize = size !== undefined ? size : getDefaultSize(defaultSize, minSize, maxSize);
+    const [position, setPosition] = React.useState(0);
+    const [draggedSize, setDraggedSize] = React.useState();
+    const [active, setActive] = React.useState(false);
+    const [pane1Size, setPane1Size] = React.useState(() => primary === "first" ? initialSize : undefined);
+    const [pane2Size, setPane2Size] = React.useState(() => primary === "second" ? initialSize : undefined);
+    const splitPane = React.useRef(null);
+    const pane1 = React.useRef(null);
+    const pane2 = React.useRef(null);
+    const notNullChildren = React.useMemo(() => removeNullChildren(children), [children]);
+    React.useEffect(() => {
+        primary === "first" ? setPane1Size(initialSize) : setPane2Size(initialSize);
+        primary === "first" ? setPane2Size(undefined) : setPane1Size(undefined);
+    }, [initialSize, primary]);
+    const splitPaneStyle = React.useMemo(() => {
+        const directionSpecificParts = (split === "vertical") ? {
+            flexDirection: "row",
+            left: 0,
+            right: 0,
+        } : {
+            bottom: 0,
+            flexDirection: "column",
+            minHeight: "100%",
+            top: 0,
+            width: "100%",
+        };
+        return {
+            display: "flex",
+            flex: 1,
+            height: "100%",
+            position: "absolute",
+            outline: "none",
+            overflow: "hidden",
+            MozUserSelect: "text",
+            WebkitUserSelect: "text",
+            msUserSelect: "text",
+            userSelect: "text",
+            ...style,
+            ...directionSpecificParts,
+        };
+    }, [split, style]);
+    const pane1DivStyle = { ...paneStyle, ...pane1Style };
+    const pane2DivStyle = { ...paneStyle, ...pane2Style };
+    const resizerStyle = React.useMemo(() => { var _a; return (_a = props.resizerStyle) !== null && _a !== void 0 ? _a : {}; }, [props.resizerStyle]);
+    const resizerClasses = React.useMemo(() => classnames("Resizer", !allowResize && "disabled"), [allowResize]);
+    const splitPaneClasses = React.useMemo(() => classnames("SplitPane", className, split, !allowResize && "disabled"), [className, split, allowResize]);
+    const pane1Classes = React.useMemo(() => classnames("Pane1", paneClassName, pane1ClassName), [paneClassName, pane1ClassName]);
+    const pane2Classes = React.useMemo(() => classnames("Pane2", paneClassName, pane2ClassName), [paneClassName, pane2ClassName]);
+    const initializeDrag = React.useCallback((x, y) => {
+        var _a;
+        // istanbul ignore next
+        unFocus((_a = splitPane.current) === null || _a === void 0 ? void 0 : _a.ownerDocument);
+        const newPosition = split === "vertical" ? x : y;
+        onDragStarted && onDragStarted();
+        setActive(true);
+        setPosition(newPosition);
+    }, [onDragStarted, split]);
+    const onTouchStart = React.useCallback((event) => {
+        // istanbul ignore else
+        if (allowResize) {
+            initializeDrag(event.touches[0].clientX, event.touches[0].clientY);
+        }
+    }, [allowResize, initializeDrag]);
+    const processMove = React.useCallback((x, y) => {
+        var _a, _b, _c, _d, _f, _g, _h;
+        // istanbul ignore next
+        unFocus((_a = splitPane.current) === null || _a === void 0 ? void 0 : _a.ownerDocument);
+        const isPrimaryFirst = primary === "first";
+        const ref = isPrimaryFirst ? pane1.current : pane2.current;
+        const ref2 = isPrimaryFirst ? pane2.current : pane1.current;
+        const splitPaneDiv = splitPane.current;
+        // istanbul ignore else
+        if (ref && ref2 && splitPaneDiv) {
+            const node = ref;
+            const node2 = ref2;
+            // istanbul ignore else
+            if (node.getBoundingClientRect) {
+                const width = node.getBoundingClientRect().width;
+                const height = node.getBoundingClientRect().height;
+                // istanbul ignore next
+                const current = split === "vertical" ? x : y;
+                // istanbul ignore next
+                const oldSize = split === "vertical" ? width : height;
+                let positionDelta = position - current;
+                if (step) {
+                    // istanbul ignore next
+                    if (Math.abs(positionDelta) < step) {
+                        return;
+                    }
+                    // Integer division
+                    // eslint-disable-next-line no-bitwise
+                    positionDelta = ~~(positionDelta / step) * step;
+                }
+                let sizeDelta = isPrimaryFirst ? positionDelta : -positionDelta;
+                // istanbul ignore next
+                const pane1Order = parseInt((_d = (_c = (_b = node.ownerDocument) === null || _b === void 0 ? void 0 : _b.defaultView) === null || _c === void 0 ? void 0 : _c.getComputedStyle(node).order) !== null && _d !== void 0 ? _d : "0", 10);
+                // istanbul ignore next
+                const pane2Order = parseInt((_h = (_g = (_f = node2.ownerDocument) === null || _f === void 0 ? void 0 : _f.defaultView) === null || _g === void 0 ? void 0 : _g.getComputedStyle(node2).order) !== null && _h !== void 0 ? _h : "0", 10);
+                // istanbul ignore next
+                if (pane1Order > pane2Order) {
+                    sizeDelta = -sizeDelta;
+                }
+                let newMaxSize = maxSize;
+                // istanbul ignore next
+                if (typeof maxSize === "number" && maxSize !== undefined && maxSize <= 0) {
+                    if (split === "vertical") {
+                        newMaxSize = splitPaneDiv.getBoundingClientRect().width + maxSize;
+                    }
+                    else {
+                        newMaxSize = splitPaneDiv.getBoundingClientRect().height + maxSize;
+                    }
+                }
+                let newSize = oldSize - sizeDelta;
+                const newPosition = position - positionDelta;
+                // istanbul ignore next
+                if (typeof minSize === "number" && newSize < minSize) {
+                    newSize = minSize;
+                }
+                else if (typeof newMaxSize === "number" && newMaxSize !== undefined && newSize > newMaxSize) {
+                    newSize = newMaxSize;
+                }
+                else {
+                    setPosition(newPosition);
+                }
+                onChange && onChange(newSize);
+                setDraggedSize(newSize);
+                isPrimaryFirst ? setPane1Size(newSize) : setPane2Size(newSize);
+            }
+        }
+    }, [maxSize, minSize, onChange, position, primary, split, step]);
+    const onTouchMove = React.useCallback((event) => {
+        // istanbul ignore next
+        if (!allowResize || !active)
+            return;
+        processMove(event.touches[0].clientX, event.touches[0].clientY);
+    }, [active, allowResize, processMove]);
+    const onMouseMove = React.useCallback((event) => {
+        if (!allowResize || !active)
+            return;
+        processMove(event.clientX, event.clientY);
+    }, [active, allowResize, processMove]);
+    const onMouseDown = React.useCallback((event) => {
+        // istanbul ignore else
+        if (allowResize) {
+            event.preventDefault();
+            initializeDrag(event.clientX, event.clientY);
+        }
+    }, [allowResize, initializeDrag]);
+    const processResizeFinished = React.useCallback(() => {
+        // istanbul ignore else
+        if (undefined !== draggedSize && allowResize && active) {
+            onDragFinished && onDragFinished(draggedSize);
+        }
+        setActive(false);
+    }, [draggedSize, allowResize, active, onDragFinished]);
+    const onMouseUp = React.useCallback((event) => {
+        event.preventDefault();
+        processResizeFinished();
+    }, [processResizeFinished]);
+    React.useEffect(() => {
+        var _a;
+        // istanbul ignore next
+        const ownerDoc = (_a = splitPane.current) === null || _a === void 0 ? void 0 : _a.ownerDocument;
+        // istanbul ignore next
+        if (!ownerDoc)
+            return;
+        ownerDoc.addEventListener("mouseup", onMouseUp);
+        ownerDoc.addEventListener("mousemove", onMouseMove);
+        ownerDoc.addEventListener("touchmove", onTouchMove);
+        return () => {
+            ownerDoc.removeEventListener("mouseup", onMouseUp);
+            ownerDoc.removeEventListener("mousemove", onMouseMove);
+            ownerDoc.removeEventListener("touchmove", onTouchMove);
+        };
+    }, [onMouseMove, onMouseUp, onTouchMove]);
+    return (React.createElement("div", { className: splitPaneClasses, ref: splitPane, style: splitPaneStyle },
+        React.createElement(Pane, { className: pane1Classes, key: "pane1", eleRef: pane1, size: pane1Size, split: split, style: pane1DivStyle }, notNullChildren[0]),
+        React.createElement(Resizer, { className: resizerClasses, onClick: onResizerClick, onDoubleClick: onResizerDoubleClick, onMouseDown: onMouseDown, onTouchStart: onTouchStart, onTouchEnd: processResizeFinished, key: "resizer", split: split, style: resizerStyle }),
+        React.createElement(Pane, { className: pane2Classes, key: "pane2", eleRef: pane2, size: pane2Size, split: split, style: pane2DivStyle }, notNullChildren[1])));
+}
 //# sourceMappingURL=SplitPane.js.map

package/lib/esm/appui-react/cursor/CursorInformation.d.ts

@@ -1,69 +1,69 @@
-/** @packageDocumentation
- * @module Cursor
- */
-import { PointProps, RelativePosition, UiEvent } from "@itwin/appui-abstract";
-/** Enum for Cursor Direction parts
- *  @public
- */
-export declare enum CursorDirectionParts {
-    Top = 4096,
-    Left = 256,
-    Right = 16,
-    Bottom = 1
-}
-/** Enum for Cursor Direction
- * @public
- */
-export declare enum CursorDirection {
-    None = 0,
-    Top = 4096,
-    Left = 256,
-    Right = 16,
-    Bottom = 1,
-    TopLeft = 4352,
-    TopRight = 4112,
-    BottomLeft = 257,
-    BottomRight = 17
-}
-/** Cursor Updated Event Args interface.
- * @public
- */
-export interface CursorUpdatedEventArgs {
-    oldPt: PointProps;
-    newPt: PointProps;
-    direction: CursorDirection;
-}
-/** Cursor Updated Event class.
- * @public
- */
-export declare class CursorUpdatedEvent extends UiEvent<CursorUpdatedEventArgs> {
-}
-/** Cursor Information class
- * @public
- */
-export declare class CursorInformation {
-    private static _cursorPosition;
-    private static _cursorDirection;
-    private static _cursorDirections;
-    /** The cursor position. */
-    static get cursorPosition(): PointProps;
-    static set cursorPosition(pt: PointProps);
-    /** Gets the cursor X position. */
-    static get cursorX(): number;
-    /** Gets the cursor Y position. */
-    static get cursorY(): number;
-    /** Gets the general cursor movement direction. */
-    static get cursorDirection(): CursorDirection;
-    /** Gets the [[CursorUpdatedEvent]]. */
-    static readonly onCursorUpdatedEvent: CursorUpdatedEvent;
-    /** Handles the mouse movement.  Sets the cursor position and direction and emits onCursorUpdatedEvent. */
-    static handleMouseMove(point: PointProps): void;
-    private static _determineMostFrequentDirection;
-    private static _mostFrequent;
-    private static _determineCursorDirection;
-    /** Gets the relative position based on the cursor direction. */
-    static getRelativePositionFromCursorDirection(cursorDirection: CursorDirection): RelativePosition;
-    /** @internal - for testing */
-    static clearCursorDirections(): void;
-}
+/** @packageDocumentation
+ * @module Cursor
+ */
+import { PointProps, RelativePosition, UiEvent } from "@itwin/appui-abstract";
+/** Enum for Cursor Direction parts
+ *  @public
+ */
+export declare enum CursorDirectionParts {
+    Top = 4096,
+    Left = 256,
+    Right = 16,
+    Bottom = 1
+}
+/** Enum for Cursor Direction
+ * @public
+ */
+export declare enum CursorDirection {
+    None = 0,
+    Top = 4096,
+    Left = 256,
+    Right = 16,
+    Bottom = 1,
+    TopLeft = 4352,
+    TopRight = 4112,
+    BottomLeft = 257,
+    BottomRight = 17
+}
+/** Cursor Updated Event Args interface.
+ * @public
+ */
+export interface CursorUpdatedEventArgs {
+    oldPt: PointProps;
+    newPt: PointProps;
+    direction: CursorDirection;
+}
+/** Cursor Updated Event class.
+ * @public
+ */
+export declare class CursorUpdatedEvent extends UiEvent<CursorUpdatedEventArgs> {
+}
+/** Cursor Information class
+ * @public
+ */
+export declare class CursorInformation {
+    private static _cursorPosition;
+    private static _cursorDirection;
+    private static _cursorDirections;
+    /** The cursor position. */
+    static get cursorPosition(): PointProps;
+    static set cursorPosition(pt: PointProps);
+    /** Gets the cursor X position. */
+    static get cursorX(): number;
+    /** Gets the cursor Y position. */
+    static get cursorY(): number;
+    /** Gets the general cursor movement direction. */
+    static get cursorDirection(): CursorDirection;
+    /** Gets the [[CursorUpdatedEvent]]. */
+    static readonly onCursorUpdatedEvent: CursorUpdatedEvent;
+    /** Handles the mouse movement.  Sets the cursor position and direction and emits onCursorUpdatedEvent. */
+    static handleMouseMove(point: PointProps): void;
+    private static _determineMostFrequentDirection;
+    private static _mostFrequent;
+    private static _determineCursorDirection;
+    /** Gets the relative position based on the cursor direction. */
+    static getRelativePositionFromCursorDirection(cursorDirection: CursorDirection): RelativePosition;
+    /** @internal - for testing */
+    static clearCursorDirections(): void;
+}
 //# sourceMappingURL=CursorInformation.d.ts.map