omni.flux.job_queue.widget#

  • SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.

  • SPDX-License-Identifier: Apache-2.0

  • Licensed under the Apache License, Version 2.0 (the “License”);

  • you may not use this file except in compliance with the License.

  • You may obtain a copy of the License at

  • https://www.apache.org/licenses/LICENSE-2.0

  • Unless required by applicable law or agreed to in writing, software

  • distributed under the License is distributed on an “AS IS” BASIS,

  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  • See the License for the specific language governing permissions and

  • limitations under the License.

class omni.flux.job_queue.widget.FluxJobQueueWidgetExtension#

Owns process-wide job queue widget registries.

on_shutdown() → None#

Destroy the shared display-adapter registry.

on_startup(_ext_id: str) → None#

Create the shared display-adapter registry.

Parameters:

_ext_id – Kit extension identifier.

class omni.flux.job_queue.widget.QueueWidget(
interface: QueueInterface,
apply_executor: ApplyExecutor,
context_name: str,
)#

Own the event-driven hierarchical queue tree and generic controls.

destroy() → None#

Release event ownership and native tree resources.

property destroyed: bool#

Whether the widget released its event ownership and native tree.

Returns:

True after destroy(), which tells an owning workspace window to rebuild its content.

show(visible: bool) → None#

Subscribe before synchronization while the owning workspace is visible.

Parameters:

visible – Whether queue events should currently drive this tree.

omni.flux.job_queue.widget.get_display_adapter_registry() → DisplayAdapterRegistry#

Return the shared display-adapter registry.

Returns:

The Display Adapter Registry instance.

Raises:

RuntimeError – If the extension has not started.