@itwin/appui-react 4.0.0-dev.1 → 4.0.0-dev.10

package/lib/cjs/appui-react/framework/FrameworkFrontstages.d.ts

@@ -0,0 +1,286 @@
+/// <reference types="react" />
+/** @packageDocumentation
+ * @module Frontstage
+ */
+import { UiEvent } from "@itwin/appui-abstract";
+import { IModelConnection, Tool } from "@itwin/core-frontend";
+import { ToolInformation } from "../toolsettings/ToolInformation";
+import { TimeTracker } from "../configurableui/TimeTracker";
+import { ContentControlActivatedEvent } from "../content/ContentControl";
+import { ContentLayoutActivatedEvent } from "../content/ContentLayout";
+import { FrontstageDef } from "../frontstage/FrontstageDef";
+import { FrontstageProvider } from "../frontstage/FrontstageProvider";
+import { NavigationAidActivatedEvent } from "../navigationaids/NavigationAidControl";
+import { PanelStateChangedEvent } from "../stagepanels/StagePanelDef";
+import { WidgetDef, WidgetStateChangedEvent } from "../widgets/WidgetDef";
+import { WidgetState } from "../widgets/WidgetState";
+/** Frontstage Activated Event Args interface.
+ * @public
+ */
+export interface FrontstageActivatedEventArgs {
+    deactivatedFrontstageDef?: FrontstageDef;
+    activatedFrontstageDef: FrontstageDef;
+}
+/** Frontstage Activated Event class.
+ * @public
+ */
+export declare class FrontstageActivatedEvent extends UiEvent<FrontstageActivatedEventArgs> {
+}
+/** Frontstage Deactivated Event Args interface.
+ * @public
+ */
+export interface FrontstageDeactivatedEventArgs {
+    /** Frontstage being deactivated */
+    deactivatedFrontstageDef: FrontstageDef;
+    /** Frontstage being activated */
+    activatedFrontstageDef?: FrontstageDef;
+    /** Total time spent in frontstage */
+    totalTime: number;
+    /** Engagement time spent in frontstage */
+    engagementTime: number;
+    /** Idle time spent in frontstage */
+    idleTime: number;
+}
+/** Frontstage Deactivated Event class.
+ * @public
+ */
+export declare class FrontstageDeactivatedEvent extends UiEvent<FrontstageDeactivatedEventArgs> {
+}
+/** Frontstage Ready Event Args interface.
+ * @public
+ */
+export interface FrontstageReadyEventArgs {
+    frontstageDef: FrontstageDef;
+}
+/** Frontstage Ready Event class.
+ * @public
+ */
+export declare class FrontstageReadyEvent extends UiEvent<FrontstageReadyEventArgs> {
+}
+/** Modal Frontstage Changed Event Args interface.
+ * @public
+ */
+export interface ModalFrontstageChangedEventArgs {
+    modalFrontstageCount: number;
+}
+/** Modal Frontstage Stack Changed Event class.
+ * @public
+ */
+export declare class ModalFrontstageChangedEvent extends UiEvent<ModalFrontstageChangedEventArgs> {
+}
+/** Modal Frontstage Closed Event Args interface.
+ * @public
+ */
+export interface ModalFrontstageClosedEventArgs {
+    /** Modal Frontstage being closed */
+    modalFrontstage: ModalFrontstageInfo;
+    /** Total time spent in frontstage */
+    totalTime: number;
+    /** Engagement time spent in frontstage */
+    engagementTime: number;
+    /** Idle time spent in frontstage */
+    idleTime: number;
+}
+/** Modal Frontstage Requested Close Event class. Notifies the modal stage that the close button was
+ * pressed and passes the function to actually close the modal stage. This allows stage to do any
+ * saving of unsaved data prior to closing the stage. If the ModalFrontstageInfo sets notifyCloseRequest
+ * to true it is up to the stage to register for this event and call the stageCloseFunc once it has saved
+ * any unsaved data.
+ * @alpha
+ */
+export declare class ModalFrontstageRequestedCloseEvent extends UiEvent<ModalFrontstageRequestedCloseEventArgs> {
+}
+/** Modal Frontstage RequestedClose Event Args interface.
+ * @alpha
+ */
+export interface ModalFrontstageRequestedCloseEventArgs {
+    /** Modal Frontstage that is to be closed */
+    modalFrontstage: ModalFrontstageInfo;
+    /** Function to call to close the stage */
+    stageCloseFunc: () => void;
+}
+/** Modal Frontstage Closed Event class.
+ * @public
+ */
+export declare class ModalFrontstageClosedEvent extends UiEvent<ModalFrontstageClosedEventArgs> {
+}
+/** Tool Activated Event Args interface.
+ * @public
+ */
+export interface ToolActivatedEventArgs {
+    toolId: string;
+}
+/** Tool Activated Event class.
+ * @public
+ */
+export declare class ToolActivatedEvent extends UiEvent<ToolActivatedEventArgs> {
+}
+/** Tool Icon Changed Event Args interface.
+ * @public
+ */
+export interface ToolIconChangedEventArgs {
+    iconSpec: string;
+}
+/** Tool Icon Changed Event class.
+ * @public
+ */
+export declare class ToolIconChangedEvent extends UiEvent<ToolIconChangedEventArgs> {
+}
+/** Modal Frontstage information interface.
+ * @public
+ */
+export interface ModalFrontstageInfo {
+    title: string;
+    content: React.ReactNode;
+    appBarRight?: React.ReactNode;
+    /** Set notifyCloseRequest to true on stages that register to listen for `onCloseModalFrontstageRequestedEvent` so
+     * that the stage can save unsaved data before closing. Used by the ModalSettingsStage.
+     * @alpha */
+    notifyCloseRequest?: boolean;
+}
+/** Modal Frontstage array item interface.
+ * @internal
+ */
+export interface ModalFrontstageItem {
+    modalFrontstage: ModalFrontstageInfo;
+    timeTracker: TimeTracker;
+}
+/**
+ * [[UiFramework.frontstages]] interface
+ * @beta
+ */
+export interface FrameworkFrontstages {
+    /** Returns true if Frontstage is loading its controls. If false the Frontstage content and controls have been created. */
+    readonly isLoading: boolean;
+    /** Get Frontstage Deactivated event. */
+    readonly onFrontstageDeactivatedEvent: FrontstageDeactivatedEvent;
+    /** Get Frontstage Activated event. */
+    readonly onFrontstageActivatedEvent: FrontstageActivatedEvent;
+    /** Get Frontstage Activated event. */
+    readonly onFrontstageReadyEvent: FrontstageReadyEvent;
+    /** Get Modal Frontstage Changed event. */
+    readonly onModalFrontstageChangedEvent: ModalFrontstageChangedEvent;
+    /** Get Modal Frontstage Closed event. */
+    readonly onModalFrontstageClosedEvent: ModalFrontstageClosedEvent;
+    /** Get Modal Frontstage Requested Closed event.
+     * @alpha
+     */
+    readonly onCloseModalFrontstageRequestedEvent: ModalFrontstageRequestedCloseEvent;
+    /** Get Tool Activated event. */
+    readonly onToolActivatedEvent: ToolActivatedEvent;
+    /** Get ToolSetting Reload event. */
+    readonly onToolSettingsReloadEvent: UiEvent<void>;
+    /** Get Tool Icon Changed event. */
+    readonly onToolIconChangedEvent: ToolIconChangedEvent;
+    /** Get Content Layout Activated event. */
+    readonly onContentLayoutActivatedEvent: ContentLayoutActivatedEvent;
+    /** Get Content Control Activated event. */
+    readonly onContentControlActivatedEvent: ContentControlActivatedEvent;
+    /** Get Navigation Aid Activated event. */
+    readonly onNavigationAidActivatedEvent: NavigationAidActivatedEvent;
+    /** Get Widget State Changed event. */
+    readonly onWidgetStateChangedEvent: WidgetStateChangedEvent;
+    /** Get Widget State Changed event.
+     * @alpha
+     */
+    readonly onPanelStateChangedEvent: PanelStateChangedEvent;
+    /** Clears the Frontstage map.
+     */
+    clearFrontstageDefs(): void;
+    /** Clears the Frontstage Providers and the defs that may have been created from them.
+     */
+    clearFrontstageProviders(): void;
+    /** Add a Frontstage via a [[FrontstageProvider]].
+     * @param frontstageProvider  FrontstageProvider representing the Frontstage to add
+     */
+    addFrontstageProvider(frontstageProvider: FrontstageProvider): void;
+    /** Find a loaded Frontstage with a given id. If the id is not provided, the active Frontstage is returned. If
+     * no cached FrontstageDef is found but a FrontstageProvider is registered a FrontstageDef will be created, cached, and
+     * returned.
+     * @param id  Id of the Frontstage to find
+     * @returns  FrontstageDef with a given id if found, or undefined if not found.
+     */
+    getFrontstageDef(id?: string): Promise<FrontstageDef | undefined>;
+    /** Gets the active FrontstageDef. If a Frontstage is not active, undefined is returned.
+     * @return  Active FrontstageDef, or undefined if one is not active.
+     */
+    readonly activeFrontstageDef: FrontstageDef | undefined;
+    /** Gets the Id of the active FrontstageDef. If a Frontstage is not active, blank is returned.
+     * @return  Id of the active FrontstageDef, or blank if one is not active.
+     */
+    readonly activeFrontstageId: string;
+    hasFrontstage(frontstageId: string): boolean;
+    /** Sets the active FrontstageDef give the stageId.
+     * @param  frontstageId  Id of the Frontstage to set active.
+     * @returns A Promise that is fulfilled when the [[Frontstage]] is ready.
+     */
+    setActiveFrontstage(frontstageId: string): Promise<void>;
+    /** Sets the active FrontstageDef.
+     * @param  frontstageDef  FrontstageDef to set active.
+     * @returns A Promise that is fulfilled when the [[FrontstageDef]] is ready.
+     */
+    setActiveFrontstageDef(frontstageDef: FrontstageDef | undefined): Promise<void>;
+    /** Deactivates the active FrontstageDef.
+     */
+    deactivateFrontstageDef(): Promise<void>;
+    /** Gets the Id of the active tool. If a tool is not active, blank is returned.
+     * @return  Id of the active tool, or blank if one is not active.
+     */
+    readonly activeToolId: string;
+    /** Sets the active tool id */
+    setActiveToolId(toolId: string): void;
+    /** Sets the active tool */
+    setActiveTool(tool: Tool): void;
+    /** Gets the active tool's [[ToolInformation]] */
+    readonly activeToolInformation: ToolInformation | undefined;
+    /** Opens a modal Frontstage. Modal Frontstages can be stacked.
+     * @param modalFrontstage  Information about the modal Frontstage
+     */
+    openModalFrontstage(modalFrontstage: ModalFrontstageInfo): void;
+    /** Closes the top-most modal Frontstage.
+     */
+    closeModalFrontstage(): void;
+    /** Updates the top-most modal Frontstage.
+     */
+    updateModalFrontstage(): void;
+    /** Gets the top-most modal Frontstage.
+     * @returns Top-most modal Frontstage, or undefined if there is none.
+     */
+    readonly activeModalFrontstage: ModalFrontstageInfo | undefined;
+    /** Gets the number of modal Frontstages.
+     * @returns Modal Frontstage count
+     */
+    readonly modalFrontstageCount: number;
+    /** Sets the active Navigation Aid via its Id.
+     * @param navigationAidId  Id of the Navigation Aid to set as active
+     * @param iModelConnection IModelConnection to query for view data
+     */
+    setActiveNavigationAid(navigationAidId: string, iModelConnection: IModelConnection): void;
+    /** Sets the state of the widget with the given id
+     * @param widgetId  Id of the Widget for which to set the state
+     * @param state     New state of the widget
+     * @returns true if the widget state was set successfully, or false if not.
+     */
+    setWidgetState(widgetId: string, state: WidgetState): boolean;
+    /** Finds a widget with the given id in the active frontstage
+     * @param widgetId  Id of the Widget to find
+     * @returns The WidgetDef with the given id, or undefined if not found.
+     */
+    findWidget(widgetId: string): WidgetDef | undefined;
+    /** Opens a nested Frontstage. Nested Frontstages can be stacked.
+     * @param nestedFrontstage  Information about the nested Frontstage
+     */
+    openNestedFrontstage(nestedFrontstage: FrontstageDef): Promise<void>;
+    /** Closes the top-most nested Frontstage.
+     */
+    closeNestedFrontstage(): Promise<void>;
+    /** Gets the top-most nested Frontstage.
+     * @returns Top-most nested Frontstage, or undefined if there is none.
+     */
+    readonly activeNestedFrontstage: FrontstageDef | undefined;
+    /** Gets the number of nested Frontstages.
+     * @returns Nested Frontstage count
+     */
+    readonly nestedFrontstageCount: number;
+}
+//# sourceMappingURL=FrameworkFrontstages.d.ts.map

