.. _omni_graph_ui_nodes_ComboBox_1:

.. _omni_graph_ui_nodes_ComboBox:

.. ================================================================================
.. THIS PAGE IS AUTO-GENERATED. DO NOT MANUALLY EDIT.
.. ================================================================================

:orphan:

.. meta::
    :title: Combo Box (BETA)
    :keywords: lang-en omnigraph node graph:action,ui ui_nodes combo-box


Combo Box (BETA)
================

.. <description>

Create a combo box widget on the Viewport

.. </description>


Installation
------------

To use this node enable :ref:`omni.graph.ui_nodes<ext_omni_graph_ui_nodes>` in the Extension Manager.


Inputs
------
.. csv-table::
    :header: "Name", "Type", "Descripton", "Default"
    :widths: 20, 20, 50, 10

    "Create (*inputs:create*)", "``execution``", "Input execution to create and show the widget", "None"
    "Disable (*inputs:disable*)", "``execution``", "Disable this button so that it cannot be pressed", "None"
    "Enable (*inputs:enable*)", "``execution``", "Enable this button after it has been disabled", "None"
    "Hide (*inputs:hide*)", "``execution``", "Input execution to hide the widget and all its child widgets", "None"
    "Item List (*inputs:itemList*)", "``token[]``", "A list of items that appears in the drop-down list", "[]"
    "Parent Widget Path (*inputs:parentWidgetPath*)", "``token``", "The absolute path to the parent widget. If empty, this widget will be created as a direct child of Viewport.", "None"
    "Show (*inputs:show*)", "``execution``", "Input execution to show the widget and all its child widgets after they become hidden", "None"
    "Tear Down (*inputs:tearDown*)", "``execution``", "Input execution to tear down the widget and all its child widgets", "None"
    "Widget Identifier (*inputs:widgetIdentifier*)", "``token``", "An optional unique identifier for the widget. Can be used to refer to this widget in other places such as the OnWidgetClicked node.", "None"
    "Width (*inputs:width*)", "``double``", "The width of the created combo box", "100.0"


Outputs
-------
.. csv-table::
    :header: "Name", "Type", "Descripton", "Default"
    :widths: 20, 20, 50, 10

    "Created (*outputs:created*)", "``execution``", "Executed when the widget is created", "None"
    "Widget Path (*outputs:widgetPath*)", "``token``", "The absolute path to the created widget", "None"


Metadata
--------
.. csv-table::
    :header: "Name", "Value"
    :widths: 30,70

    "Unique ID", "omni.graph.ui_nodes.ComboBox"
    "Version", "1"
    "Extension", "omni.graph.ui_nodes"
    "Has State?", "False"
    "Implementation Language", "Python"
    "Default Memory Type", "cpu"
    "Generated Code Exclusions", "tests"
    "hidden", "True"
    "uiName", "Combo Box (BETA)"
    "Categories", "graph:action,ui"
    "Generated Class Name", "OgnComboBoxDatabase"
    "Python Module", "omni.graph.ui_nodes"

