Returns where in a cell layout this gadget resides.
Returns how many cells this gadget spans vertically
1 unless specified
Returns how many cells this gadget spans
1x1 unless specified
Returns how many cells wide this gadget spans
1 unless specified
Clears callback script from uiScriptGadget Template
Returns the horizontal margins around the child gadget area in a container, in UI units.
Returns the gadget stretchiness value horizontally. 0 being none and 1 being normal.
Returns the fixed height for the gadget, in UI units
Any vertical stretch is ignored, though the gadget can still stretch horizontally.
Return the icon name if in use.
Returns the position the child box within the container, when the children in a container cannot grow to fill the entire area of the container.
Returns keyvalue. value is changed whenever a key is pressed and contains the key value.
Return label diplayed as a string
Return the width of label displayed
Returns the look of the gadget
Returns the margins around the child gadget area in a container, in UI units.
Returns the maximum height of a gadget, in UI units.
Returns maximum size of a gadget, in UI units.
Returns the maximum width of a gadget, in UI units.
Return string tuple of menu items
Return enumeration of menu type
If menu button uses string value or not . Note. By default index values are return as int
Returns the minimum height of the gadget, in UI units. The gadget will never shrink to smaller than this size.
Returns the minimum size of the gadget, in UI units. The gadget will never shrink to smaller than this size.
Returns the minimum width of the gadget, in UI units. The gadget will never shrink to smaller than this size.
Return the naming scheme used
Used only when more than 1 component
Return the number of values stored
Returns the preferred height of the gadget, in UI units. The preferred height is the height the gadget would like to be laid out at, if space is available.
Returns the preferred size of the gadget, in UI units. The preferred size is the size the gadget would like to be laid out at, if space is available.
Returns the preferred width of the gadget, in UI units. The preferred width is the width the gadget would like to be laid out at, if space is available.
Return script as a string that runs on gadget changes.
Note Currently only python callbacks are supported.
Specify where in a cell layout this gadget resides.
Specify how many cells this gadget spans vertically
1 unless specified
Specify how many cells this gadget spans
1x1 unless specified
Specify how many cells wide this gadget spans
1 unless specified
Sets the horizontal margins around the child gadget area in a container, in UI units.
Makes the gadget stretchable horizontally. Specify floating point values for the amount of stretchiness: 0 being none and 1 being normal.
Useful for fields and sliders.
Specify a fixed height for the gadget, in UI units.
Any vertical stretch is ignored, though the gadget can still stretch horizontally.
Set the name icon file to use.
Specify where to position the child box within the container, when the children in a container cannot grow to fill the entire area of the container.
Normally set on windows, changed whenever a key is pressed and contains the key value.
Set string for label diplayed
Set the width of label displayed
Specifies the look of the gadget, though this is mostly used for container feels and windows
Sets the margins around the child gadget area in a container, in UI units.
Set the maximum height of a gadget, in UI units.
Generally used in conjunction with STRETCH, to prevent a gadget from getting undesirably large. The max height must be larger than both the minimum and preferred height, if specified.
Set the maximum size of a gadget, in UI units.
Generally used in conjunction with STRETCH, to prevent a gadget from getting undesirably large. The max size must be larger than both the minimum and preferred size, if specified.
Set the maximum width of a gadget, in UI units.
Generally used in conjunction with STRETCH, to prevent a gadget from getting undesirably large. The max width must be larger than both the minimum and preferred width, if specified.
Set string tuple of menu items
Set to an enumeration of menu type
If menu button uses string value or not . Note. By default index values are return as int
Set the minimum height of the gadget, in UI units. The gadget will never shrink to smaller than this size.
Set the minimum size of the gadget, in UI units. The gadget will never shrink to smaller than this size.
Set the minimum width of the gadget, in UI units. The gadget will never shrink to smaller than this size.
Specify the naming scheme used
No effect when only 1 component
Specify the number of values stored
Set the preferred height of the gadget, in UI units. The preferred height is the height the gadget would like to be laid out at, if space is available.
If a min and preferred height are specified, but no stretch is set, the height will still float between the min and preferred height. The preferred height must be between the min and max heights, if specified.
Set the preferred size of the gadget, in UI units. The preferred size is the size the gadget would like to be laid out at, if space is available.
If a min and preferred size are specified for the same dimension, but no stretch is set, the size will still float between the min and preferred size. The preferred size must be between the min and max sizes, if specified.
Set the preferred width of the gadget, in UI units. The preferred width is the width the gadget would like to be laid out at, if space is available.
If a min and preferred width are specified, but no stretch is set, the width will still float between the min and preferred width. The preferred width must be between the min and max width, if specified.
Set the callback script to provided string. This script will run in response to gadget changes.
Note Currently only python callbacks are supported. hscript can be used via hou.hscript()
Specify a fixed size for the gadget, in UI units Pixels can also be used by suffixing the value with 'p' (ie, 20p).
One UI unit is about 90p. Fixed sized gadgets ignore any stretch attributes applied to them.
Makes the gadget stretchable in both directions. Specify floating point values for the amount of stretchiness: 0 being none and 1 being normal.
All stretchiness values are relative to one another within the same container. A gadget with stretchiness of 2 would stretch twice as much as one of stretchiness 1; the same would occur if they were assigned as 1 and 0.5.
Sets the vertical margins around the child gadget area in a container, in UI units.
Makes the gadget stretchable vertically. Specify floating point values for the amount of stretchiness: 0 being none and 1 being normal.
Specify a fixed width for the gadget, in UI units.
Any horizontal stretch is ignored, though the gadget can still stretch verically.
Returns the fixed size for the gadget, in UI units Values suffixed with 'p' (ie, 20p) are specified in pixels.
One UI unit is about 90p. Fixed sized gadgets ignore any stretch attributes applied to them.
Returns the gadget stretchiness values in both directions. 0 being none and 1 being normal.
Returns the vertical margins around the child gadget area in a container, in UI units.
Returns the gadget stretchiness value vertically. 0 being none and 1 being normal.
Returns the fixed width for the gadget, in UI units
Any horizontal stretch is ignored, though the gadget can still stretch verically.
Documentation generated by
pdoc
0.2.3.
pdoc is in the public domain with the
UNLICENSE.