@itwin/appui-react 4.0.0-dev.12 → 4.0.0-dev.13

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

@@ -1,53 +1,53 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-import { UiEvent } from "@itwin/appui-abstract";
-/** Frontstage Activated Event class.
- * @public
- */
-export class FrontstageActivatedEvent extends UiEvent {
-}
-/** Frontstage Deactivated Event class.
- * @public
- */
-export class FrontstageDeactivatedEvent extends UiEvent {
-}
-/** Frontstage Ready Event class.
- * @public
- */
-export class FrontstageReadyEvent extends UiEvent {
-}
-/** Modal Frontstage Stack Changed Event class.
- * @public
- */
-export class ModalFrontstageChangedEvent extends UiEvent {
-}
-/** 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 class ModalFrontstageRequestedCloseEvent extends UiEvent {
-}
-/** Modal Frontstage Closed Event class.
- * @public
- */
-export class ModalFrontstageClosedEvent extends UiEvent {
-}
-/** Tool Activated Event class.
- * @public
- */
-export class ToolActivatedEvent extends UiEvent {
-}
-/** Tool Icon Changed Event class.
- * @public
- */
-export class ToolIconChangedEvent extends UiEvent {
-}
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { UiEvent } from "@itwin/appui-abstract";
+/** Frontstage Activated Event class.
+ * @public
+ */
+export class FrontstageActivatedEvent extends UiEvent {
+}
+/** Frontstage Deactivated Event class.
+ * @public
+ */
+export class FrontstageDeactivatedEvent extends UiEvent {
+}
+/** Frontstage Ready Event class.
+ * @public
+ */
+export class FrontstageReadyEvent extends UiEvent {
+}
+/** Modal Frontstage Stack Changed Event class.
+ * @public
+ */
+export class ModalFrontstageChangedEvent extends UiEvent {
+}
+/** 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 class ModalFrontstageRequestedCloseEvent extends UiEvent {
+}
+/** Modal Frontstage Closed Event class.
+ * @public
+ */
+export class ModalFrontstageClosedEvent extends UiEvent {
+}
+/** Tool Activated Event class.
+ * @public
+ */
+export class ToolActivatedEvent extends UiEvent {
+}
+/** Tool Icon Changed Event class.
+ * @public
+ */
+export class ToolIconChangedEvent extends UiEvent {
+}
 //# sourceMappingURL=FrameworkFrontstages.js.map

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

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

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

@@ -1,100 +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;
-}
+/** @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/esm/appui-react/framework/FrameworkKeyboardShortcuts.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=FrameworkKeyboardShortcuts.js.map

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

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

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

@@ -1,52 +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;
-}
+/** @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/esm/appui-react/framework/FrameworkToolSettings.js

@@ -1,14 +1,14 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module ToolSettings
- */
-import { UiEvent } from "@itwin/appui-abstract";
-/** Sync Tool Settings Properties Event class.
- * @public
- */
-export class SyncToolSettingsPropertiesEvent extends UiEvent {
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module ToolSettings
+ */
+import { UiEvent } from "@itwin/appui-abstract";
+/** Sync Tool Settings Properties Event class.
+ * @public
+ */
+export class SyncToolSettingsPropertiesEvent extends UiEvent {
+}
 //# sourceMappingURL=FrameworkToolSettings.js.map

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

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