@itwin/core-react/lib/core-react/settings/SettingsManager.d.ts

A react component library of iTwin.js UI general purpose components

/** @packageDocumentation
 * @module Settings
 */
import { BeUiEvent } from "@itwin/core-bentley";
import type { ConditionalBooleanValue } from "@itwin/appui-abstract";
/** Interface used to populate a tab entry in the SettingContainer control
 * @public
 * @deprecated in 4.16.0. Use {@link @itwin/appui-react#SettingsTabEntry} instead.
 */
export interface SettingsTabEntry {
    /** unique id for entry */
    readonly tabId: string;
    /** localized display label */
    readonly label: string;
    /** Setting page content to display when tab item is selected. */
    readonly page: React.ReactElement;
    /** Setting to true if page will register to watch for stage closing event so it can save any dirty settings. Page component should register and handle the events:
     * `settingsManager.onProcessSettingsTabActivation` and `settingsManager.onProcessSettingsContainerClose` */
    readonly pageWillHandleCloseRequest?: boolean;
    /** used to determine position in tablist */
    readonly itemPriority: number;
    /** Optional Subtitle to show below label. */
    readonly subLabel?: string;
    /** Icon specification */
    readonly icon?: string | React.ReactElement;
    /** Tooltip. Allows JSX|Element to support react-tooltip component */
    readonly tooltip?: string | React.ReactElement;
    /** Allows Settings entry to be disabled */
    readonly isDisabled?: boolean | ConditionalBooleanValue;
}
/** Event class for [[this.onSettingsProvidersChanged]] which is emitted when a new SettingsTabsProvider is added or removed.
 * @public
 * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
 */
export declare class SettingsProvidersChangedEvent extends BeUiEvent<SettingsProvidersChangedEventArgs> {
}
/** Arguments of [[this.onSettingsProvidersChanged]] event.
 * @public
 * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.
 */
export interface SettingsProvidersChangedEventArgs {
    readonly providers: ReadonlyArray<SettingsTabsProvider>;
}
/** Event class for [[this.onProcessSettingsTabActivation]] which is emitted when a new Tab needs to be activated. This allows the current
 * settings page to save its settings before activating the new SettingTab.
 * @public
 * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
 */
export declare class ProcessSettingsTabActivationEvent extends BeUiEvent<ProcessSettingsTabActivationEventArgs> {
}
/** Arguments of [[this.onProcessSettingsTabActivation]] event.
 * @public
 * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.
 */
export interface ProcessSettingsTabActivationEventArgs {
    readonly tabSelectionFunc: (tabId: string) => void;
    readonly requestedSettingsTabId: string;
}
/** Event class for [[this.onProcessSettingsContainerClose]] which is emitted when the settings container will be closed. This allows the current
 * settings page to save its settings before calling the function to close the container.
 * @public
 * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
 */
export declare class ProcessSettingsContainerCloseEvent extends BeUiEvent<ProcessSettingsContainerCloseEventArgs> {
}
/** Arguments of [[this.onProcessSettingsContainerClose]] event.
 * @public
 * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.
 */
export interface ProcessSettingsContainerCloseEventArgs {
    readonly closeFunc: (args: any) => void;
    readonly closeFuncArgs?: any;
}
/** Event class for [[this.onActivateSettingsTab]] which is emitted when API call needs to set the active settings tab (ie via Tool key-in).
 * @public
 * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
 */
export declare class ActivateSettingsTabEvent extends BeUiEvent<ActivateSettingsTabEventArgs> {
}
/** Arguments of [[this.onActivateSettingsTab]] event.
 * @public
 * @deprecated in 4.13.0. Event args are inferred from a listener. If explicit type is needed use a type helper.
 */
export interface ActivateSettingsTabEventArgs {
    readonly settingsTabId: string;
}
/** Setting Provider interface. Implemented by classes that want to supply settings pages for display in the SettingContainer. The
 * classes that implement this interface need to be registered with the [[SettingsManager]].
 * @public
 * @deprecated in 4.16.0. Use {@link @itwin/appui-react#SettingsTabsProvider} instead.
 */
export interface SettingsTabsProvider {
    /** Id of provider, used to remove registration. */
    readonly id: string;
    getSettingEntries(stageId: string, stageUsage: string): ReadonlyArray<SettingsTabEntry> | undefined;
}
/** Settings Manager class. Hold registration of settings providers and supplies events for the provided settings pages to listen.
 * @public
 * @deprecated in 4.16.0. Use {@link @itwin/appui-react#SettingsManager} instead.
 */
export declare class SettingsManager {
    private _providers;
    /** Event raised when SettingsProviders are changed.
     */
    readonly onSettingsProvidersChanged: SettingsProvidersChangedEvent;
    /** Event raised solely for a settings page to monitor so it can save its settings before continuing tab activation.
     * See React hook function `useSaveBeforeActivatingNewSettingsTab`.
     */
    readonly onProcessSettingsTabActivation: ProcessSettingsTabActivationEvent;
    /** Event raised when the settings container will be closed. Any setting page component that is 'modal' should register to
     * listen to this event so that it can save its state before closing. See React hook function `useSaveBeforeClosingSettingsContainer`.
     */
    readonly onProcessSettingsContainerClose: ProcessSettingsContainerCloseEvent;
    /** Event raised to change the active settings tab shown in UI. Monitored by the SettingsContainer.
     * @internal
     */
    readonly onActivateSettingsTab: BeUiEvent<ActivateSettingsTabEventArgs>;
    /** Event monitored by SettingsContainer to process request to close the settings container.
     * @internal
     */
    readonly onCloseSettingsContainer: BeUiEvent<ProcessSettingsContainerCloseEventArgs>;
    get providers(): ReadonlyArray<SettingsTabsProvider>;
    set providers(p: ReadonlyArray<SettingsTabsProvider>);
    /** Called by application when an tool, keyin, or other process want to change the active settings tab/page giving the current tab/page and opportunity
     * to save its state.
     */
    activateSettingsTab(settingsTabId: string): void;
    /** Called by application when the Settings Container is to be closed. The function to invoke to actually close the Settings Container is
     * passed in and executed once the active settings tab/page has a chance to save its settings.
     */
    closeSettingsContainer(closeFunc: (args: any) => void, closeFuncArgs?: any): void;
    addSettingsProvider(settingsProvider: SettingsTabsProvider): void;
    removeSettingsProvider(providerId: string): boolean;
    /** Get an array of SettingsTabEntry objects to populate the settings container. */
    getSettingEntries(stageId: string, stageUsage: string): Array<SettingsTabEntry>;
}
//# sourceMappingURL=SettingsManager.d.ts.map