package/lib/cjs/appui-react/framework/FrameworkFrontstages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FrameworkFrontstages.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkFrontstages.ts"],"names":[],"mappings":";AAIA;;GAEG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,4BAA4B,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,2BAA2B,EAAE,MAAM,wCAAwC,CAAC;AACrF,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,wBAAwB,CAAC,EAAE,aAAa,CAAC;IACzC,sBAAsB,EAAE,aAAa,CAAC;CACvC;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,OAAO,CAAC,4BAA4B,CAAC;CAAI;AAEvF;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,mCAAmC;IACnC,wBAAwB,EAAE,aAAa,CAAC;IACxC,iCAAiC;IACjC,sBAAsB,CAAC,EAAE,aAAa,CAAC;IAEvC,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,cAAc,EAAE,MAAM,CAAC;IACvB,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,OAAO,CAAC,8BAA8B,CAAC;CAAI;AAE3F;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,OAAO,CAAC,wBAAwB,CAAC;CAAI;AAE/E;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,OAAO,CAAC,+BAA+B,CAAC;CAAI;AAE7F;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,oCAAoC;IACpC,eAAe,EAAE,mBAAmB,CAAC;IAErC,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,cAAc,EAAE,MAAM,CAAC;IACvB,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;GAMG;AACH,qBAAa,kCAAmC,SAAQ,OAAO,CAAC,sCAAsC,CAAC;CAAI;AAE3G;;GAEG;AACH,MAAM,WAAW,sCAAsC;IACrD,4CAA4C;IAC5C,eAAe,EAAE,mBAAmB,CAAC;IACrC,0CAA0C;IAC1C,cAAc,EAAE,MAAM,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,OAAO,CAAC,8BAA8B,CAAC;CAAI;AAE3F;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,OAAO,CAAC,sBAAsB,CAAC;CAAI;AAE3E;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,OAAO,CAAC,wBAAwB,CAAC;CAAI;AAE/E;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,KAAK,CAAC,SAAS,CAAC;IACzB,WAAW,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC9B;;gBAEY;IACZ,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,eAAe,EAAE,mBAAmB,CAAC;IACrC,WAAW,EAAE,WAAW,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,0HAA0H;IAC1H,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAE5B,wCAAwC;IACxC,QAAQ,CAAC,4BAA4B,EAAE,0BAA0B,CAAC;IAElE,sCAAsC;IACtC,QAAQ,CAAC,0BAA0B,EAAE,wBAAwB,CAAC;IAE9D,sCAAsC;IACtC,QAAQ,CAAC,sBAAsB,EAAE,oBAAoB,CAAC;IAEtD,0CAA0C;IAC1C,QAAQ,CAAC,6BAA6B,EAAE,2BAA2B,CAAC;IAEpE,yCAAyC;IACzC,QAAQ,CAAC,4BAA4B,EAAE,0BAA0B,CAAC;IAElE;;OAEG;IACH,QAAQ,CAAC,oCAAoC,EAAE,kCAAkC,CAAC;IAElF,gCAAgC;IAChC,QAAQ,CAAC,oBAAoB,EAAE,kBAAkB,CAAC;IAElD,oCAAoC;IACpC,QAAQ,CAAC,yBAAyB,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD,mCAAmC;IACnC,QAAQ,CAAC,sBAAsB,EAAE,oBAAoB,CAAC;IAEtD,0CAA0C;IAC1C,QAAQ,CAAC,6BAA6B,EAAE,2BAA2B,CAAC;IAEpE,2CAA2C;IAC3C,QAAQ,CAAC,8BAA8B,EAAE,4BAA4B,CAAC;IAEtE,0CAA0C;IAC1C,QAAQ,CAAC,6BAA6B,EAAE,2BAA2B,CAAC;IAEpE,sCAAsC;IACtC,QAAQ,CAAC,yBAAyB,EAAE,uBAAuB,CAAC;IAE5D;;OAEG;IACH,QAAQ,CAAC,wBAAwB,EAAE,sBAAsB,CAAC;IAE1D;OACG;IACH,mBAAmB,IAAI,IAAI,CAAC;IAE5B;OACG;IACH,wBAAwB,IAAI,IAAI,CAAC;IAEjC;;OAEG;IACH,qBAAqB,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEpE;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC,CAAC;IAElE;;OAEG;IACH,QAAQ,CAAC,mBAAmB,EAAE,aAAa,GAAG,SAAS,CAAC;IAExD;;OAEG;IACH,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAEpC,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC;IAE7C;;;OAGG;IACH,mBAAmB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD;;;OAGG;IACH,sBAAsB,CAAC,aAAa,EAAE,aAAa,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhF;OACG;IACH,uBAAuB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B,8BAA8B;IAC9B,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,2BAA2B;IAC3B,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IAEhC,iDAAiD;IACjD,QAAQ,CAAC,qBAAqB,EAAE,eAAe,GAAG,SAAS,CAAC;IAE5D;;OAEG;IACH,mBAAmB,CAAC,eAAe,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEhE;OACG;IACH,oBAAoB,IAAI,IAAI,CAAC;IAE7B;OACG;IACH,qBAAqB,IAAI,IAAI,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,GAAG,SAAS,CAAC;IAEhE;;OAEG;IACH,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;IAEtC;;;OAGG;IACH,sBAAsB,CAAC,eAAe,EAAE,MAAM,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE1F;;;;OAIG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC;IAE9D;;;OAGG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAAC;IAEpD;;OAEG;IACH,oBAAoB,CAAC,gBAAgB,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErE;OACG;IACH,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,sBAAsB,EAAE,aAAa,GAAG,SAAS,CAAC;IAE3D;;OAEG;IACH,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;CACxC"}

