Skip to main content
Ctrl+K
Omniverse Kit - Home Omniverse Kit - Home

Omniverse Kit

  • twitter
  • youtube
  • instagram
  • www
  • linkedin
  • twitch
Omniverse Kit - Home Omniverse Kit - Home

Omniverse Kit

  • twitter
  • youtube
  • instagram
  • www
  • linkedin
  • twitch

Table of Contents

omni.kit.menu.utils

  • Overview
  • Update menus
  • Layouts & Hooks
  • Menu Helpers
  • Examples
  • API (python)
    • Modules
      • omni.kit.menu.utils
        • Submodules
          • actions
            • Classes
              • ActionMenuSubscription
            • Functions
              • add_action_to_menu
          • app_menu
            • Classes
              • AppMenu
              • IconMenuDelegate
              • MenuActionControl
              • MenuItemOrder
              • MenuState
          • builder_utils
            • Classes
              • LayoutSourceSearch
              • MenuAlignment
              • MenuItemDescription
              • PrebuiltItemOrder
            • Functions
              • create_prebuild_entry
              • get_action_path
              • get_menu_name
              • has_delegate_func
          • debug_window
            • Classes
              • MenuUtilsDebugExtension
          • extension_window_helper
            • Classes
              • MenuHelperExtension
              • MenuItemDescription
          • extension_window_helper_full
            • Classes
              • MenuHelperExtensionFull
              • MenuHelperWindow
              • MenuItemDescription
          • layout
            • Classes
              • LayoutSourceSearch
              • MenuItemDescription
              • MenuLayout
              • PrebuiltItemOrder
            • Functions
              • create_prebuild_entry
              • get_action_path
          • utils
            • Classes
              • ActionMenuSubscription
              • IconMenuDelegate
              • LayoutSourceSearch
              • MenuActionControl
              • MenuAlignment
              • MenuHelperExtension
              • MenuHelperExtensionFull
              • MenuHelperWindow
              • MenuItemDescription
              • MenuItemOrder
              • MenuLayout
              • MenuState
              • MenuUtilsExtension
              • PrebuiltItemOrder
            • Functions
              • add_action_to_menu
              • add_hook
              • add_layout
              • add_menu_items
              • build_submenu_dict
              • get_action_path
              • get_debug_stats
              • get_instance
              • get_menu_layout
              • get_merged_menus
              • rebuild_menus
              • refresh_menu_items
              • remove_hook
              • remove_layout
              • remove_menu_items
              • replace_menu_items
              • set_default_menu_priority
        • Classes
          • ActionMenuSubscription
          • AppMenu
          • IconMenuDelegate
          • LayoutSourceSearch
          • MenuActionControl
          • MenuAlignment
          • MenuHelperExtension
          • MenuHelperExtensionFull
          • MenuHelperWindow
          • MenuItemDescription
          • MenuItemOrder
          • MenuLayout
          • MenuState
          • MenuUtilsDebugExtension
          • MenuUtilsExtension
          • PrebuiltItemOrder
        • Functions
          • add_action_to_menu
          • add_hook
          • add_layout
          • add_menu_items
          • build_submenu_dict
          • get_action_path
          • get_debug_stats
          • get_instance
          • get_menu_layout
          • get_merged_menus
          • rebuild_menus
          • refresh_menu_items
          • remove_hook
          • remove_layout
          • remove_menu_items
          • replace_menu_items
          • set_default_menu_priority
  • Changelog
  • API (python)
  • Modules
  • omni.kit.menu.utils
  • omni.kit.menu.utils Submodules
  • omni.kit.menu.utils.extension_window_helper_full
  • omni.kit.menu.utils.extension_window_helper_full Classes
  • MenuHelperWindow

MenuHelperWindow#

class omni.kit.menu.utils.extension_window_helper_full.MenuHelperWindow(*args, **kwargs)#

Bases: Window

Methods

__init__(self, title, dockPreference, **kwargs)

Construct the window, add it to the underlying windowing system, and makes it appear.

destroy(self)

Removes all the callbacks and circular references.

set_visibility_changed_listener(listener)

Attributes

__init__(
self: omni.ui._ui.Window,
title: str,
dockPreference: omni.ui._ui.DockPreference = <DockPreference.DISABLED: 0>,
**kwargs,
) → None#

Construct the window, add it to the underlying windowing system, and makes it appear.

### Arguments:

`title :`

The window title. It’s also used as an internal window ID.

`dockPrefence :`

In the old Kit determines where the window should be docked. In Kit Next it’s unused.

`kwargsdict`

See below

### Keyword Arguments:

`flags`

This property set the Flags for the Window.

`visible`

This property holds whether the window is visible.

`title`

This property holds the window’s title.

`padding_x`

This property set the padding to the frame on the X axis.

`padding_y`

This property set the padding to the frame on the Y axis.

`width`

This property holds the window Width.

`height`

This property holds the window Height.

`position_x`

This property set/get the position of the window in the X Axis. The default is kWindowFloatInvalid because we send the window position to the underlying system only if the position is explicitly set by the user. Otherwise the underlying system decides the position.

`position_y`

This property set/get the position of the window in the Y Axis. The default is kWindowFloatInvalid because we send the window position to the underlying system only if the position is explicitly set by the user. Otherwise the underlying system decides the position.

`auto_resize`

setup the window to resize automatically based on its content

`noTabBar`

setup the visibility of the TabBar Handle, this is the small triangle at the corner of the view If it is not shown then it is not possible to undock that window and it need to be closed/moved programatically

`tabBarTooltip`

This property sets the tooltip when hovering over window’s tabbar.

`raster_policy`

Determine how the content of the window should be rastered.

`width_changed_fn`

This property holds the window Width.

`height_changed_fn`

This property holds the window Height.

`visibility_changed_fn`

This property holds whether the window is visible.

destroy(self: omni.ui._ui.Window) → None#

Removes all the callbacks and circular references.

previous

MenuHelperExtensionFull

next

MenuItemDescription

On this page
  • MenuHelperWindow
    • __init__()
    • destroy()
NVIDIA NVIDIA

Copyright © 2019-2025, NVIDIA Corporation.

Last updated on Jun 30, 2025.