hou.MenuParmTemplate class

Describes a menu parameter.

All Methods Replaces

Inheritence: hou.ParmTemplate >

Methods

Methods inherited from hou.ParmTemplate: numComponents, hide, help, name, look, dataType, setName, defaultValue, mayContainExpressions, setJoinWithNext, joinWithNext, setHelp, asCode, type, setTags, setDisableWhen, label, isHidden, namingScheme, tags, disableWhen

__init__(self, name, label, menu_items, menu_labels=(), default_value=0, icon_names=(), item_generator_script='', disable_when=None, is_hidden=False, join_with_next=False, help=None, tags={})

Not documented yet

defaultValue(self) → int

Returns the index of the default menu item.

defaultValueAsString(self) → str

Returns the internal name of the default menu item.This is equivalent to…

self.menuItems()[self.defaultValue()]
iconNames(self) → tuple of str

Returns the list of icons corresponding to the menu items. If there are no icons, returns a tuple of empty strings.

itemGeneratorScript(self) → str

Returns the script used to generate menu items, or an empty string if there is no such script.

Returns the list of internal menu names.

These internal menu names are not displayed in the UI, but they can be passed to hou.Parm.set and will be returned by hou.Parm.evalAsString for menu parameters.

Returns the list of menu labels displayed in the UI.

Replaces

opmenu command