package/lib/cjs/appui-react/framework/FrameworkFrontstages.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToolIconChangedEvent = exports.ToolActivatedEvent = exports.ModalFrontstageClosedEvent = exports.ModalFrontstageRequestedCloseEvent = exports.ModalFrontstageChangedEvent = exports.FrontstageReadyEvent = exports.FrontstageDeactivatedEvent = exports.FrontstageActivatedEvent = void 0;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Frontstage
+ */
+const appui_abstract_1 = require("@itwin/appui-abstract");
+/** Frontstage Activated Event class.
+ * @public
+ */
+class FrontstageActivatedEvent extends appui_abstract_1.UiEvent {
+}
+exports.FrontstageActivatedEvent = FrontstageActivatedEvent;
+/** Frontstage Deactivated Event class.
+ * @public
+ */
+class FrontstageDeactivatedEvent extends appui_abstract_1.UiEvent {
+}
+exports.FrontstageDeactivatedEvent = FrontstageDeactivatedEvent;
+/** Frontstage Ready Event class.
+ * @public
+ */
+class FrontstageReadyEvent extends appui_abstract_1.UiEvent {
+}
+exports.FrontstageReadyEvent = FrontstageReadyEvent;
+/** Modal Frontstage Stack Changed Event class.
+ * @public
+ */
+class ModalFrontstageChangedEvent extends appui_abstract_1.UiEvent {
+}
+exports.ModalFrontstageChangedEvent = ModalFrontstageChangedEvent;
+/** Modal Frontstage Requested Close Event class. Notifies the modal stage that the close button was
+ * pressed and passes the function to actually close the modal stage. This allows stage to do any
+ * saving of unsaved data prior to closing the stage. If the ModalFrontstageInfo sets notifyCloseRequest
+ * to true it is up to the stage to register for this event and call the stageCloseFunc once it has saved
+ * any unsaved data.
+ * @alpha
+ */
+class ModalFrontstageRequestedCloseEvent extends appui_abstract_1.UiEvent {
+}
+exports.ModalFrontstageRequestedCloseEvent = ModalFrontstageRequestedCloseEvent;
+/** Modal Frontstage Closed Event class.
+ * @public
+ */
+class ModalFrontstageClosedEvent extends appui_abstract_1.UiEvent {
+}
+exports.ModalFrontstageClosedEvent = ModalFrontstageClosedEvent;
+/** Tool Activated Event class.
+ * @public
+ */
+class ToolActivatedEvent extends appui_abstract_1.UiEvent {
+}
+exports.ToolActivatedEvent = ToolActivatedEvent;
+/** Tool Icon Changed Event class.
+ * @public
+ */
+class ToolIconChangedEvent extends appui_abstract_1.UiEvent {
+}
+exports.ToolIconChangedEvent = ToolIconChangedEvent;
+//# sourceMappingURL=FrameworkFrontstages.js.map

