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
  • omni.kit.menu.utils.extension_window_helper Classes
  • MenuItemDescription

MenuItemDescription#

class omni.kit.menu.utils.extension_window_helper.MenuItemDescription(
name: str = '',
glyph: str = '',
header: str | None = None,
appear_after: list | str = '',
enabled: bool = True,
ticked: bool = False,
ticked_value: bool | None = None,
radio_group: str | None = '',
sub_menu=None,
hotkey: Tuple[int, int] = None,
name_fn: Callable = None,
show_fn: Callable = None,
enable_fn: Callable = None,
ticked_fn: Callable = None,
onclick_action: Tuple = None,
unclick_action: Tuple = None,
onclick_fn: Callable = None,
unclick_fn: Callable = None,
onclick_right_fn: Callable = None,
original_svg_color: bool = False,
original_menu_item=None,
user=None,
hotkey_window: str | None = None,
)#

Bases: object

Class for creation of menu items

  • “name” is name shown on menu. (if name is “” then a menu spacer is added. Can be combined with show_fn)

  • “glyph” is icon shown on menu, full paths are allowed

  • “header” is None or string value & will add separator above item

  • “appear_after” is name of menu item to insert after. Used for appending menus, can be a list or string

  • “enabled” is True/False, True when item enabled

  • “ticked” menu item is ticked when True

  • “ticked_fn” function or list of functions used to decide if menu item is ticked

  • “ticked_value” is value used to decide if menu item is ticked

  • “radio_group” is name of group of ticked-radio buttons, setting one in group will clear the others

  • “sub_menu” is sub menu to this menu

  • “hotkey” is hotkey values for menu item

  • “name_fn” is function to get menu name

  • “show_fn” function or list of functions used to decide if menu item is shown. All functions must return True to show

  • “enable_fn” function or list of functions used to decide if menu item is enabled. All functions must return True to be enabled

  • “onclick_action” action called when user clicks menu item

  • “unclick_action” action called when user release’s button on menu item

  • “onclick_fn” function called when user clicks menu item (deprecated)

  • “unclick_fn” function called when user releases click on menu item (deprecated)

  • “onclick_right_fn” function called when user right clicks menu item (deprecated)

  • “original_svg_color” isn’t used (deprecated)

  • “user” is user dictionary that is passed to menu. NOTE: values will be added to this dictionary

  • hotkey_window is title of window where hotkey to be triggered

Methods

__init__([name, glyph, header, ...])

add_on_delete_func(on_delete_fn)

add_on_hotkey_update_func(hotkey_update_fn)

destroy([recurse])

get(key[, default_value])

get_action_mapping_desc()

has_action()

json_enc()

remove_on_delete_func(on_delete_fn)

remove_on_hotkey_update_func(hotkey_update_fn)

set_hotkey(hotkey)

Attributes

MAX_DEPTH

__init__(
name: str = '',
glyph: str = '',
header: str | None = None,
appear_after: list | str = '',
enabled: bool = True,
ticked: bool = False,
ticked_value: bool | None = None,
radio_group: str | None = '',
sub_menu=None,
hotkey: Tuple[int, int] = None,
name_fn: Callable = None,
show_fn: Callable = None,
enable_fn: Callable = None,
ticked_fn: Callable = None,
onclick_action: Tuple = None,
unclick_action: Tuple = None,
onclick_fn: Callable = None,
unclick_fn: Callable = None,
onclick_right_fn: Callable = None,
original_svg_color: bool = False,
original_menu_item=None,
user=None,
hotkey_window: str | None = None,
)#

previous

MenuHelperExtension

next

omni.kit.menu.utils.extension_window_helper_full

On this page
  • MenuItemDescription
    • __init__()
NVIDIA NVIDIA

Copyright © 2019-2025, NVIDIA Corporation.

Last updated on Jun 30, 2025.