package/lib/cjs/appui-react/framework/FrameworkFrontstages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FrameworkFrontstages.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkFrontstages.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,0DAAgD;AAqBhD;;GAEG;AACH,MAAa,wBAAyB,SAAQ,wBAAqC;CAAI;AAAvF,4DAAuF;AAmBvF;;GAEG;AACH,MAAa,0BAA2B,SAAQ,wBAAuC;CAAI;AAA3F,gEAA2F;AAS3F;;GAEG;AACH,MAAa,oBAAqB,SAAQ,wBAAiC;CAAI;AAA/E,oDAA+E;AAS/E;;GAEG;AACH,MAAa,2BAA4B,SAAQ,wBAAwC;CAAI;AAA7F,kEAA6F;AAiB7F;;;;;;GAMG;AACH,MAAa,kCAAmC,SAAQ,wBAA+C;CAAI;AAA3G,gFAA2G;AAY3G;;GAEG;AACH,MAAa,0BAA2B,SAAQ,wBAAuC;CAAI;AAA3F,gEAA2F;AAS3F;;GAEG;AACH,MAAa,kBAAmB,SAAQ,wBAA+B;CAAI;AAA3E,gDAA2E;AAS3E;;GAEG;AACH,MAAa,oBAAqB,SAAQ,wBAAiC;CAAI;AAA/E,oDAA+E","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Frontstage\r\n */\r\nimport { UiEvent } from \"@itwin/appui-abstract\";\r\nimport { IModelConnection, Tool } from \"@itwin/core-frontend\";\r\nimport { ToolInformation } from \"../toolsettings/ToolInformation\";\r\nimport { TimeTracker } from \"../configurableui/TimeTracker\";\r\nimport { ContentControlActivatedEvent } from \"../content/ContentControl\";\r\nimport { ContentLayoutActivatedEvent } from \"../content/ContentLayout\";\r\nimport { FrontstageDef } from \"../frontstage/FrontstageDef\";\r\nimport { FrontstageProvider } from \"../frontstage/FrontstageProvider\";\r\nimport { NavigationAidActivatedEvent } from \"../navigationaids/NavigationAidControl\";\r\nimport { PanelStateChangedEvent } from \"../stagepanels/StagePanelDef\";\r\nimport { WidgetDef, WidgetStateChangedEvent } from \"../widgets/WidgetDef\";\r\nimport { WidgetState } from \"../widgets/WidgetState\";\r\n\r\n/** Frontstage Activated Event Args interface.\r\n * @public\r\n */\r\nexport interface FrontstageActivatedEventArgs {\r\n  deactivatedFrontstageDef?: FrontstageDef;\r\n  activatedFrontstageDef: FrontstageDef;\r\n}\r\n\r\n/** Frontstage Activated Event class.\r\n * @public\r\n */\r\nexport class FrontstageActivatedEvent extends UiEvent<FrontstageActivatedEventArgs> { }\r\n\r\n/** Frontstage Deactivated Event Args interface.\r\n * @public\r\n */\r\nexport interface FrontstageDeactivatedEventArgs {\r\n  /** Frontstage being deactivated */\r\n  deactivatedFrontstageDef: FrontstageDef;\r\n  /** Frontstage being activated */\r\n  activatedFrontstageDef?: FrontstageDef;\r\n\r\n  /** Total time spent in frontstage */\r\n  totalTime: number;\r\n  /** Engagement time spent in frontstage */\r\n  engagementTime: number;\r\n  /** Idle time spent in frontstage */\r\n  idleTime: number;\r\n}\r\n\r\n/** Frontstage Deactivated Event class.\r\n * @public\r\n */\r\nexport class FrontstageDeactivatedEvent extends UiEvent<FrontstageDeactivatedEventArgs> { }\r\n\r\n/** Frontstage Ready Event Args interface.\r\n * @public\r\n */\r\nexport interface FrontstageReadyEventArgs {\r\n  frontstageDef: FrontstageDef;\r\n}\r\n\r\n/** Frontstage Ready Event class.\r\n * @public\r\n */\r\nexport class FrontstageReadyEvent extends UiEvent<FrontstageReadyEventArgs> { }\r\n\r\n/** Modal Frontstage Changed Event Args interface.\r\n * @public\r\n */\r\nexport interface ModalFrontstageChangedEventArgs {\r\n  modalFrontstageCount: number;\r\n}\r\n\r\n/** Modal Frontstage Stack Changed Event class.\r\n * @public\r\n */\r\nexport class ModalFrontstageChangedEvent extends UiEvent<ModalFrontstageChangedEventArgs> { }\r\n\r\n/** Modal Frontstage Closed Event Args interface.\r\n * @public\r\n */\r\nexport interface ModalFrontstageClosedEventArgs {\r\n  /** Modal Frontstage being closed */\r\n  modalFrontstage: ModalFrontstageInfo;\r\n\r\n  /** Total time spent in frontstage */\r\n  totalTime: number;\r\n  /** Engagement time spent in frontstage */\r\n  engagementTime: number;\r\n  /** Idle time spent in frontstage */\r\n  idleTime: number;\r\n}\r\n\r\n/** Modal Frontstage Requested Close Event class. Notifies the modal stage that the close button was\r\n * pressed and passes the function to actually close the modal stage. This allows stage to do any\r\n * saving of unsaved data prior to closing the stage. If the ModalFrontstageInfo sets notifyCloseRequest\r\n * to true it is up to the stage to register for this event and call the stageCloseFunc once it has saved\r\n * any unsaved data.\r\n * @alpha\r\n */\r\nexport class ModalFrontstageRequestedCloseEvent extends UiEvent<ModalFrontstageRequestedCloseEventArgs> { }\r\n\r\n/** Modal Frontstage RequestedClose Event Args interface.\r\n * @alpha\r\n */\r\nexport interface ModalFrontstageRequestedCloseEventArgs {\r\n  /** Modal Frontstage that is to be closed */\r\n  modalFrontstage: ModalFrontstageInfo;\r\n  /** Function to call to close the stage */\r\n  stageCloseFunc: () => void;\r\n}\r\n\r\n/** Modal Frontstage Closed Event class.\r\n * @public\r\n */\r\nexport class ModalFrontstageClosedEvent extends UiEvent<ModalFrontstageClosedEventArgs> { }\r\n\r\n/** Tool Activated Event Args interface.\r\n * @public\r\n */\r\nexport interface ToolActivatedEventArgs {\r\n  toolId: string;\r\n}\r\n\r\n/** Tool Activated Event class.\r\n * @public\r\n */\r\nexport class ToolActivatedEvent extends UiEvent<ToolActivatedEventArgs> { }\r\n\r\n/** Tool Icon Changed Event Args interface.\r\n * @public\r\n */\r\nexport interface ToolIconChangedEventArgs {\r\n  iconSpec: string;\r\n}\r\n\r\n/** Tool Icon Changed Event class.\r\n * @public\r\n */\r\nexport class ToolIconChangedEvent extends UiEvent<ToolIconChangedEventArgs> { }\r\n\r\n/** Modal Frontstage information interface.\r\n * @public\r\n */\r\nexport interface ModalFrontstageInfo {\r\n  title: string;\r\n  content: React.ReactNode;\r\n  appBarRight?: React.ReactNode;\r\n  /** Set notifyCloseRequest to true on stages that register to listen for `onCloseModalFrontstageRequestedEvent` so\r\n   * that the stage can save unsaved data before closing. Used by the ModalSettingsStage.\r\n   * @alpha */\r\n  notifyCloseRequest?: boolean;\r\n}\r\n\r\n/** Modal Frontstage array item interface.\r\n * @internal\r\n */\r\nexport interface ModalFrontstageItem {\r\n  modalFrontstage: ModalFrontstageInfo;\r\n  timeTracker: TimeTracker;\r\n}\r\n\r\n/**\r\n * [[UiFramework.frontstages]] interface\r\n * @beta\r\n */\r\nexport interface FrameworkFrontstages {\r\n  /** Returns true if Frontstage is loading its controls. If false the Frontstage content and controls have been created. */\r\n  readonly isLoading: boolean;\r\n\r\n  /** Get Frontstage Deactivated event. */\r\n  readonly onFrontstageDeactivatedEvent: FrontstageDeactivatedEvent;\r\n\r\n  /** Get Frontstage Activated event. */\r\n  readonly onFrontstageActivatedEvent: FrontstageActivatedEvent;\r\n\r\n  /** Get Frontstage Activated event. */\r\n  readonly onFrontstageReadyEvent: FrontstageReadyEvent;\r\n\r\n  /** Get Modal Frontstage Changed event. */\r\n  readonly onModalFrontstageChangedEvent: ModalFrontstageChangedEvent;\r\n\r\n  /** Get Modal Frontstage Closed event. */\r\n  readonly onModalFrontstageClosedEvent: ModalFrontstageClosedEvent;\r\n\r\n  /** Get Modal Frontstage Requested Closed event.\r\n   * @alpha\r\n   */\r\n  readonly onCloseModalFrontstageRequestedEvent: ModalFrontstageRequestedCloseEvent;\r\n\r\n  /** Get Tool Activated event. */\r\n  readonly onToolActivatedEvent: ToolActivatedEvent;\r\n\r\n  /** Get ToolSetting Reload event. */\r\n  readonly onToolSettingsReloadEvent: UiEvent<void>;\r\n\r\n  /** Get Tool Icon Changed event. */\r\n  readonly onToolIconChangedEvent: ToolIconChangedEvent;\r\n\r\n  /** Get Content Layout Activated event. */\r\n  readonly onContentLayoutActivatedEvent: ContentLayoutActivatedEvent;\r\n\r\n  /** Get Content Control Activated event. */\r\n  readonly onContentControlActivatedEvent: ContentControlActivatedEvent;\r\n\r\n  /** Get Navigation Aid Activated event. */\r\n  readonly onNavigationAidActivatedEvent: NavigationAidActivatedEvent;\r\n\r\n  /** Get Widget State Changed event. */\r\n  readonly onWidgetStateChangedEvent: WidgetStateChangedEvent;\r\n\r\n  /** Get Widget State Changed event.\r\n   * @alpha\r\n   */\r\n  readonly onPanelStateChangedEvent: PanelStateChangedEvent;\r\n\r\n  /** Clears the Frontstage map.\r\n   */\r\n  clearFrontstageDefs(): void;\r\n\r\n  /** Clears the Frontstage Providers and the defs that may have been created from them.\r\n   */\r\n  clearFrontstageProviders(): void;\r\n\r\n  /** Add a Frontstage via a [[FrontstageProvider]].\r\n   * @param frontstageProvider  FrontstageProvider representing the Frontstage to add\r\n   */\r\n  addFrontstageProvider(frontstageProvider: FrontstageProvider): void;\r\n\r\n  /** Find a loaded Frontstage with a given id. If the id is not provided, the active Frontstage is returned. If\r\n   * no cached FrontstageDef is found but a FrontstageProvider is registered a FrontstageDef will be created, cached, and\r\n   * returned.\r\n   * @param id  Id of the Frontstage to find\r\n   * @returns  FrontstageDef with a given id if found, or undefined if not found.\r\n   */\r\n  getFrontstageDef(id?: string): Promise<FrontstageDef | undefined>;\r\n\r\n  /** Gets the active FrontstageDef. If a Frontstage is not active, undefined is returned.\r\n   * @return  Active FrontstageDef, or undefined if one is not active.\r\n   */\r\n  readonly activeFrontstageDef: FrontstageDef | undefined;\r\n\r\n  /** Gets the Id of the active FrontstageDef. If a Frontstage is not active, blank is returned.\r\n   * @return  Id of the active FrontstageDef, or blank if one is not active.\r\n   */\r\n  readonly activeFrontstageId: string;\r\n\r\n  hasFrontstage(frontstageId: string): boolean;\r\n\r\n  /** Sets the active FrontstageDef give the stageId.\r\n   * @param  frontstageId  Id of the Frontstage to set active.\r\n   * @returns A Promise that is fulfilled when the [[Frontstage]] is ready.\r\n   */\r\n  setActiveFrontstage(frontstageId: string): Promise<void>;\r\n\r\n  /** Sets the active FrontstageDef.\r\n   * @param  frontstageDef  FrontstageDef to set active.\r\n   * @returns A Promise that is fulfilled when the [[FrontstageDef]] is ready.\r\n   */\r\n  setActiveFrontstageDef(frontstageDef: FrontstageDef | undefined): Promise<void>;\r\n\r\n  /** Deactivates the active FrontstageDef.\r\n   */\r\n  deactivateFrontstageDef(): Promise<void>;\r\n\r\n  /** Gets the Id of the active tool. If a tool is not active, blank is returned.\r\n   * @return  Id of the active tool, or blank if one is not active.\r\n   */\r\n  readonly activeToolId: string;\r\n\r\n  /** Sets the active tool id */\r\n  setActiveToolId(toolId: string): void;\r\n\r\n  /** Sets the active tool */\r\n  setActiveTool(tool: Tool): void;\r\n\r\n  /** Gets the active tool's [[ToolInformation]] */\r\n  readonly activeToolInformation: ToolInformation | undefined;\r\n\r\n  /** Opens a modal Frontstage. Modal Frontstages can be stacked.\r\n   * @param modalFrontstage  Information about the modal Frontstage\r\n   */\r\n  openModalFrontstage(modalFrontstage: ModalFrontstageInfo): void;\r\n\r\n  /** Closes the top-most modal Frontstage.\r\n   */\r\n  closeModalFrontstage(): void;\r\n\r\n  /** Updates the top-most modal Frontstage.\r\n   */\r\n  updateModalFrontstage(): void;\r\n\r\n  /** Gets the top-most modal Frontstage.\r\n   * @returns Top-most modal Frontstage, or undefined if there is none.\r\n   */\r\n  readonly activeModalFrontstage: ModalFrontstageInfo | undefined;\r\n\r\n  /** Gets the number of modal Frontstages.\r\n   * @returns Modal Frontstage count\r\n   */\r\n  readonly modalFrontstageCount: number;\r\n\r\n  /** Sets the active Navigation Aid via its Id.\r\n   * @param navigationAidId  Id of the Navigation Aid to set as active\r\n   * @param iModelConnection IModelConnection to query for view data\r\n   */\r\n  setActiveNavigationAid(navigationAidId: string, iModelConnection: IModelConnection): void;\r\n\r\n  /** Sets the state of the widget with the given id\r\n   * @param widgetId  Id of the Widget for which to set the state\r\n   * @param state     New state of the widget\r\n   * @returns true if the widget state was set successfully, or false if not.\r\n   */\r\n  setWidgetState(widgetId: string, state: WidgetState): boolean;\r\n\r\n  /** Finds a widget with the given id in the active frontstage\r\n   * @param widgetId  Id of the Widget to find\r\n   * @returns The WidgetDef with the given id, or undefined if not found.\r\n   */\r\n  findWidget(widgetId: string): WidgetDef | undefined;\r\n\r\n  /** Opens a nested Frontstage. Nested Frontstages can be stacked.\r\n   * @param nestedFrontstage  Information about the nested Frontstage\r\n   */\r\n  openNestedFrontstage(nestedFrontstage: FrontstageDef): Promise<void>;\r\n\r\n  /** Closes the top-most nested Frontstage.\r\n   */\r\n  closeNestedFrontstage(): Promise<void>;\r\n\r\n  /** Gets the top-most nested Frontstage.\r\n   * @returns Top-most nested Frontstage, or undefined if there is none.\r\n   */\r\n  readonly activeNestedFrontstage: FrontstageDef | undefined;\r\n\r\n  /** Gets the number of nested Frontstages.\r\n   * @returns Nested Frontstage count\r\n   */\r\n  readonly nestedFrontstageCount: number;\r\n}\r\n"]}

package/lib/cjs/appui-react/framework/FrameworkKeyboardShortcuts.d.ts

@@ -0,0 +1,100 @@
+/** @packageDocumentation
+ * @module KeyboardShortcut
+ */
+import { FunctionKey, SpecialKey } from "@itwin/appui-abstract";
+import { ActionButtonItemDef } from "../shared/ActionButtonItemDef";
+import { ItemDefBase } from "../shared/ItemDefBase";
+import { ItemProps } from "../shared/ItemProps";
+/** Properties for a Keyboard Shortcut
+ * @public
+ */
+export interface KeyboardShortcutProps extends ItemProps {
+    /** The key that invokes the shortcut.
+     * This is either an alphanumeric key, a function key or a special key.
+     */
+    key: string | FunctionKey | SpecialKey;
+    /** The item to execute when this shortcut is invoked. Either 'item' or 'shortcuts' must be specified. */
+    item?: ActionButtonItemDef;
+    /** Nested array of shortcut props. Either 'item' or 'shortcuts' must be specified. */
+    shortcuts?: KeyboardShortcutProps[];
+    /** Indicates whether the Alt key required. Default - false */
+    isAltKeyRequired?: boolean;
+    /** Indicates whether the Ctrl key required. Default - false */
+    isCtrlKeyRequired?: boolean;
+    /** Indicates whether the Shift key required. Default - false */
+    isShiftKeyRequired?: boolean;
+}
+/** Keyboard Shortcut used to execute an action
+ * @public
+ */
+export interface FrameworkKeyboardShortcut extends ItemDefBase {
+    /** Returns the id for this shortcut */
+    readonly id: string;
+    /** Returns the shortcut container */
+    readonly shortcutContainer: FrameworkKeyboardShortcutContainer;
+    /** Finds a shortcut with a given key in the shortcut's container */
+    getShortcut(mapKey: string): FrameworkKeyboardShortcut | undefined;
+    /** Returns the shortcut's key map key used as the id */
+    readonly keyMapKey: string;
+    /** Returns the [[ActionButtonItemDef]] associated with this shortcut */
+    readonly item: ActionButtonItemDef | undefined;
+    /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */
+    itemPicked(): void;
+    /** Gets the keyboard key */
+    readonly key: string;
+    /** Gets whether the Alt key required. */
+    readonly isAltKeyRequired: boolean;
+    /** Gets whether the Ctrl key required. */
+    readonly isCtrlKeyRequired: boolean;
+    /** Gets whether the Shift key required. */
+    readonly isShiftKeyRequired: boolean;
+    /** Gets whether this is a Function key. */
+    readonly isFunctionKey: boolean;
+    /** Gets whether this is a Special key. */
+    readonly isSpecialKey: boolean;
+}
+/** Keyboard Shortcut Container
+ * @public
+ */
+export interface FrameworkKeyboardShortcutContainer {
+    /** Registers a Keyboard Shortcut associated with a given key in the managed list */
+    registerKey(keyMapKey: string, inShortcut: FrameworkKeyboardShortcut): FrameworkKeyboardShortcut | undefined;
+    /** Finds a Keyboard Shortcut associated with a given key */
+    findKey(keyMapKey: string): FrameworkKeyboardShortcut | undefined;
+    /** Determines if any Keyboard Shortcuts are available in this container */
+    areKeyboardShortcutsAvailable(): boolean;
+    /** Empties any Keyboard Shortcuts from this container */
+    emptyData(): void;
+    getAvailableKeyboardShortcuts(): FrameworkKeyboardShortcut[];
+    /** Displays a menu for the Keyboard Shortcuts in this container */
+    showShortcutsMenu(): void;
+}
+/**
+ * [[UiFramework.keyboardShortcuts]] interface
+ * @beta
+ */
+export interface FrameworkKeyboardShortcuts {
+    /** Loads Keyboard Shortcuts into the managed list */
+    loadShortcuts(shortcutList: KeyboardShortcutProps[]): void;
+    /** Loads a Keyboard Shortcut into the managed list */
+    loadShortcut(shortcutProps: KeyboardShortcutProps): void;
+    /** Processes a keystroke and invokes a matching Keyboard Shortcut */
+    processKey(keyboardKey: string, isAltKeyPressed?: boolean, isCtrlKeyPressed?: boolean, isShiftKeyPressed?: boolean): boolean;
+    /** Returns the managed list of Keyboard Shortcuts */
+    readonly shortcutContainer: FrameworkKeyboardShortcutContainer;
+    /** Returns a Keyboard Shortcut from the managed lists */
+    getShortcut(keyMapKey: string): FrameworkKeyboardShortcut | undefined;
+    /** Determines if focus is set to Home */
+    readonly isFocusOnHome: boolean;
+    /** Sets focus to Home */
+    setFocusToHome(): void;
+    /** Displays the Keyboard Shortcuts menu at the cursor */
+    displayMenu(): void;
+    /** Closes the Keyboard Shortcuts menu */
+    closeMenu(): void;
+    /** Returns the cursor X position, which is mouseEvent.pageX. */
+    readonly cursorX: number;
+    /** Returns the cursor Y position, which is mouseEvent.pageY. */
+    readonly cursorY: number;
+}
+//# sourceMappingURL=FrameworkKeyboardShortcuts.d.ts.map

package/lib/cjs/appui-react/framework/FrameworkKeyboardShortcuts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FrameworkKeyboardShortcuts.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkKeyboardShortcuts.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,SAAS;IACtD;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,WAAW,GAAG,UAAU,CAAC;IAEvC,yGAAyG;IACzG,IAAI,CAAC,EAAE,mBAAmB,CAAC;IAC3B,sFAAsF;IACtF,SAAS,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAEpC,8DAA8D;IAC9D,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,+DAA+D;IAC/D,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,gEAAgE;IAChE,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,WAAW;IAC5D,uCAAuC;IACvC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,qCAAqC;IACrC,QAAQ,CAAC,iBAAiB,EAAE,kCAAkC,CAAC;IAE/D,oEAAoE;IACpE,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,yBAAyB,GAAG,SAAS,CAAC;IAEnE,wDAAwD;IACxD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B,wEAAwE;IACxE,QAAQ,CAAC,IAAI,EAAE,mBAAmB,GAAG,SAAS,CAAC;IAE/C,uFAAuF;IACvF,UAAU,IAAI,IAAI,CAAC;IAEnB,4BAA4B;IAC5B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,yCAAyC;IACzC,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAC;IACnC,0CAA0C;IAC1C,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAC;IACpC,2CAA2C;IAC3C,QAAQ,CAAC,kBAAkB,EAAE,OAAO,CAAC;IACrC,2CAA2C;IAC3C,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;IAChC,0CAA0C;IAC1C,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;CAEhC;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD,oFAAoF;IACpF,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,yBAAyB,GAAG,yBAAyB,GAAG,SAAS,CAAC;IAE7G,4DAA4D;IAC5D,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,yBAAyB,GAAG,SAAS,CAAC;IAElE,2EAA2E;IAC3E,6BAA6B,IAAI,OAAO,CAAC;IAEzC,yDAAyD;IACzD,SAAS,IAAI,IAAI,CAAC;IAElB,6BAA6B,IAAI,yBAAyB,EAAE,CAAC;IAE7D,mEAAmE;IACnE,iBAAiB,IAAI,IAAI,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,qDAAqD;IACrD,aAAa,CAAC,YAAY,EAAE,qBAAqB,EAAE,GAAG,IAAI,CAAC;IAE3D,sDAAsD;IACtD,YAAY,CAAC,aAAa,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAEzD,qEAAqE;IACrE,UAAU,CAAC,WAAW,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,OAAO,EAAE,gBAAgB,CAAC,EAAE,OAAO,EAAE,iBAAiB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IAE7H,qDAAqD;IACrD,QAAQ,CAAC,iBAAiB,EAAE,kCAAkC,CAAC;IAE/D,yDAAyD;IACzD,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,yBAAyB,GAAG,SAAS,CAAC;IAEtE,yCAAyC;IACzC,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;IAEhC,yBAAyB;IACzB,cAAc,IAAI,IAAI,CAAC;IAEvB,yDAAyD;IACzD,WAAW,IAAI,IAAI,CAAC;IAEpB,yCAAyC;IACzC,SAAS,IAAI,IAAI,CAAC;IAElB,gEAAgE;IAChE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,gEAAgE;IAChE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B"}

package/lib/cjs/appui-react/framework/FrameworkKeyboardShortcuts.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=FrameworkKeyboardShortcuts.js.map

package/lib/cjs/appui-react/framework/FrameworkKeyboardShortcuts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FrameworkKeyboardShortcuts.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkKeyboardShortcuts.ts"],"names":[],"mappings":"","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module KeyboardShortcut\r\n */\r\nimport { FunctionKey, SpecialKey } from \"@itwin/appui-abstract\";\r\nimport { ActionButtonItemDef } from \"../shared/ActionButtonItemDef\";\r\nimport { ItemDefBase } from \"../shared/ItemDefBase\";\r\nimport { ItemProps } from \"../shared/ItemProps\";\r\n\r\n/** Properties for a Keyboard Shortcut\r\n * @public\r\n */\r\nexport interface KeyboardShortcutProps extends ItemProps {\r\n  /** The key that invokes the shortcut.\r\n   * This is either an alphanumeric key, a function key or a special key.\r\n   */\r\n  key: string | FunctionKey | SpecialKey;\r\n\r\n  /** The item to execute when this shortcut is invoked. Either 'item' or 'shortcuts' must be specified. */\r\n  item?: ActionButtonItemDef;\r\n  /** Nested array of shortcut props. Either 'item' or 'shortcuts' must be specified. */\r\n  shortcuts?: KeyboardShortcutProps[];\r\n\r\n  /** Indicates whether the Alt key required. Default - false */\r\n  isAltKeyRequired?: boolean;\r\n  /** Indicates whether the Ctrl key required. Default - false */\r\n  isCtrlKeyRequired?: boolean;\r\n  /** Indicates whether the Shift key required. Default - false */\r\n  isShiftKeyRequired?: boolean;\r\n}\r\n\r\n/** Keyboard Shortcut used to execute an action\r\n * @public\r\n */\r\nexport interface FrameworkKeyboardShortcut extends ItemDefBase {\r\n  /** Returns the id for this shortcut */\r\n  readonly id: string;\r\n\r\n  /** Returns the shortcut container */\r\n  readonly shortcutContainer: FrameworkKeyboardShortcutContainer;\r\n\r\n  /** Finds a shortcut with a given key in the shortcut's container */\r\n  getShortcut(mapKey: string): FrameworkKeyboardShortcut | undefined;\r\n\r\n  /** Returns the shortcut's key map key used as the id */\r\n  readonly keyMapKey: string;\r\n\r\n  /** Returns the [[ActionButtonItemDef]] associated with this shortcut */\r\n  readonly item: ActionButtonItemDef | undefined;\r\n\r\n  /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */\r\n  itemPicked(): void;\r\n\r\n  /** Gets the keyboard key */\r\n  readonly key: string;\r\n  /** Gets whether the Alt key required. */\r\n  readonly isAltKeyRequired: boolean;\r\n  /** Gets whether the Ctrl key required. */\r\n  readonly isCtrlKeyRequired: boolean;\r\n  /** Gets whether the Shift key required. */\r\n  readonly isShiftKeyRequired: boolean;\r\n  /** Gets whether this is a Function key. */\r\n  readonly isFunctionKey: boolean;\r\n  /** Gets whether this is a Special key. */\r\n  readonly isSpecialKey: boolean;\r\n\r\n}\r\n\r\n/** Keyboard Shortcut Container\r\n * @public\r\n */\r\nexport interface FrameworkKeyboardShortcutContainer {\r\n  /** Registers a Keyboard Shortcut associated with a given key in the managed list */\r\n  registerKey(keyMapKey: string, inShortcut: FrameworkKeyboardShortcut): FrameworkKeyboardShortcut | undefined;\r\n\r\n  /** Finds a Keyboard Shortcut associated with a given key */\r\n  findKey(keyMapKey: string): FrameworkKeyboardShortcut | undefined;\r\n\r\n  /** Determines if any Keyboard Shortcuts are available in this container */\r\n  areKeyboardShortcutsAvailable(): boolean;\r\n\r\n  /** Empties any Keyboard Shortcuts from this container */\r\n  emptyData(): void;\r\n\r\n  getAvailableKeyboardShortcuts(): FrameworkKeyboardShortcut[];\r\n\r\n  /** Displays a menu for the Keyboard Shortcuts in this container */\r\n  showShortcutsMenu(): void;\r\n}\r\n\r\n/**\r\n * [[UiFramework.keyboardShortcuts]] interface\r\n * @beta\r\n */\r\nexport interface FrameworkKeyboardShortcuts {\r\n  /** Loads Keyboard Shortcuts into the managed list */\r\n  loadShortcuts(shortcutList: KeyboardShortcutProps[]): void;\r\n\r\n  /** Loads a Keyboard Shortcut into the managed list */\r\n  loadShortcut(shortcutProps: KeyboardShortcutProps): void;\r\n\r\n  /** Processes a keystroke and invokes a matching Keyboard Shortcut */\r\n  processKey(keyboardKey: string, isAltKeyPressed?: boolean, isCtrlKeyPressed?: boolean, isShiftKeyPressed?: boolean): boolean;\r\n\r\n  /** Returns the managed list of Keyboard Shortcuts */\r\n  readonly shortcutContainer: FrameworkKeyboardShortcutContainer;\r\n\r\n  /** Returns a Keyboard Shortcut from the managed lists */\r\n  getShortcut(keyMapKey: string): FrameworkKeyboardShortcut | undefined;\r\n\r\n  /** Determines if focus is set to Home */\r\n  readonly isFocusOnHome: boolean;\r\n\r\n  /** Sets focus to Home */\r\n  setFocusToHome(): void;\r\n\r\n  /** Displays the Keyboard Shortcuts menu at the cursor */\r\n  displayMenu(): void;\r\n\r\n  /** Closes the Keyboard Shortcuts menu */\r\n  closeMenu(): void;\r\n\r\n  /** Returns the cursor X position, which is mouseEvent.pageX. */\r\n  readonly cursorX: number;\r\n  /** Returns the cursor Y position, which is mouseEvent.pageY. */\r\n  readonly cursorY: number;\r\n}\r\n"]}

package/lib/cjs/appui-react/framework/FrameworkToolSettings.d.ts

@@ -0,0 +1,52 @@
+/** @packageDocumentation
+ * @module ToolSettings
+ */
+import { DialogItem, DialogPropertySyncItem, UiEvent } from "@itwin/appui-abstract";
+import { InteractiveTool } from "@itwin/core-frontend";
+/** Sync Tool Settings Properties Event Args interface.
+ * @public
+ */
+export interface SyncToolSettingsPropertiesEventArgs {
+    toolId: string;
+    syncProperties: DialogPropertySyncItem[];
+}
+/** Sync Tool Settings Properties Event class.
+ * @public
+ */
+export declare class SyncToolSettingsPropertiesEvent extends UiEvent<SyncToolSettingsPropertiesEventArgs> {
+}
+/**
+ * [[UiFramework.toolSettings]] interface
+ * @beta
+ */
+export interface FrameworkToolSettings {
+    /** clear cached Tool Settings properties. */
+    clearToolSettingsData(): void;
+    /** Cache Tool Settings properties */
+    initializeToolSettingsData(toolSettingsProperties: DialogItem[] | undefined, toolId?: string, toolLabel?: string, toolDescription?: string): boolean;
+    /** Set of data used in Tool Settings for the specified tool. The tool specified should be the "active" tool.
+     */
+    initializeDataForTool(tool: InteractiveTool): void;
+    /** Returns the toolSettings properties that can be used to populate the tool settings widget. */
+    readonly toolSettingsProperties: DialogItem[];
+    /** Returns true if the Tool Settings are to be auto populated from the toolSettingsProperties.
+     * The setter is chiefly for testing.
+     */
+    useDefaultToolSettingsProvider: boolean;
+    /** The name of the active tool. This is typically the flyover text specified for the tool. */
+    activeToolLabel: string;
+    /** Returns the description of the active tool. */
+    readonly activeToolDescription: string;
+    /** Get ToolSettings Properties sync event. */
+    readonly onSyncToolSettingsProperties: SyncToolSettingsPropertiesEvent;
+    readonly onReloadToolSettingsProperties: UiEvent<void>;
+    /** Gets the Id of the active tool. If a tool is not active, blank is returned.
+     * @return  Id of the active tool, or blank if one is not active.
+     */
+    readonly toolIdForToolSettings: string;
+    /**
+     * Sets the focus on the ToolSettings UI element.
+     */
+    focusIntoToolSettings(): boolean;
+}
+//# sourceMappingURL=FrameworkToolSettings.d.ts.map

package/lib/cjs/appui-react/framework/FrameworkToolSettings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FrameworkToolSettings.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkToolSettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAE,UAAU,EAAE,sBAAsB,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AACpF,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,sBAAsB,EAAE,CAAC;CAC1C;AAED;;GAEG;AACH,qBAAa,+BAAgC,SAAQ,OAAO,CAAC,mCAAmC,CAAC;CAAI;AAErG;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,6CAA6C;IAC7C,qBAAqB,IAAI,IAAI,CAAC;IAE9B,qCAAqC;IACrC,0BAA0B,CAAC,sBAAsB,EAAE,UAAU,EAAE,GAAG,SAAS,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAErJ;OACG;IACH,qBAAqB,CAAC,IAAI,EAAE,eAAe,GAAG,IAAI,CAAC;IAEnD,iGAAiG;IACjG,QAAQ,CAAC,sBAAsB,EAAE,UAAU,EAAE,CAAC;IAE9C;;OAEG;IACH,8BAA8B,EAAE,OAAO,CAAC;IAExC,8FAA8F;IAC9F,eAAe,EAAE,MAAM,CAAC;IAExB,kDAAkD;IAClD,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IAEvC,8CAA8C;IAC9C,QAAQ,CAAC,4BAA4B,EAAE,+BAA+B,CAAC;IACvE,QAAQ,CAAC,8BAA8B,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvD;;OAEG;IACH,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IAEvC;;OAEG;IACH,qBAAqB,IAAI,OAAO,CAAC;CAClC"}

package/lib/cjs/appui-react/{statusbar/StatusBarItemsManager.js → framework/FrameworkToolSettings.js}

@@ -1,19 +1,18 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SyncToolSettingsPropertiesEvent = void 0;
 /*---------------------------------------------------------------------------------------------
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
 /** @packageDocumentation
- * @module StatusBar
+ * @module ToolSettings
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StatusBarItemsManager = void 0;
 const appui_abstract_1 = require("@itwin/appui-abstract");
-/** StatusBar Items Manager class.
- * @beta
- * @deprecated in 1.x. Use [StatusBarItemsManager]($appui-abstract) instead
+/** Sync Tool Settings Properties Event class.
+ * @public
  */
-class StatusBarItemsManager extends appui_abstract_1.StatusBarItemsManager {
+class SyncToolSettingsPropertiesEvent extends appui_abstract_1.UiEvent {
 }
-exports.StatusBarItemsManager = StatusBarItemsManager;
-//# sourceMappingURL=StatusBarItemsManager.js.map
+exports.SyncToolSettingsPropertiesEvent = SyncToolSettingsPropertiesEvent;
+//# sourceMappingURL=FrameworkToolSettings.js.map

package/lib/cjs/appui-react/framework/FrameworkToolSettings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FrameworkToolSettings.js","sourceRoot":"","sources":["../../../../src/appui-react/framework/FrameworkToolSettings.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,0DAAoF;AAWpF;;GAEG;AACH,MAAa,+BAAgC,SAAQ,wBAA4C;CAAI;AAArG,0EAAqG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module ToolSettings\r\n */\r\nimport { DialogItem, DialogPropertySyncItem, UiEvent } from \"@itwin/appui-abstract\";\r\nimport { InteractiveTool } from \"@itwin/core-frontend\";\r\n\r\n/** Sync Tool Settings Properties Event Args interface.\r\n * @public\r\n */\r\nexport interface SyncToolSettingsPropertiesEventArgs {\r\n  toolId: string;\r\n  syncProperties: DialogPropertySyncItem[];\r\n}\r\n\r\n/** Sync Tool Settings Properties Event class.\r\n * @public\r\n */\r\nexport class SyncToolSettingsPropertiesEvent extends UiEvent<SyncToolSettingsPropertiesEventArgs> { }\r\n\r\n/**\r\n * [[UiFramework.toolSettings]] interface\r\n * @beta\r\n */\r\nexport interface FrameworkToolSettings {\r\n  /** clear cached Tool Settings properties. */\r\n  clearToolSettingsData(): void;\r\n\r\n  /** Cache Tool Settings properties */\r\n  initializeToolSettingsData(toolSettingsProperties: DialogItem[] | undefined, toolId?: string, toolLabel?: string, toolDescription?: string): boolean;\r\n\r\n  /** Set of data used in Tool Settings for the specified tool. The tool specified should be the \"active\" tool.\r\n   */\r\n  initializeDataForTool(tool: InteractiveTool): void;\r\n\r\n  /** Returns the toolSettings properties that can be used to populate the tool settings widget. */\r\n  readonly toolSettingsProperties: DialogItem[];\r\n\r\n  /** Returns true if the Tool Settings are to be auto populated from the toolSettingsProperties.\r\n   * The setter is chiefly for testing.\r\n   */\r\n  useDefaultToolSettingsProvider: boolean;\r\n\r\n  /** The name of the active tool. This is typically the flyover text specified for the tool. */\r\n  activeToolLabel: string;\r\n\r\n  /** Returns the description of the active tool. */\r\n  readonly activeToolDescription: string;\r\n\r\n  /** Get ToolSettings Properties sync event. */\r\n  readonly onSyncToolSettingsProperties: SyncToolSettingsPropertiesEvent;\r\n  readonly onReloadToolSettingsProperties: UiEvent<void>;\r\n\r\n  /** Gets the Id of the active tool. If a tool is not active, blank is returned.\r\n   * @return  Id of the active tool, or blank if one is not active.\r\n   */\r\n  readonly toolIdForToolSettings: string;\r\n\r\n  /**\r\n   * Sets the focus on the ToolSettings UI element.\r\n   */\r\n  focusIntoToolSettings(): boolean;\r\n}\r\n"]}